Class: Aws::Lightsail::Types::ContactMethod

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::ContactMethod

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Describes a contact method.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #contact_endpoint ⇒ String

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

• #created_at ⇒ Time

  The timestamp when the contact method was created.

• #location ⇒ Types::ResourceLocation

  An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

• #name ⇒ String

  The name of the contact method.

• #protocol ⇒ String

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

• #resource_type ⇒ String

  The Lightsail resource type (e.g., ContactMethod).

• #status ⇒ String

  The current status of the contact method.

• #support_code ⇒ String

  The support code.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#contact_endpoint ⇒ String

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

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the contact method was created.

Returns:

• (Time)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#location ⇒ Types::ResourceLocation

An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.

Returns:

• (Types::ResourceLocation)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the contact method.

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

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

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The Lightsail resource type (e.g., ContactMethod).

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#support_code ⇒ String

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.

Returns:

• (String)

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

class ContactMethod < Struct.new(
  :contact_endpoint,
  :status,
  :protocol,
  :name,
  :arn,
  :created_at,
  :location,
  :resource_type,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end