Class: Aws::Lightsail::Types::CreateContactMethodRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::CreateContactMethodRequest

Defined in:

(unknown)

Overview

Note:

When passing CreateContactMethodRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  protocol: "Email", # required, accepts Email, SMS
  contact_endpoint: "StringMax256", # required
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #contact_endpoint ⇒ String

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

• #protocol ⇒ String

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

Instance Attribute Details

#contact_endpoint ⇒ String

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

Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 on Wikipedia.

Returns:

• (String) —

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

#protocol ⇒ String

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

The SMS protocol is supported only in the following AWS Regions.

• US East (N. Virginia) (us-east-1)

• US West (Oregon) (us-west-2)

• Europe (Ireland) (eu-west-1)

• Asia Pacific (Tokyo) (ap-northeast-1)

• Asia Pacific (Singapore) (ap-southeast-1)

• Asia Pacific (Sydney) (ap-southeast-2)

For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide.

For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.

Returns:

• (String) —

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