AWS::SSMContacts::Contact - 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::Contact

The AWS::SSMContacts::Contact resource specifies a contact or escalation plan. Incident Manager contacts are a subset of actions and data types that you can use for managing responder engagement and interaction.

Syntax

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

JSON

{
  "Type" : "AWS::SSMContacts::Contact",
  "Properties" : {
      "Alias" : String,
      "DisplayName" : String,
      "Plan" : [ Stage, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::SSMContacts::Contact
Properties: 
  Alias: String
  DisplayName: String
  Plan: 
    - Stage
  Type: String

Properties

Alias

The unique and identifiable alias of the contact or escalation plan.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Pattern: ^[a-z0-9_\-]*$

Update requires: Replacement

DisplayName

The full name of the contact or escalation plan.

Required: Yes

Type: String

Minimum: 0

Maximum: 255

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

Update requires: No interruption

Plan

A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

Required: No

Type: List of Stage

Update requires: No interruption

Type

Refers to the type of contact:

  • PERSONAL: A single, individual contact.

  • ESCALATION: An escalation plan.

  • ONCALL_SCHEDULE: An on-call schedule.

Required: Yes

Type: String

Allowed values: ESCALATION | ONCALL_SCHEDULE | PERSONAL

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the ARN of the resource.

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 Contact resource, such as arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias.