CfnSMSChannelProps

class aws_cdk.aws_pinpoint.CfnSMSChannelProps(*, application_id, enabled=None, sender_id=None, short_code=None)

Bases: object

Properties for defining a CfnSMSChannel.

Parameters
  • application_id (str) – The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether to enable the SMS channel for the application.

  • sender_id (Optional[str]) – The identity that you want to display on recipients’ devices when they receive messages from the SMS channel. .. epigraph:: SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide .

  • short_code (Optional[str]) – The registered short code that you want to use when you send messages through the SMS channel. .. epigraph:: For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

cfn_sMSChannel_props = pinpoint.CfnSMSChannelProps(
    application_id="applicationId",

    # the properties below are optional
    enabled=False,
    sender_id="senderId",
    short_code="shortCode"
)

Attributes

application_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid

Return type

str

enabled

Specifies whether to enable the SMS channel for the application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled

Return type

Union[bool, IResolvable, None]

sender_id

The identity that you want to display on recipients’ devices when they receive messages from the SMS channel.

SenderIDs are only supported in certain countries and regions. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid

Return type

Optional[str]

short_code

The registered short code that you want to use when you send messages through the SMS channel.

For information about obtaining a dedicated short code for sending SMS messages, see Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint in the Amazon Pinpoint User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode

Return type

Optional[str]