blib/lib/Paws/OpsWorksCM/Server.pm untested

filter: Statementstmt 0.0% 0 / 27 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::OpsWorksCM::Server;
3 use Moose;
4 has AssociatePublicIpAddress => (is => 'ro', isa => 'Bool');
5 has BackupRetentionCount => (is => 'ro', isa => 'Int');
6 has CloudFormationStackArn => (is => 'ro', isa => 'Str');
7 has CreatedAt => (is => 'ro', isa => 'Str');
8 has CustomDomain => (is => 'ro', isa => 'Str');
9 has DisableAutomatedBackup => (is => 'ro', isa => 'Bool');
10 has Endpoint => (is => 'ro', isa => 'Str');
11 has Engine => (is => 'ro', isa => 'Str');
12 has EngineAttributes => (is => 'ro', isa => 'ArrayRef[Paws::OpsWorksCM::EngineAttribute]');
13 has EngineModel => (is => 'ro', isa => 'Str');
14 has EngineVersion => (is => 'ro', isa => 'Str');
15 has InstanceProfileArn => (is => 'ro', isa => 'Str');
16 has InstanceType => (is => 'ro', isa => 'Str');
17 has KeyPair => (is => 'ro', isa => 'Str');
18 has MaintenanceStatus => (is => 'ro', isa => 'Str');
19 has PreferredBackupWindow => (is => 'ro', isa => 'Str');
20 has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str');
21 has SecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
22 has ServerArn => (is => 'ro', isa => 'Str');
23 has ServerName => (is => 'ro', isa => 'Str');
24 has ServiceRoleArn => (is => 'ro', isa => 'Str');
25 has Status => (is => 'ro', isa => 'Str');
26 has StatusReason => (is => 'ro', isa => 'Str');
27 has SubnetIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
28  
29 1;
30  
31 ### main pod documentation begin ###
32  
33 =head1 NAME
34  
35 Paws::OpsWorksCM::Server
36  
37 =head1 USAGE
38  
39 This class represents one of two things:
40  
41 =head3 Arguments in a call to a service
42  
43 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
44 Each attribute should be used as a named argument in the calls that expect this type of object.
45  
46 As an example, if Att1 is expected to be a Paws::OpsWorksCM::Server object:
47  
48 $service_obj->Method(Att1 => { AssociatePublicIpAddress => $value, ..., SubnetIds => $value });
49  
50 =head3 Results returned from an API call
51  
52 Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorksCM::Server object:
53  
54 $result = $service_obj->Method(...);
55 $result->Att1->AssociatePublicIpAddress
56  
57 =head1 DESCRIPTION
58  
59 Describes a configuration management server.
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 AssociatePublicIpAddress => Bool
65  
66 Associate a public IP address with a server that you are launching.
67  
68  
69 =head2 BackupRetentionCount => Int
70  
71 The number of automated backups to keep.
72  
73  
74 =head2 CloudFormationStackArn => Str
75  
76 The ARN of the CloudFormation stack that was used to create the server.
77  
78  
79 =head2 CreatedAt => Str
80  
81 Time stamp of server creation. Example C<2016-07-29T13:38:47.520Z>
82  
83  
84 =head2 CustomDomain => Str
85  
86 An optional public endpoint of a server, such as
87 C<https://aws.my-company.com>. You cannot access the server by using
88 the C<Endpoint> value if the server has a C<CustomDomain> specified.
89  
90  
91 =head2 DisableAutomatedBackup => Bool
92  
93 Disables automated backups. The number of stored backups is dependent
94 on the value of PreferredBackupCount.
95  
96  
97 =head2 Endpoint => Str
98  
99 A DNS name that can be used to access the engine. Example:
100 C<myserver-asdfghjkl.us-east-1.opsworks.io>. You cannot access the
101 server by using the C<Endpoint> value if the server has a
102 C<CustomDomain> specified.
103  
104  
105 =head2 Engine => Str
106  
107 The engine type of the server. Valid values in this release include
108 C<ChefAutomate> and C<Puppet>.
109  
110  
111 =head2 EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>]
112  
113 The response of a createServer() request returns the master credential
114 to access the server in EngineAttributes. These credentials are not
115 stored by AWS OpsWorks CM; they are returned only as part of the result
116 of createServer().
117  
118 B<Attributes returned in a createServer response for Chef>
119  
120 =over
121  
122 =item *
123  
124 C<CHEF_AUTOMATE_PIVOTAL_KEY>: A base64-encoded RSA private key that is
125 generated by AWS OpsWorks for Chef Automate. This private key is
126 required to access the Chef API.
127  
128 =item *
129  
130 C<CHEF_STARTER_KIT>: A base64-encoded ZIP file. The ZIP file contains a
131 Chef starter kit, which includes a README, a configuration file, and
132 the required RSA private key. Save this file, unzip it, and then change
133 to the directory where you've unzipped the file contents. From this
134 directory, you can run Knife commands.
135  
136 =back
137  
138 B<Attributes returned in a createServer response for Puppet>
139  
140 =over
141  
142 =item *
143  
144 C<PUPPET_STARTER_KIT>: A base64-encoded ZIP file. The ZIP file contains
145 a Puppet starter kit, including a README and a required private key.
146 Save this file, unzip it, and then change to the directory where you've
147 unzipped the file contents.
148  
149 =item *
150  
151 C<PUPPET_ADMIN_PASSWORD>: An administrator password that you can use to
152 sign in to the Puppet Enterprise console after the server is online.
153  
154 =back
155  
156  
157  
158 =head2 EngineModel => Str
159  
160 The engine model of the server. Valid values in this release include
161 C<Monolithic> for Puppet and C<Single> for Chef.
162  
163  
164 =head2 EngineVersion => Str
165  
166 The engine version of the server. For a Chef server, the valid value
167 for EngineVersion is currently C<2>. For a Puppet server, specify
168 either C<2019> or C<2017>.
169  
170  
171 =head2 InstanceProfileArn => Str
172  
173 The instance profile ARN of the server.
174  
175  
176 =head2 InstanceType => Str
177  
178 The instance type for the server, as specified in the CloudFormation
179 stack. This might not be the same instance type that is shown in the
180 EC2 console.
181  
182  
183 =head2 KeyPair => Str
184  
185 The key pair associated with the server.
186  
187  
188 =head2 MaintenanceStatus => Str
189  
190 The status of the most recent server maintenance run. Shows C<SUCCESS>
191 or C<FAILED>.
192  
193  
194 =head2 PreferredBackupWindow => Str
195  
196 The preferred backup period specified for the server.
197  
198  
199 =head2 PreferredMaintenanceWindow => Str
200  
201 The preferred maintenance period specified for the server.
202  
203  
204 =head2 SecurityGroupIds => ArrayRef[Str|Undef]
205  
206 The security group IDs for the server, as specified in the
207 CloudFormation stack. These might not be the same security groups that
208 are shown in the EC2 console.
209  
210  
211 =head2 ServerArn => Str
212  
213 The ARN of the server.
214  
215  
216 =head2 ServerName => Str
217  
218 The name of the server.
219  
220  
221 =head2 ServiceRoleArn => Str
222  
223 The service role ARN used to create the server.
224  
225  
226 =head2 Status => Str
227  
228 The server's status. This field displays the states of actions in
229 progress, such as creating, running, or backing up the server, as well
230 as the server's health state.
231  
232  
233 =head2 StatusReason => Str
234  
235 Depending on the server status, this field has either a human-readable
236 message (such as a create or backup error), or an escaped block of JSON
237 (used for health check results).
238  
239  
240 =head2 SubnetIds => ArrayRef[Str|Undef]
241  
242 The subnet IDs specified in a CreateServer request.
243  
244  
245  
246 =head1 SEE ALSO
247  
248 This class forms part of L<Paws>, describing an object used in L<Paws::OpsWorksCM>
249  
250 =head1 BUGS and CONTRIBUTIONS
251  
252 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
253  
254 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
255  
256 =cut
257