Package software.amazon.awscdk.services.pinpoint

Class CfnADMChannel

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.CfnADMChannel
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.306Z") @Stability(Stable) public class CfnADMChannel extends CfnResource implements IInspectable
A channel is a type of platform that you can deliver messages to.

You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application.

The ADMChannel resource represents the status and authentication settings for the ADM 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.*;
 CfnADMChannel cfnADMChannel = CfnADMChannel.Builder.create(this, "MyCfnADMChannel")
         .applicationId("applicationId")
         .clientId("clientId")
         .clientSecret("clientSecret")
         // the properties below are optional
         .enabled(false)
         .build();

See Also:

  • 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

    • CfnADMChannel

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

    • CfnADMChannel

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

    • CfnADMChannel

      @Stability(Stable) public CfnADMChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnADMChannelProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      (Deprecated) An identifier for the ADM channel.

      This property is retained only for backward compatibility.

    • 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 Amazon Pinpoint application that the ADM channel applies to.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.

    • getClientId

      @Stability(Stable) @NotNull public String getClientId()
      The Client ID that you received from Amazon to send messages by using ADM.

    • setClientId

      @Stability(Stable) public void setClientId(@NotNull String value)
      The Client ID that you received from Amazon to send messages by using ADM.

    • getClientSecret

      @Stability(Stable) @NotNull public String getClientSecret()
      The Client Secret that you received from Amazon to send messages by using ADM.

    • setClientSecret

      @Stability(Stable) public void setClientSecret(@NotNull String value)
      The Client Secret that you received from Amazon to send messages by using ADM.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      Specifies whether to enable the ADM channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether to enable the ADM channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether to enable the ADM channel for the application.