@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.148Z") public class CfnAPNSVoipSandboxChannel extends CfnResource implements IInspectable
A channel is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application.
The APNSVoipSandboxChannel resource represents the status and authentication settings of the APNs VoIP sandbox 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.*; CfnAPNSVoipSandboxChannel cfnAPNSVoipSandboxChannel = CfnAPNSVoipSandboxChannel.Builder.create(this, "MyCfnAPNSVoipSandboxChannel") .applicationId("applicationId") // the properties below are optional .bundleId("bundleId") .certificate("certificate") .defaultAuthenticationMethod("defaultAuthenticationMethod") .enabled(false) .privateKey("privateKey") .teamId("teamId") .tokenKey("tokenKey") .tokenKeyId("tokenKeyId") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnAPNSVoipSandboxChannel.Builder
A fluent builder for
CfnAPNSVoipSandboxChannel . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnAPNSVoipSandboxChannel(Construct scope,
java.lang.String id,
CfnAPNSVoipSandboxChannelProps props)
Create a new `AWS::Pinpoint::APNSVoipSandboxChannel`.
|
protected |
CfnAPNSVoipSandboxChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnAPNSVoipSandboxChannel(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationId()
The unique identifier for the application that the APNs VoIP sandbox 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 the APNs VoIP sandbox channel is enabled for the application.
|
java.lang.String |
getPrivateKey()
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
|
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 application that the APNs VoIP sandbox 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 the APNs VoIP sandbox channel is enabled for the application.
|
void |
setEnabled(IResolvable value)
Specifies whether the APNs VoIP sandbox channel is enabled for the 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 the APNs sandbox environment.
|
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnAPNSVoipSandboxChannel(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnAPNSVoipSandboxChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnAPNSVoipSandboxChannel(Construct scope, java.lang.String id, CfnAPNSVoipSandboxChannelProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApplicationId()
public void setApplicationId(java.lang.String value)
public java.lang.String getBundleId()
This identifier is used for APNs tokens.
public void setBundleId(java.lang.String value)
This identifier is used for APNs tokens.
public java.lang.String getCertificate()
Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
public void setCertificate(java.lang.String value)
Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
public java.lang.String getDefaultAuthenticationMethod()
Valid options are key
or certificate
.
public void setDefaultAuthenticationMethod(java.lang.String value)
Valid options are key
or certificate
.
public java.lang.Object getEnabled()
public void setEnabled(java.lang.Boolean value)
public void setEnabled(IResolvable value)
public java.lang.String getPrivateKey()
public void setPrivateKey(java.lang.String value)
public java.lang.String getTeamId()
This identifier is used for APNs tokens.
public void setTeamId(java.lang.String value)
This identifier is used for APNs tokens.
public java.lang.String getTokenKey()
public void setTokenKey(java.lang.String value)
public java.lang.String getTokenKeyId()
Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
public void setTokenKeyId(java.lang.String value)
Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.