« blib/lib/Paws/Lightsail/InputOrigin.pm
↑ Summary
blib/lib/Paws/Lightsail/InstanceAccessDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::Instance; | ||
| 3 | use Moose; | ||
| 4 | has AddOns => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::AddOn]', request_name => 'addOns', traits => ['NameInRequest']); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 6 | has BlueprintId => (is => 'ro', isa => 'Str', request_name => 'blueprintId', traits => ['NameInRequest']); | ||
| 7 | has BlueprintName => (is => 'ro', isa => 'Str', request_name => 'blueprintName', traits => ['NameInRequest']); | ||
| 8 | has BundleId => (is => 'ro', isa => 'Str', request_name => 'bundleId', traits => ['NameInRequest']); | ||
| 9 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 10 | has Hardware => (is => 'ro', isa => 'Paws::Lightsail::InstanceHardware', request_name => 'hardware', traits => ['NameInRequest']); | ||
| 11 | has IpAddressType => (is => 'ro', isa => 'Str', request_name => 'ipAddressType', traits => ['NameInRequest']); | ||
| 12 | has Ipv6Addresses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ipv6Addresses', traits => ['NameInRequest']); | ||
| 13 | has IsStaticIp => (is => 'ro', isa => 'Bool', request_name => 'isStaticIp', traits => ['NameInRequest']); | ||
| 14 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 15 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 16 | has Networking => (is => 'ro', isa => 'Paws::Lightsail::InstanceNetworking', request_name => 'networking', traits => ['NameInRequest']); | ||
| 17 | has PrivateIpAddress => (is => 'ro', isa => 'Str', request_name => 'privateIpAddress', traits => ['NameInRequest']); | ||
| 18 | has PublicIpAddress => (is => 'ro', isa => 'Str', request_name => 'publicIpAddress', traits => ['NameInRequest']); | ||
| 19 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 20 | has SshKeyName => (is => 'ro', isa => 'Str', request_name => 'sshKeyName', traits => ['NameInRequest']); | ||
| 21 | has State => (is => 'ro', isa => 'Paws::Lightsail::InstanceState', request_name => 'state', traits => ['NameInRequest']); | ||
| 22 | has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']); | ||
| 23 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 24 | has Username => (is => 'ro', isa => 'Str', request_name => 'username', traits => ['NameInRequest']); | ||
| 25 | |||
| 26 | 1; | ||
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::Lightsail::Instance | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::Lightsail::Instance object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { AddOns => $value, ..., Username => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::Instance object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->AddOns | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | Describes an instance (a virtual private server). | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AddOns => ArrayRef[L<Paws::Lightsail::AddOn>] | ||
| 62 | |||
| 63 | An array of objects representing the add-ons enabled on the instance. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Arn => Str | ||
| 67 | |||
| 68 | The Amazon Resource Name (ARN) of the instance (e.g., | ||
| 69 | C<arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE>). | ||
| 70 | |||
| 71 | |||
| 72 | =head2 BlueprintId => Str | ||
| 73 | |||
| 74 | The blueprint ID (e.g., C<os_amlinux_2016_03>). | ||
| 75 | |||
| 76 | |||
| 77 | =head2 BlueprintName => Str | ||
| 78 | |||
| 79 | The friendly name of the blueprint (e.g., C<Amazon Linux>). | ||
| 80 | |||
| 81 | |||
| 82 | =head2 BundleId => Str | ||
| 83 | |||
| 84 | The bundle for the instance (e.g., C<micro_1_0>). | ||
| 85 | |||
| 86 | |||
| 87 | =head2 CreatedAt => Str | ||
| 88 | |||
| 89 | The timestamp when the instance was created (e.g., C<1479734909.17>) in | ||
| 90 | Unix time format. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Hardware => L<Paws::Lightsail::InstanceHardware> | ||
| 94 | |||
| 95 | The size of the vCPU and the amount of RAM for the instance. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 IpAddressType => Str | ||
| 99 | |||
| 100 | The IP address type of the instance. | ||
| 101 | |||
| 102 | The possible values are C<ipv4> for IPv4 only, and C<dualstack> for | ||
| 103 | IPv4 and IPv6. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 Ipv6Addresses => ArrayRef[Str|Undef] | ||
| 107 | |||
| 108 | The IPv6 addresses of the instance. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 IsStaticIp => Bool | ||
| 112 | |||
| 113 | A Boolean value indicating whether this instance has a static IP | ||
| 114 | assigned to it. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 118 | |||
| 119 | The region name and Availability Zone where the instance is located. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 Name => Str | ||
| 123 | |||
| 124 | The name the user gave the instance (e.g., C<Amazon_Linux-1GB-Ohio-1>). | ||
| 125 | |||
| 126 | |||
| 127 | =head2 Networking => L<Paws::Lightsail::InstanceNetworking> | ||
| 128 | |||
| 129 | Information about the public ports and monthly data transfer rates for | ||
| 130 | the instance. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 PrivateIpAddress => Str | ||
| 134 | |||
| 135 | The private IP address of the instance. | ||
| 136 | |||
| 137 | |||
| 138 | =head2 PublicIpAddress => Str | ||
| 139 | |||
| 140 | The public IP address of the instance. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 ResourceType => Str | ||
| 144 | |||
| 145 | The type of resource (usually C<Instance>). | ||
| 146 | |||
| 147 | |||
| 148 | =head2 SshKeyName => Str | ||
| 149 | |||
| 150 | The name of the SSH key being used to connect to the instance (e.g., | ||
| 151 | C<LightsailDefaultKeyPair>). | ||
| 152 | |||
| 153 | |||
| 154 | =head2 State => L<Paws::Lightsail::InstanceState> | ||
| 155 | |||
| 156 | The status code and the state (e.g., C<running>) for the instance. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 SupportCode => Str | ||
| 160 | |||
| 161 | The support code. Include this code in your email to support when you | ||
| 162 | have questions about an instance or another resource in Lightsail. This | ||
| 163 | code enables our support team to look up your Lightsail information | ||
| 164 | more easily. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 168 | |||
| 169 | The tag keys and optional values for the resource. For more information | ||
| 170 | about tags in Lightsail, see the Lightsail Dev Guide | ||
| 171 | (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). | ||
| 172 | |||
| 173 | |||
| 174 | =head2 Username => Str | ||
| 175 | |||
| 176 | The user name for connecting to the instance (e.g., C<ec2-user>). | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head1 SEE ALSO | ||
| 181 | |||
| 182 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 183 | |||
| 184 | =head1 BUGS and CONTRIBUTIONS | ||
| 185 | |||
| 186 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 187 | |||
| 188 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 189 | |||
| 190 | =cut | ||
| 191 |