« blib/lib/Paws/Lightsail/CloudFormationStackRecordSourceInfo.pm
↑ Summary
blib/lib/Paws/Lightsail/Container.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::ContactMethod; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 5 | has ContactEndpoint => (is => 'ro', isa => 'Str', request_name => 'contactEndpoint', traits => ['NameInRequest']); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 7 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 9 | has Protocol => (is => 'ro', isa => 'Str', request_name => 'protocol', traits => ['NameInRequest']); | ||
| 10 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 11 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 12 | has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Lightsail::ContactMethod | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Lightsail::ContactMethod object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Arn => $value, ..., SupportCode => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::ContactMethod object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Arn | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Describes a contact method. | ||
| 45 | |||
| 46 | A contact method is a way to send you notifications. For more | ||
| 47 | information, see Notifications in Amazon Lightsail | ||
| 48 | (https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications). | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Arn => Str | ||
| 54 | |||
| 55 | The Amazon Resource Name (ARN) of the contact method. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ContactEndpoint => Str | ||
| 59 | |||
| 60 | The destination of the contact method, such as an email address or a | ||
| 61 | mobile phone number. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CreatedAt => Str | ||
| 65 | |||
| 66 | The timestamp when the contact method was created. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Name => Str | ||
| 75 | |||
| 76 | The name of the contact method. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Protocol => Str | ||
| 80 | |||
| 81 | The protocol of the contact method, such as email or SMS (text | ||
| 82 | messaging). | ||
| 83 | |||
| 84 | |||
| 85 | =head2 ResourceType => Str | ||
| 86 | |||
| 87 | The Lightsail resource type (e.g., C<ContactMethod>). | ||
| 88 | |||
| 89 | |||
| 90 | =head2 Status => Str | ||
| 91 | |||
| 92 | The current status of the contact method. | ||
| 93 | |||
| 94 | A contact method has the following possible status: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<PendingVerification> - The contact method has not yet been verified, | ||
| 101 | and the verification has not yet expired. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<Valid> - The contact method has been verified. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<InValid> - An attempt was made to verify the contact method, but the | ||
| 110 | verification has expired. | ||
| 111 | |||
| 112 | =back | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 SupportCode => Str | ||
| 117 | |||
| 118 | The support code. Include this code in your email to support when you | ||
| 119 | have questions about your Lightsail contact method. This code enables | ||
| 120 | our support team to look up your Lightsail information more easily. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |