software.amazon.awscdk.services.pinpoint

Class CfnAPNSVoipChannel

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.pinpoint.CfnAPNSVoipChannel

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.146Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAPNSVoipChannel(Construct scope, java.lang.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
java.lang.String	getApplicationId() The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
java.lang.String	getBundleId() The bundle identifier that's assigned to your iOS app.
java.lang.String	getCertificate() The APNs client certificate that you received from Apple.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDefaultAuthenticationMethod() The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
java.lang.Object	getEnabled() Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
java.lang.String	getPrivateKey() The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
java.lang.String	getTeamId() The identifier that's assigned to your Apple Developer Account team.
java.lang.String	getTokenKey() The authentication key to use for APNs tokens.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApplicationId(java.lang.String value) The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
void	setBundleId(java.lang.String value) The bundle identifier that's assigned to your iOS app.
void	setCertificate(java.lang.String value) The APNs client certificate that you received from Apple.
void	setDefaultAuthenticationMethod(java.lang.String value) The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
void	setEnabled(java.lang.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(java.lang.String value) The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
void	setTeamId(java.lang.String value) The identifier that's assigned to your Apple Developer Account team.
void	setTokenKey(java.lang.String value) The authentication key to use for APNs tokens.
void	setTokenKeyId(java.lang.String value) The key identifier that's assigned to your APNs signing key.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnAPNSVoipChannel(Construct scope,
                          java.lang.String id,
                          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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

public java.lang.String getApplicationId()

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

setApplicationId

public void setApplicationId(java.lang.String value)

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

getBundleId

public java.lang.String getBundleId()

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

This identifier is used for APNs tokens.

setBundleId

public void setBundleId(java.lang.String value)

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

This identifier is used for APNs tokens.

getCertificate

public java.lang.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

public void setCertificate(java.lang.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

public java.lang.String getDefaultAuthenticationMethod()

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

Valid options are key or certificate .

setDefaultAuthenticationMethod

public void setDefaultAuthenticationMethod(java.lang.String value)

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

Valid options are key or certificate .

getEnabled

public java.lang.Object getEnabled()

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

setEnabled

public void setEnabled(java.lang.Boolean value)

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

setEnabled

public void setEnabled(IResolvable value)

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

getPrivateKey

public java.lang.String getPrivateKey()

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

setPrivateKey

public void setPrivateKey(java.lang.String value)

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

getTeamId

public java.lang.String getTeamId()

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

This identifier is used for APNs tokens.

setTeamId

public void setTeamId(java.lang.String value)

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

This identifier is used for APNs tokens.

getTokenKey

public java.lang.String getTokenKey()

The authentication key to use for APNs tokens.

setTokenKey

public void setTokenKey(java.lang.String value)

The authentication key to use for APNs tokens.

getTokenKeyId

public java.lang.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

public void setTokenKeyId(java.lang.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.