File Coverage

blib/lib/Paws/Lightsail/Instance.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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