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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lightsail/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#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][1: on Wikipedia.

[1]: en.wikipedia.org/wiki/E.164

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 3094

class CreateContactMethodRequest < Struct.new(
  :protocol,
  :contact_endpoint)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ `String`

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

The ‘SMS` protocol is supported only in the following Amazon Web Services 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 Amazon Web Services 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].

[1]: docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html [2]: lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications