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

Inherits:
Struct
  • Object
show all
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#contact_endpointString

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

Returns:

  • (String)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#created_atTime

The timestamp when the contact method was created.

Returns:

  • (Time)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#locationTypes::ResourceLocation

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



1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#nameString

The name of the contact method.

Returns:

  • (String)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#protocolString

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

Returns:

  • (String)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#resource_typeString

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

Returns:

  • (String)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#statusString

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)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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

#support_codeString

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)


1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1966

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