ContactMethod
Describes a contact method.
A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.
Contents
- arn
-
The Amazon Resource Name (ARN) of the contact method.
Type: String
Pattern:
.*\S.*Required: No
- contactEndpoint
-
The destination of the contact method, such as an email address or a mobile phone number.
Type: String
Pattern:
.*\S.*Required: No
- createdAt
-
The timestamp when the contact method was created.
Type: Timestamp
Required: No
- location
-
An object that describes the location of the contact method, such as the AWS Region and Availability Zone.
Type: ResourceLocation object
Required: No
- name
-
The name of the contact method.
Type: String
Pattern:
\w[\w\-]*\wRequired: No
- protocol
-
The protocol of the contact method, such as email or SMS (text messaging).
Type: String
Valid Values:
Email | SMSRequired: No
- resourceType
-
The Lightsail resource type of the contact method.
Type: String
Valid Values:
ContainerService | Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate | BucketRequired: No
- status
-
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.
Type: String
Valid Values:
PendingVerification | Valid | InvalidRequired: No
-
- supportCode
-
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.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
