View a markdown version of this page

AWS::Lightsail::ContactMethod - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lightsail::ContactMethod

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

Syntax

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

JSON

{
  "Type" : "AWS::Lightsail::ContactMethod",
  "Properties" : {
      "ContactEndpoint" : String,
      "Protocol" : String
    }
}

YAML

Type: AWS::Lightsail::ContactMethod
Properties:
  ContactEndpoint: String
  Protocol: String

Properties

ContactEndpoint

The destination of the contact method, such as an email address or a mobile phone number.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

Protocol

The protocol of the contact method, such as email or SMS (text messaging).

Required: Yes

Type: String

Allowed values: Email | SMS

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the contact method.

CreatedAt

The timestamp when the contact method was created.

Name

The name of the contact method.

ResourceType

The Lightsail resource type of the contact method.

Status

The current status of the contact method.

A contact method has the following possible status:

  • PendingVerification - The contact method has not yet been verified, and the verification has not yet expired.

  • Valid - The contact method has been verified.

  • InValid - An attempt was made to verify the contact method, but the verification has expired.

SupportCode

The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.