AWS::SSMContacts::ContactChannel - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The AWS::SSMContacts::ContactChannel resource specifies a contact channel as the method that Incident Manager uses to engage your contact.


To declare this entity in your Amazon CloudFormation template, use the following syntax:


{ "Type" : "AWS::SSMContacts::ContactChannel", "Properties" : { "ChannelAddress" : String, "ChannelName" : String, "ChannelType" : String, "ContactId" : String, "DeferActivation" : Boolean } }


Type: AWS::SSMContacts::ContactChannel Properties: ChannelAddress: String ChannelName: String ChannelType: String ContactId: String DeferActivation: Boolean



The details that Incident Manager uses when trying to engage the contact channel.

Required: No

Type: String

Update requires: No interruption


The name of the contact channel.

Required: No

Type: String

Pattern: [a-zA-Z 0-9_\-+'&\uD83C-\uDBFF\uDC00-\uDFFF\u2000-\u3300]+

Minimum: 1

Maximum: 255

Update requires: No interruption


The type of the contact channel. Incident Manager supports three contact methods:

  • SMS



Required: No

Type: String

Allowed values: SMS | VOICE | EMAIL

Update requires: Replacement


The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

Required: No

Type: String

Pattern: arn:[-\w+=\/,.@]+:[-\w+=\/,.@]+:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-]+)*

Minimum: 1

Maximum: 2048

Update requires: Replacement


If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

Required: No

Type: Boolean

Update requires: No interruption

Return values


When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the resource, such as arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/contactalias/cec1bb12-34f5-6789-a1ee-e1ca2345d6f7.

For more information about using the Ref function, see Ref.


The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.


The Amazon Resource Name (ARN) of the ContactChannel resource.