software.amazon.awscdk.services.pinpoint

Class CfnAPNSVoipChannel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnAPNSVoipChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.182Z")
 @Stability(value=Stable)
public class CfnAPNSVoipChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::APNSVoipChannel`.

A channel is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application.

The APNSVoipChannel resource represents the status and authentication settings of the APNs VoIP channel for an application.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnAPNSVoipChannel cfnAPNSVoipChannel = CfnAPNSVoipChannel.Builder.create(this, "MyCfnAPNSVoipChannel")
         .applicationId("applicationId")
         // the properties below are optional
         .bundleId("bundleId")
         .certificate("certificate")
         .defaultAuthenticationMethod("defaultAuthenticationMethod")
         .enabled(false)
         .privateKey("privateKey")
         .teamId("teamId")
         .tokenKey("tokenKey")
         .tokenKeyId("tokenKeyId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAPNSVoipChannel.Builder A fluent builder for CfnAPNSVoipChannel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAPNSVoipChannel(software.constructs.Construct scope, String id, CfnAPNSVoipChannelProps props) Create a new `AWS::Pinpoint::APNSVoipChannel`.
protected	CfnAPNSVoipChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAPNSVoipChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
String	getBundleId() The bundle identifier that's assigned to your iOS app.
String	getCertificate() The APNs client certificate that you received from Apple.
protected Map<String,Object>	getCfnProperties()
String	getDefaultAuthenticationMethod() The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
Object	getEnabled() Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
String	getPrivateKey() The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
String	getTeamId() The identifier that's assigned to your Apple Developer Account team.
String	getTokenKey() The authentication key to use for APNs tokens.
String	getTokenKeyId() The key identifier that's assigned to your APNs signing key.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
void	setBundleId(String value) The bundle identifier that's assigned to your iOS app.
void	setCertificate(String value) The APNs client certificate that you received from Apple.
void	setDefaultAuthenticationMethod(String value) The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
void	setEnabled(Boolean value) Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
void	setEnabled(IResolvable value) Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
void	setPrivateKey(String value) The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
void	setTeamId(String value) The identifier that's assigned to your Apple Developer Account team.
void	setTokenKey(String value) The authentication key to use for APNs tokens.
void	setTokenKeyId(String value) The key identifier that's assigned to your APNs signing key.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAPNSVoipChannel

protected CfnAPNSVoipChannel(software.amazon.jsii.JsiiObjectRef objRef)

CfnAPNSVoipChannel

protected CfnAPNSVoipChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnAPNSVoipChannel

@Stability(value=Stable)
public CfnAPNSVoipChannel(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnAPNSVoipChannelProps props)

Create a new `AWS::Pinpoint::APNSVoipChannel`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.

getBundleId

@Stability(value=Stable)
 @Nullable
public String getBundleId()

The bundle identifier that's assigned to your iOS app.

This identifier is used for APNs tokens.

setBundleId

@Stability(value=Stable)
public void setBundleId(@Nullable
                                                 String value)

The bundle identifier that's assigned to your iOS app.

This identifier is used for APNs tokens.

getCertificate

@Stability(value=Stable)
 @Nullable
public String getCertificate()

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

setCertificate

@Stability(value=Stable)
public void setCertificate(@Nullable
                                                    String value)

The APNs client certificate that you received from Apple.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

getDefaultAuthenticationMethod

@Stability(value=Stable)
 @Nullable
public String getDefaultAuthenticationMethod()

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Valid options are key or certificate .

setDefaultAuthenticationMethod

@Stability(value=Stable)
public void setDefaultAuthenticationMethod(@Nullable
                                                                    String value)

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.

Valid options are key or certificate .

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.

getPrivateKey

@Stability(value=Stable)
 @Nullable
public String getPrivateKey()

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

setPrivateKey

@Stability(value=Stable)
public void setPrivateKey(@Nullable
                                                   String value)

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

getTeamId

@Stability(value=Stable)
 @Nullable
public String getTeamId()

The identifier that's assigned to your Apple Developer Account team.

This identifier is used for APNs tokens.

setTeamId

@Stability(value=Stable)
public void setTeamId(@Nullable
                                               String value)

The identifier that's assigned to your Apple Developer Account team.

This identifier is used for APNs tokens.

getTokenKey

@Stability(value=Stable)
 @Nullable
public String getTokenKey()

The authentication key to use for APNs tokens.

setTokenKey

@Stability(value=Stable)
public void setTokenKey(@Nullable
                                                 String value)

The authentication key to use for APNs tokens.

getTokenKeyId

@Stability(value=Stable)
 @Nullable
public String getTokenKeyId()

The key identifier that's assigned to your APNs signing key.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

setTokenKeyId

@Stability(value=Stable)
public void setTokenKeyId(@Nullable
                                                   String value)

The key identifier that's assigned to your APNs signing key.

Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.