Package software.amazon.awscdk.services.pinpoint

Class CfnAPNSVoipSandboxChannel

java.lang.Object
software.amazon.jsii.JsiiObject
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.CfnAPNSVoipSandboxChannel
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.745Z") @Stability(Stable) public class CfnAPNSVoipSandboxChannel extends CfnResource implements IInspectable
A CloudFormation AWS::Pinpoint::APNSVoipSandboxChannel.

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAPNSVoipSandboxChannel

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

    • CfnAPNSVoipSandboxChannel

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

    • CfnAPNSVoipSandboxChannel

      @Stability(Stable) public CfnAPNSVoipSandboxChannel(@NotNull Construct scope, @NotNull String id, @NotNull CfnAPNSVoipSandboxChannelProps props)
      Create a new AWS::Pinpoint::APNSVoipSandboxChannel.

      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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier for the application that the APNs VoIP sandbox channel applies to.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the application that the APNs VoIP sandbox channel applies to.

    • getBundleId

      @Stability(Stable) @Nullable public String getBundleId()
      The bundle identifier that's assigned to your iOS app.

      This identifier is used for APNs tokens.

    • setBundleId

      @Stability(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(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 the APNs sandbox environment by using an APNs certificate.

    • setCertificate

      @Stability(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 the APNs sandbox environment by using an APNs certificate.

    • getDefaultAuthenticationMethod

      @Stability(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(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(Stable) @Nullable public Object getEnabled()
      Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    • getPrivateKey

      @Stability(Stable) @Nullable public String getPrivateKey()
      The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    • setPrivateKey

      @Stability(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 the APNs sandbox environment.

    • getTeamId

      @Stability(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(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(Stable) @Nullable public String getTokenKey()
      The authentication key to use for APNs tokens.

    • setTokenKey

      @Stability(Stable) public void setTokenKey(@Nullable String value)
      The authentication key to use for APNs tokens.

    • getTokenKeyId

      @Stability(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 the APNs sandbox environment by using APNs tokens.

    • setTokenKeyId

      @Stability(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 the APNs sandbox environment by using APNs tokens.