AWS::SSMContacts::ContactChannel - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

AWS::SSMContacts::ContactChannel

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

Syntax

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

JSON

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

YAML

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

Properties

ChannelAddress

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

Required: Yes

Type: String

Update requires: No interruption

ChannelName

The name of the contact channel.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Pattern: ^[\p{L}\p{Z}\p{N}_.\-]*$

Update requires: No interruption

ChannelType

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

  • SMS

  • VOICE

  • EMAIL

Required: Yes

Type: String

Allowed values: EMAIL | SMS | VOICE

Update requires: Replacement

ContactId

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

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-]+)*

Update requires: Replacement

DeferActivation

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

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns 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 Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

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