You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a contact method.

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

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)

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

#contact_endpointString

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

Returns:

  • (String)

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

#created_atTime

The timestamp when the contact method was created.

Returns:

  • (Time)

    The timestamp when the contact method was created.

#locationTypes::ResourceLocation

Describes the resource location.

Returns:

#nameString

The name of the contact method.

Returns:

  • (String)

    The name of the contact method.

#protocolString

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

Possible values:

  • Email
  • SMS

Returns:

  • (String)

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

#resource_typeString

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

Possible values:

  • ContainerService
  • Instance
  • StaticIp
  • KeyPair
  • InstanceSnapshot
  • Domain
  • PeeredVpc
  • LoadBalancer
  • LoadBalancerTlsCertificate
  • Disk
  • DiskSnapshot
  • RelationalDatabase
  • RelationalDatabaseSnapshot
  • ExportSnapshotRecord
  • CloudFormationStackRecord
  • Alarm
  • ContactMethod
  • Distribution
  • Certificate

Returns:

  • (String)

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

#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.

    Possible values:

    • PendingVerification
    • Valid
    • Invalid

Returns:

  • (String)

    The current status of the contact method.

#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)

    The support code.