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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.178Z")
 @Stability(value=Stable)
public class CfnADMChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::ADMChannel`.

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

Nested Class Summary

Nested Classes

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

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
	CfnADMChannel(software.constructs.Construct scope, String id, CfnADMChannelProps props) Create a new `AWS::Pinpoint::ADMChannel`.
protected	CfnADMChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnADMChannel(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 ADM channel applies to.
protected Map<String,Object>	getCfnProperties()
String	getClientId() The Client ID that you received from Amazon to send messages by using ADM.
String	getClientSecret() The Client Secret that you received from Amazon to send messages by using ADM.
Object	getEnabled() Specifies whether to enable the ADM channel for the application.
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 ADM channel applies to.
void	setClientId(String value) The Client ID that you received from Amazon to send messages by using ADM.
void	setClientSecret(String value) The Client Secret that you received from Amazon to send messages by using ADM.
void	setEnabled(Boolean value) Specifies whether to enable the ADM channel for the application.
void	setEnabled(IResolvable value) Specifies whether to enable the ADM channel for the application.

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

CfnADMChannel

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

CfnADMChannel

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

CfnADMChannel

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

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

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 ADM channel applies to.

setApplicationId

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

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

getClientId

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

The Client ID that you received from Amazon to send messages by using ADM.

setClientId

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

The Client ID that you received from Amazon to send messages by using ADM.

getClientSecret

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

The Client Secret that you received from Amazon to send messages by using ADM.

setClientSecret

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

The Client Secret that you received from Amazon to send messages by using ADM.

getEnabled

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

Specifies whether to enable the ADM channel for the application.

setEnabled

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

Specifies whether to enable the ADM channel for the application.

setEnabled

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

Specifies whether to enable the ADM channel for the application.