| 1 | package Paws::OpsWorksCM; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'opsworks-cm' } | ||
| 4 | sub signing_name { 'opsworks-cm' } | ||
| 5 | sub version { '2016-11-01' } | ||
| 6 | sub target_prefix { 'OpsWorksCM_V2016_11_01' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub AssociateNode { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::AssociateNode', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub CreateBackup { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::CreateBackup', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub CreateServer { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::CreateServer', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub DeleteBackup { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DeleteBackup', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub DeleteServer { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DeleteServer', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub DescribeAccountAttributes { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DescribeAccountAttributes', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub DescribeBackups { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DescribeBackups', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | sub DescribeEvents { | ||
| 54 | my $self = shift; | ||
| 55 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DescribeEvents', @_); | ||
| 56 | return $self->caller->do_call($self, $call_object); | ||
| 57 | } | ||
| 58 | sub DescribeNodeAssociationStatus { | ||
| 59 | my $self = shift; | ||
| 60 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DescribeNodeAssociationStatus', @_); | ||
| 61 | return $self->caller->do_call($self, $call_object); | ||
| 62 | } | ||
| 63 | sub DescribeServers { | ||
| 64 | my $self = shift; | ||
| 65 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DescribeServers', @_); | ||
| 66 | return $self->caller->do_call($self, $call_object); | ||
| 67 | } | ||
| 68 | sub DisassociateNode { | ||
| 69 | my $self = shift; | ||
| 70 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::DisassociateNode', @_); | ||
| 71 | return $self->caller->do_call($self, $call_object); | ||
| 72 | } | ||
| 73 | sub ExportServerEngineAttribute { | ||
| 74 | my $self = shift; | ||
| 75 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::ExportServerEngineAttribute', @_); | ||
| 76 | return $self->caller->do_call($self, $call_object); | ||
| 77 | } | ||
| 78 | sub ListTagsForResource { | ||
| 79 | my $self = shift; | ||
| 80 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::ListTagsForResource', @_); | ||
| 81 | return $self->caller->do_call($self, $call_object); | ||
| 82 | } | ||
| 83 | sub RestoreServer { | ||
| 84 | my $self = shift; | ||
| 85 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::RestoreServer', @_); | ||
| 86 | return $self->caller->do_call($self, $call_object); | ||
| 87 | } | ||
| 88 | sub StartMaintenance { | ||
| 89 | my $self = shift; | ||
| 90 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::StartMaintenance', @_); | ||
| 91 | return $self->caller->do_call($self, $call_object); | ||
| 92 | } | ||
| 93 | sub TagResource { | ||
| 94 | my $self = shift; | ||
| 95 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::TagResource', @_); | ||
| 96 | return $self->caller->do_call($self, $call_object); | ||
| 97 | } | ||
| 98 | sub UntagResource { | ||
| 99 | my $self = shift; | ||
| 100 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::UntagResource', @_); | ||
| 101 | return $self->caller->do_call($self, $call_object); | ||
| 102 | } | ||
| 103 | sub UpdateServer { | ||
| 104 | my $self = shift; | ||
| 105 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::UpdateServer', @_); | ||
| 106 | return $self->caller->do_call($self, $call_object); | ||
| 107 | } | ||
| 108 | sub UpdateServerEngineAttributes { | ||
| 109 | my $self = shift; | ||
| 110 | my $call_object = $self->new_with_coercions('Paws::OpsWorksCM::UpdateServerEngineAttributes', @_); | ||
| 111 | return $self->caller->do_call($self, $call_object); | ||
| 112 | } | ||
| 113 | |||
| 114 | sub DescribeAllBackups { | ||
| 115 | my $self = shift; | ||
| 116 | |||
| 117 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 118 | my $result = $self->DescribeBackups(@_); | ||
| 119 | my $next_result = $result; | ||
| 120 | |||
| 121 | if (not defined $callback) { | ||
| 122 | while ($next_result->NextToken) { | ||
| 123 | $next_result = $self->DescribeBackups(@_, NextToken => $next_result->NextToken); | ||
| 124 | push @{ $result->Backups }, @{ $next_result->Backups }; | ||
| 125 | } | ||
| 126 | return $result; | ||
| 127 | } else { | ||
| 128 | while ($result->NextToken) { | ||
| 129 | $callback->($_ => 'Backups') foreach (@{ $result->Backups }); | ||
| 130 | $result = $self->DescribeBackups(@_, NextToken => $result->NextToken); | ||
| 131 | } | ||
| 132 | $callback->($_ => 'Backups') foreach (@{ $result->Backups }); | ||
| 133 | } | ||
| 134 | |||
| 135 | return undef | ||
| 136 | } | ||
| 137 | sub DescribeAllEvents { | ||
| 138 | my $self = shift; | ||
| 139 | |||
| 140 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 141 | my $result = $self->DescribeEvents(@_); | ||
| 142 | my $next_result = $result; | ||
| 143 | |||
| 144 | if (not defined $callback) { | ||
| 145 | while ($next_result->NextToken) { | ||
| 146 | $next_result = $self->DescribeEvents(@_, NextToken => $next_result->NextToken); | ||
| 147 | push @{ $result->ServerEvents }, @{ $next_result->ServerEvents }; | ||
| 148 | } | ||
| 149 | return $result; | ||
| 150 | } else { | ||
| 151 | while ($result->NextToken) { | ||
| 152 | $callback->($_ => 'ServerEvents') foreach (@{ $result->ServerEvents }); | ||
| 153 | $result = $self->DescribeEvents(@_, NextToken => $result->NextToken); | ||
| 154 | } | ||
| 155 | $callback->($_ => 'ServerEvents') foreach (@{ $result->ServerEvents }); | ||
| 156 | } | ||
| 157 | |||
| 158 | return undef | ||
| 159 | } | ||
| 160 | sub DescribeAllServers { | ||
| 161 | my $self = shift; | ||
| 162 | |||
| 163 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 164 | my $result = $self->DescribeServers(@_); | ||
| 165 | my $next_result = $result; | ||
| 166 | |||
| 167 | if (not defined $callback) { | ||
| 168 | while ($next_result->NextToken) { | ||
| 169 | $next_result = $self->DescribeServers(@_, NextToken => $next_result->NextToken); | ||
| 170 | push @{ $result->Servers }, @{ $next_result->Servers }; | ||
| 171 | } | ||
| 172 | return $result; | ||
| 173 | } else { | ||
| 174 | while ($result->NextToken) { | ||
| 175 | $callback->($_ => 'Servers') foreach (@{ $result->Servers }); | ||
| 176 | $result = $self->DescribeServers(@_, NextToken => $result->NextToken); | ||
| 177 | } | ||
| 178 | $callback->($_ => 'Servers') foreach (@{ $result->Servers }); | ||
| 179 | } | ||
| 180 | |||
| 181 | return undef | ||
| 182 | } | ||
| 183 | sub ListAllTagsForResource { | ||
| 184 | my $self = shift; | ||
| 185 | |||
| 186 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 187 | my $result = $self->ListTagsForResource(@_); | ||
| 188 | my $next_result = $result; | ||
| 189 | |||
| 190 | if (not defined $callback) { | ||
| 191 | while ($next_result->NextToken) { | ||
| 192 | $next_result = $self->ListTagsForResource(@_, NextToken => $next_result->NextToken); | ||
| 193 | push @{ $result->Tags }, @{ $next_result->Tags }; | ||
| 194 | } | ||
| 195 | return $result; | ||
| 196 | } else { | ||
| 197 | while ($result->NextToken) { | ||
| 198 | $callback->($_ => 'Tags') foreach (@{ $result->Tags }); | ||
| 199 | $result = $self->ListTagsForResource(@_, NextToken => $result->NextToken); | ||
| 200 | } | ||
| 201 | $callback->($_ => 'Tags') foreach (@{ $result->Tags }); | ||
| 202 | } | ||
| 203 | |||
| 204 | return undef | ||
| 205 | } | ||
| 206 | |||
| 207 | |||
| 208 | sub operations { qw/AssociateNode CreateBackup CreateServer DeleteBackup DeleteServer DescribeAccountAttributes DescribeBackups DescribeEvents DescribeNodeAssociationStatus DescribeServers DisassociateNode ExportServerEngineAttribute ListTagsForResource RestoreServer StartMaintenance TagResource UntagResource UpdateServer UpdateServerEngineAttributes / } | ||
| 209 | |||
| 210 | 1; | ||
| 211 | |||
| 212 | ### main pod documentation begin ### | ||
| 213 | |||
| 214 | =head1 NAME | ||
| 215 | |||
| 216 | Paws::OpsWorksCM - Perl Interface to AWS AWS OpsWorks CM | ||
| 217 | |||
| 218 | =head1 SYNOPSIS | ||
| 219 | |||
| 220 | use Paws; | ||
| 221 | |||
| 222 | my $obj = Paws->service('OpsWorksCM'); | ||
| 223 | my $res = $obj->Method( | ||
| 224 | Arg1 => $val1, | ||
| 225 | Arg2 => [ 'V1', 'V2' ], | ||
| 226 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 227 | # of the arguments type | ||
| 228 | Arg3 => { Att1 => 'Val1' }, | ||
| 229 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 230 | # the constructor of the arguments type | ||
| 231 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 232 | ); | ||
| 233 | |||
| 234 | =head1 DESCRIPTION | ||
| 235 | |||
| 236 | AWS OpsWorks CM | ||
| 237 | |||
| 238 | AWS OpsWorks for configuration management (CM) is a service that runs | ||
| 239 | and manages configuration management servers. You can use AWS OpsWorks | ||
| 240 | CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks | ||
| 241 | for Puppet Enterprise servers, and add or remove nodes for the servers | ||
| 242 | to manage. | ||
| 243 | |||
| 244 | B<Glossary of terms> | ||
| 245 | |||
| 246 | =over | ||
| 247 | |||
| 248 | =item * | ||
| 249 | |||
| 250 | B<Server>: A configuration management server that can be | ||
| 251 | highly-available. The configuration management server runs on an Amazon | ||
| 252 | Elastic Compute Cloud (EC2) instance, and may use various other AWS | ||
| 253 | services, such as Amazon Relational Database Service (RDS) and Elastic | ||
| 254 | Load Balancing. A server is a generic abstraction over the | ||
| 255 | configuration manager that you want to use, much like Amazon RDS. In | ||
| 256 | AWS OpsWorks CM, you do not start or stop servers. After you create | ||
| 257 | servers, they continue to run until they are deleted. | ||
| 258 | |||
| 259 | =item * | ||
| 260 | |||
| 261 | B<Engine>: The engine is the specific configuration manager that you | ||
| 262 | want to use. Valid values in this release include C<ChefAutomate> and | ||
| 263 | C<Puppet>. | ||
| 264 | |||
| 265 | =item * | ||
| 266 | |||
| 267 | B<Backup>: This is an application-level backup of the data that the | ||
| 268 | configuration manager stores. AWS OpsWorks CM creates an S3 bucket for | ||
| 269 | backups when you launch the first server. A backup maintains a snapshot | ||
| 270 | of a server's configuration-related attributes at the time the backup | ||
| 271 | starts. | ||
| 272 | |||
| 273 | =item * | ||
| 274 | |||
| 275 | B<Events>: Events are always related to a server. Events are written | ||
| 276 | during server creation, when health checks run, when backups are | ||
| 277 | created, when system maintenance is performed, etc. When you delete a | ||
| 278 | server, the server's events are also deleted. | ||
| 279 | |||
| 280 | =item * | ||
| 281 | |||
| 282 | B<Account attributes>: Every account has attributes that are assigned | ||
| 283 | in the AWS OpsWorks CM database. These attributes store information | ||
| 284 | about configuration limits (servers, backups, etc.) and your customer | ||
| 285 | account. | ||
| 286 | |||
| 287 | =back | ||
| 288 | |||
| 289 | B<Endpoints> | ||
| 290 | |||
| 291 | AWS OpsWorks CM supports the following endpoints, all HTTPS. You must | ||
| 292 | connect to one of the following endpoints. Your servers can only be | ||
| 293 | accessed or managed within the endpoint in which they are created. | ||
| 294 | |||
| 295 | =over | ||
| 296 | |||
| 297 | =item * | ||
| 298 | |||
| 299 | opsworks-cm.us-east-1.amazonaws.com | ||
| 300 | |||
| 301 | =item * | ||
| 302 | |||
| 303 | opsworks-cm.us-east-2.amazonaws.com | ||
| 304 | |||
| 305 | =item * | ||
| 306 | |||
| 307 | opsworks-cm.us-west-1.amazonaws.com | ||
| 308 | |||
| 309 | =item * | ||
| 310 | |||
| 311 | opsworks-cm.us-west-2.amazonaws.com | ||
| 312 | |||
| 313 | =item * | ||
| 314 | |||
| 315 | opsworks-cm.ap-northeast-1.amazonaws.com | ||
| 316 | |||
| 317 | =item * | ||
| 318 | |||
| 319 | opsworks-cm.ap-southeast-1.amazonaws.com | ||
| 320 | |||
| 321 | =item * | ||
| 322 | |||
| 323 | opsworks-cm.ap-southeast-2.amazonaws.com | ||
| 324 | |||
| 325 | =item * | ||
| 326 | |||
| 327 | opsworks-cm.eu-central-1.amazonaws.com | ||
| 328 | |||
| 329 | =item * | ||
| 330 | |||
| 331 | opsworks-cm.eu-west-1.amazonaws.com | ||
| 332 | |||
| 333 | =back | ||
| 334 | |||
| 335 | For more information, see AWS OpsWorks endpoints and quotas | ||
| 336 | (https://docs.aws.amazon.com/general/latest/gr/opsworks-service.html) | ||
| 337 | in the AWS General Reference. | ||
| 338 | |||
| 339 | B<Throttling limits> | ||
| 340 | |||
| 341 | All API operations allow for five requests per second with a burst of | ||
| 342 | 10 requests per second. | ||
| 343 | |||
| 344 | For the AWS API documentation, see L<https://docs.aws.amazon.com/opsworks/> | ||
| 345 | |||
| 346 | |||
| 347 | =head1 METHODS | ||
| 348 | |||
| 349 | =head2 AssociateNode | ||
| 350 | |||
| 351 | =over | ||
| 352 | |||
| 353 | =item EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>] | ||
| 354 | |||
| 355 | =item NodeName => Str | ||
| 356 | |||
| 357 | =item ServerName => Str | ||
| 358 | |||
| 359 | |||
| 360 | =back | ||
| 361 | |||
| 362 | Each argument is described in detail in: L<Paws::OpsWorksCM::AssociateNode> | ||
| 363 | |||
| 364 | Returns: a L<Paws::OpsWorksCM::AssociateNodeResponse> instance | ||
| 365 | |||
| 366 | Associates a new node with the server. For more information about how | ||
| 367 | to disassociate a node, see DisassociateNode. | ||
| 368 | |||
| 369 | On a Chef server: This command is an alternative to C<knife bootstrap>. | ||
| 370 | |||
| 371 | Example (Chef): C<aws opsworks-cm associate-node --server-name | ||
| 372 | I<MyServer> --node-name I<MyManagedNode> --engine-attributes | ||
| 373 | "Name=I<CHEF_ORGANIZATION>,Value=default" | ||
| 374 | "Name=I<CHEF_NODE_PUBLIC_KEY>,Value=I<public-key-pem>"> | ||
| 375 | |||
| 376 | On a Puppet server, this command is an alternative to the C<puppet cert | ||
| 377 | sign> command that signs a Puppet node CSR. | ||
| 378 | |||
| 379 | Example (Puppet): C<aws opsworks-cm associate-node --server-name | ||
| 380 | I<MyServer> --node-name I<MyManagedNode> --engine-attributes | ||
| 381 | "Name=I<PUPPET_NODE_CSR>,Value=I<csr-pem>"> | ||
| 382 | |||
| 383 | A node can can only be associated with servers that are in a C<HEALTHY> | ||
| 384 | state. Otherwise, an C<InvalidStateException> is thrown. A | ||
| 385 | C<ResourceNotFoundException> is thrown when the server does not exist. | ||
| 386 | A C<ValidationException> is raised when parameters of the request are | ||
| 387 | not valid. The AssociateNode API call can be integrated into Auto | ||
| 388 | Scaling configurations, AWS Cloudformation templates, or the user data | ||
| 389 | of a server's instance. | ||
| 390 | |||
| 391 | |||
| 392 | =head2 CreateBackup | ||
| 393 | |||
| 394 | =over | ||
| 395 | |||
| 396 | =item ServerName => Str | ||
| 397 | |||
| 398 | =item [Description => Str] | ||
| 399 | |||
| 400 | =item [Tags => ArrayRef[L<Paws::OpsWorksCM::Tag>]] | ||
| 401 | |||
| 402 | |||
| 403 | =back | ||
| 404 | |||
| 405 | Each argument is described in detail in: L<Paws::OpsWorksCM::CreateBackup> | ||
| 406 | |||
| 407 | Returns: a L<Paws::OpsWorksCM::CreateBackupResponse> instance | ||
| 408 | |||
| 409 | Creates an application-level backup of a server. While the server is in | ||
| 410 | the C<BACKING_UP> state, the server cannot be changed, and no | ||
| 411 | additional backup can be created. | ||
| 412 | |||
| 413 | Backups can be created for servers in C<RUNNING>, C<HEALTHY>, and | ||
| 414 | C<UNHEALTHY> states. By default, you can create a maximum of 50 manual | ||
| 415 | backups. | ||
| 416 | |||
| 417 | This operation is asynchronous. | ||
| 418 | |||
| 419 | A C<LimitExceededException> is thrown when the maximum number of manual | ||
| 420 | backups is reached. An C<InvalidStateException> is thrown when the | ||
| 421 | server is not in any of the following states: RUNNING, HEALTHY, or | ||
| 422 | UNHEALTHY. A C<ResourceNotFoundException> is thrown when the server is | ||
| 423 | not found. A C<ValidationException> is thrown when parameters of the | ||
| 424 | request are not valid. | ||
| 425 | |||
| 426 | |||
| 427 | =head2 CreateServer | ||
| 428 | |||
| 429 | =over | ||
| 430 | |||
| 431 | =item Engine => Str | ||
| 432 | |||
| 433 | =item InstanceProfileArn => Str | ||
| 434 | |||
| 435 | =item InstanceType => Str | ||
| 436 | |||
| 437 | =item ServerName => Str | ||
| 438 | |||
| 439 | =item ServiceRoleArn => Str | ||
| 440 | |||
| 441 | =item [AssociatePublicIpAddress => Bool] | ||
| 442 | |||
| 443 | =item [BackupId => Str] | ||
| 444 | |||
| 445 | =item [BackupRetentionCount => Int] | ||
| 446 | |||
| 447 | =item [CustomCertificate => Str] | ||
| 448 | |||
| 449 | =item [CustomDomain => Str] | ||
| 450 | |||
| 451 | =item [CustomPrivateKey => Str] | ||
| 452 | |||
| 453 | =item [DisableAutomatedBackup => Bool] | ||
| 454 | |||
| 455 | =item [EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>]] | ||
| 456 | |||
| 457 | =item [EngineModel => Str] | ||
| 458 | |||
| 459 | =item [EngineVersion => Str] | ||
| 460 | |||
| 461 | =item [KeyPair => Str] | ||
| 462 | |||
| 463 | =item [PreferredBackupWindow => Str] | ||
| 464 | |||
| 465 | =item [PreferredMaintenanceWindow => Str] | ||
| 466 | |||
| 467 | =item [SecurityGroupIds => ArrayRef[Str|Undef]] | ||
| 468 | |||
| 469 | =item [SubnetIds => ArrayRef[Str|Undef]] | ||
| 470 | |||
| 471 | =item [Tags => ArrayRef[L<Paws::OpsWorksCM::Tag>]] | ||
| 472 | |||
| 473 | |||
| 474 | =back | ||
| 475 | |||
| 476 | Each argument is described in detail in: L<Paws::OpsWorksCM::CreateServer> | ||
| 477 | |||
| 478 | Returns: a L<Paws::OpsWorksCM::CreateServerResponse> instance | ||
| 479 | |||
| 480 | Creates and immedately starts a new server. The server is ready to use | ||
| 481 | when it is in the C<HEALTHY> state. By default, you can create a | ||
| 482 | maximum of 10 servers. | ||
| 483 | |||
| 484 | This operation is asynchronous. | ||
| 485 | |||
| 486 | A C<LimitExceededException> is thrown when you have created the maximum | ||
| 487 | number of servers (10). A C<ResourceAlreadyExistsException> is thrown | ||
| 488 | when a server with the same name already exists in the account. A | ||
| 489 | C<ResourceNotFoundException> is thrown when you specify a backup ID | ||
| 490 | that is not valid or is for a backup that does not exist. A | ||
| 491 | C<ValidationException> is thrown when parameters of the request are not | ||
| 492 | valid. | ||
| 493 | |||
| 494 | If you do not specify a security group by adding the | ||
| 495 | C<SecurityGroupIds> parameter, AWS OpsWorks creates a new security | ||
| 496 | group. | ||
| 497 | |||
| 498 | I<Chef Automate:> The default security group opens the Chef server to | ||
| 499 | the world on TCP port 443. If a KeyName is present, AWS OpsWorks | ||
| 500 | enables SSH access. SSH is also open to the world on TCP port 22. | ||
| 501 | |||
| 502 | I<Puppet Enterprise:> The default security group opens TCP ports 22, | ||
| 503 | 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS | ||
| 504 | OpsWorks enables SSH access. SSH is also open to the world on TCP port | ||
| 505 | 22. | ||
| 506 | |||
| 507 | By default, your server is accessible from any IP address. We recommend | ||
| 508 | that you update your security group rules to allow access from known IP | ||
| 509 | addresses and address ranges only. To edit security group rules, open | ||
| 510 | Security Groups in the navigation pane of the EC2 management console. | ||
| 511 | |||
| 512 | To specify your own domain for a server, and provide your own | ||
| 513 | self-signed or CA-signed certificate and private key, specify values | ||
| 514 | for C<CustomDomain>, C<CustomCertificate>, and C<CustomPrivateKey>. | ||
| 515 | |||
| 516 | |||
| 517 | =head2 DeleteBackup | ||
| 518 | |||
| 519 | =over | ||
| 520 | |||
| 521 | =item BackupId => Str | ||
| 522 | |||
| 523 | |||
| 524 | =back | ||
| 525 | |||
| 526 | Each argument is described in detail in: L<Paws::OpsWorksCM::DeleteBackup> | ||
| 527 | |||
| 528 | Returns: a L<Paws::OpsWorksCM::DeleteBackupResponse> instance | ||
| 529 | |||
| 530 | Deletes a backup. You can delete both manual and automated backups. | ||
| 531 | This operation is asynchronous. | ||
| 532 | |||
| 533 | An C<InvalidStateException> is thrown when a backup deletion is already | ||
| 534 | in progress. A C<ResourceNotFoundException> is thrown when the backup | ||
| 535 | does not exist. A C<ValidationException> is thrown when parameters of | ||
| 536 | the request are not valid. | ||
| 537 | |||
| 538 | |||
| 539 | =head2 DeleteServer | ||
| 540 | |||
| 541 | =over | ||
| 542 | |||
| 543 | =item ServerName => Str | ||
| 544 | |||
| 545 | |||
| 546 | =back | ||
| 547 | |||
| 548 | Each argument is described in detail in: L<Paws::OpsWorksCM::DeleteServer> | ||
| 549 | |||
| 550 | Returns: a L<Paws::OpsWorksCM::DeleteServerResponse> instance | ||
| 551 | |||
| 552 | Deletes the server and the underlying AWS CloudFormation stacks | ||
| 553 | (including the server's EC2 instance). When you run this command, the | ||
| 554 | server state is updated to C<DELETING>. After the server is deleted, it | ||
| 555 | is no longer returned by C<DescribeServer> requests. If the AWS | ||
| 556 | CloudFormation stack cannot be deleted, the server cannot be deleted. | ||
| 557 | |||
| 558 | This operation is asynchronous. | ||
| 559 | |||
| 560 | An C<InvalidStateException> is thrown when a server deletion is already | ||
| 561 | in progress. A C<ResourceNotFoundException> is thrown when the server | ||
| 562 | does not exist. A C<ValidationException> is raised when parameters of | ||
| 563 | the request are not valid. | ||
| 564 | |||
| 565 | |||
| 566 | =head2 DescribeAccountAttributes | ||
| 567 | |||
| 568 | |||
| 569 | |||
| 570 | |||
| 571 | |||
| 572 | |||
| 573 | Each argument is described in detail in: L<Paws::OpsWorksCM::DescribeAccountAttributes> | ||
| 574 | |||
| 575 | Returns: a L<Paws::OpsWorksCM::DescribeAccountAttributesResponse> instance | ||
| 576 | |||
| 577 | Describes your OpsWorks-CM account attributes. | ||
| 578 | |||
| 579 | This operation is synchronous. | ||
| 580 | |||
| 581 | |||
| 582 | =head2 DescribeBackups | ||
| 583 | |||
| 584 | =over | ||
| 585 | |||
| 586 | =item [BackupId => Str] | ||
| 587 | |||
| 588 | =item [MaxResults => Int] | ||
| 589 | |||
| 590 | =item [NextToken => Str] | ||
| 591 | |||
| 592 | =item [ServerName => Str] | ||
| 593 | |||
| 594 | |||
| 595 | =back | ||
| 596 | |||
| 597 | Each argument is described in detail in: L<Paws::OpsWorksCM::DescribeBackups> | ||
| 598 | |||
| 599 | Returns: a L<Paws::OpsWorksCM::DescribeBackupsResponse> instance | ||
| 600 | |||
| 601 | Describes backups. The results are ordered by time, with newest backups | ||
| 602 | first. If you do not specify a BackupId or ServerName, the command | ||
| 603 | returns all backups. | ||
| 604 | |||
| 605 | This operation is synchronous. | ||
| 606 | |||
| 607 | A C<ResourceNotFoundException> is thrown when the backup does not | ||
| 608 | exist. A C<ValidationException> is raised when parameters of the | ||
| 609 | request are not valid. | ||
| 610 | |||
| 611 | |||
| 612 | =head2 DescribeEvents | ||
| 613 | |||
| 614 | =over | ||
| 615 | |||
| 616 | =item ServerName => Str | ||
| 617 | |||
| 618 | =item [MaxResults => Int] | ||
| 619 | |||
| 620 | =item [NextToken => Str] | ||
| 621 | |||
| 622 | |||
| 623 | =back | ||
| 624 | |||
| 625 | Each argument is described in detail in: L<Paws::OpsWorksCM::DescribeEvents> | ||
| 626 | |||
| 627 | Returns: a L<Paws::OpsWorksCM::DescribeEventsResponse> instance | ||
| 628 | |||
| 629 | Describes events for a specified server. Results are ordered by time, | ||
| 630 | with newest events first. | ||
| 631 | |||
| 632 | This operation is synchronous. | ||
| 633 | |||
| 634 | A C<ResourceNotFoundException> is thrown when the server does not | ||
| 635 | exist. A C<ValidationException> is raised when parameters of the | ||
| 636 | request are not valid. | ||
| 637 | |||
| 638 | |||
| 639 | =head2 DescribeNodeAssociationStatus | ||
| 640 | |||
| 641 | =over | ||
| 642 | |||
| 643 | =item NodeAssociationStatusToken => Str | ||
| 644 | |||
| 645 | =item ServerName => Str | ||
| 646 | |||
| 647 | |||
| 648 | =back | ||
| 649 | |||
| 650 | Each argument is described in detail in: L<Paws::OpsWorksCM::DescribeNodeAssociationStatus> | ||
| 651 | |||
| 652 | Returns: a L<Paws::OpsWorksCM::DescribeNodeAssociationStatusResponse> instance | ||
| 653 | |||
| 654 | Returns the current status of an existing association or disassociation | ||
| 655 | request. | ||
| 656 | |||
| 657 | A C<ResourceNotFoundException> is thrown when no recent association or | ||
| 658 | disassociation request with the specified token is found, or when the | ||
| 659 | server does not exist. A C<ValidationException> is raised when | ||
| 660 | parameters of the request are not valid. | ||
| 661 | |||
| 662 | |||
| 663 | =head2 DescribeServers | ||
| 664 | |||
| 665 | =over | ||
| 666 | |||
| 667 | =item [MaxResults => Int] | ||
| 668 | |||
| 669 | =item [NextToken => Str] | ||
| 670 | |||
| 671 | =item [ServerName => Str] | ||
| 672 | |||
| 673 | |||
| 674 | =back | ||
| 675 | |||
| 676 | Each argument is described in detail in: L<Paws::OpsWorksCM::DescribeServers> | ||
| 677 | |||
| 678 | Returns: a L<Paws::OpsWorksCM::DescribeServersResponse> instance | ||
| 679 | |||
| 680 | Lists all configuration management servers that are identified with | ||
| 681 | your account. Only the stored results from Amazon DynamoDB are | ||
| 682 | returned. AWS OpsWorks CM does not query other services. | ||
| 683 | |||
| 684 | This operation is synchronous. | ||
| 685 | |||
| 686 | A C<ResourceNotFoundException> is thrown when the server does not | ||
| 687 | exist. A C<ValidationException> is raised when parameters of the | ||
| 688 | request are not valid. | ||
| 689 | |||
| 690 | |||
| 691 | =head2 DisassociateNode | ||
| 692 | |||
| 693 | =over | ||
| 694 | |||
| 695 | =item NodeName => Str | ||
| 696 | |||
| 697 | =item ServerName => Str | ||
| 698 | |||
| 699 | =item [EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>]] | ||
| 700 | |||
| 701 | |||
| 702 | =back | ||
| 703 | |||
| 704 | Each argument is described in detail in: L<Paws::OpsWorksCM::DisassociateNode> | ||
| 705 | |||
| 706 | Returns: a L<Paws::OpsWorksCM::DisassociateNodeResponse> instance | ||
| 707 | |||
| 708 | Disassociates a node from an AWS OpsWorks CM server, and removes the | ||
| 709 | node from the server's managed nodes. After a node is disassociated, | ||
| 710 | the node key pair is no longer valid for accessing the configuration | ||
| 711 | manager's API. For more information about how to associate a node, see | ||
| 712 | AssociateNode. | ||
| 713 | |||
| 714 | A node can can only be disassociated from a server that is in a | ||
| 715 | C<HEALTHY> state. Otherwise, an C<InvalidStateException> is thrown. A | ||
| 716 | C<ResourceNotFoundException> is thrown when the server does not exist. | ||
| 717 | A C<ValidationException> is raised when parameters of the request are | ||
| 718 | not valid. | ||
| 719 | |||
| 720 | |||
| 721 | =head2 ExportServerEngineAttribute | ||
| 722 | |||
| 723 | =over | ||
| 724 | |||
| 725 | =item ExportAttributeName => Str | ||
| 726 | |||
| 727 | =item ServerName => Str | ||
| 728 | |||
| 729 | =item [InputAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>]] | ||
| 730 | |||
| 731 | |||
| 732 | =back | ||
| 733 | |||
| 734 | Each argument is described in detail in: L<Paws::OpsWorksCM::ExportServerEngineAttribute> | ||
| 735 | |||
| 736 | Returns: a L<Paws::OpsWorksCM::ExportServerEngineAttributeResponse> instance | ||
| 737 | |||
| 738 | Exports a specified server engine attribute as a base64-encoded string. | ||
| 739 | For example, you can export user data that you can use in EC2 to | ||
| 740 | associate nodes with a server. | ||
| 741 | |||
| 742 | This operation is synchronous. | ||
| 743 | |||
| 744 | A C<ValidationException> is raised when parameters of the request are | ||
| 745 | not valid. A C<ResourceNotFoundException> is thrown when the server | ||
| 746 | does not exist. An C<InvalidStateException> is thrown when the server | ||
| 747 | is in any of the following states: CREATING, TERMINATED, FAILED or | ||
| 748 | DELETING. | ||
| 749 | |||
| 750 | |||
| 751 | =head2 ListTagsForResource | ||
| 752 | |||
| 753 | =over | ||
| 754 | |||
| 755 | =item ResourceArn => Str | ||
| 756 | |||
| 757 | =item [MaxResults => Int] | ||
| 758 | |||
| 759 | =item [NextToken => Str] | ||
| 760 | |||
| 761 | |||
| 762 | =back | ||
| 763 | |||
| 764 | Each argument is described in detail in: L<Paws::OpsWorksCM::ListTagsForResource> | ||
| 765 | |||
| 766 | Returns: a L<Paws::OpsWorksCM::ListTagsForResourceResponse> instance | ||
| 767 | |||
| 768 | Returns a list of tags that are applied to the specified AWS OpsWorks | ||
| 769 | for Chef Automate or AWS OpsWorks for Puppet Enterprise servers or | ||
| 770 | backups. | ||
| 771 | |||
| 772 | |||
| 773 | =head2 RestoreServer | ||
| 774 | |||
| 775 | =over | ||
| 776 | |||
| 777 | =item BackupId => Str | ||
| 778 | |||
| 779 | =item ServerName => Str | ||
| 780 | |||
| 781 | =item [InstanceType => Str] | ||
| 782 | |||
| 783 | =item [KeyPair => Str] | ||
| 784 | |||
| 785 | |||
| 786 | =back | ||
| 787 | |||
| 788 | Each argument is described in detail in: L<Paws::OpsWorksCM::RestoreServer> | ||
| 789 | |||
| 790 | Returns: a L<Paws::OpsWorksCM::RestoreServerResponse> instance | ||
| 791 | |||
| 792 | Restores a backup to a server that is in a C<CONNECTION_LOST>, | ||
| 793 | C<HEALTHY>, C<RUNNING>, C<UNHEALTHY>, or C<TERMINATED> state. When you | ||
| 794 | run RestoreServer, the server's EC2 instance is deleted, and a new EC2 | ||
| 795 | instance is configured. RestoreServer maintains the existing server | ||
| 796 | endpoint, so configuration management of the server's client devices | ||
| 797 | (nodes) should continue to work. | ||
| 798 | |||
| 799 | Restoring from a backup is performed by creating a new EC2 instance. If | ||
| 800 | restoration is successful, and the server is in a C<HEALTHY> state, AWS | ||
| 801 | OpsWorks CM switches traffic over to the new instance. After | ||
| 802 | restoration is finished, the old EC2 instance is maintained in a | ||
| 803 | C<Running> or C<Stopped> state, but is eventually terminated. | ||
| 804 | |||
| 805 | This operation is asynchronous. | ||
| 806 | |||
| 807 | An C<InvalidStateException> is thrown when the server is not in a valid | ||
| 808 | state. A C<ResourceNotFoundException> is thrown when the server does | ||
| 809 | not exist. A C<ValidationException> is raised when parameters of the | ||
| 810 | request are not valid. | ||
| 811 | |||
| 812 | |||
| 813 | =head2 StartMaintenance | ||
| 814 | |||
| 815 | =over | ||
| 816 | |||
| 817 | =item ServerName => Str | ||
| 818 | |||
| 819 | =item [EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>]] | ||
| 820 | |||
| 821 | |||
| 822 | =back | ||
| 823 | |||
| 824 | Each argument is described in detail in: L<Paws::OpsWorksCM::StartMaintenance> | ||
| 825 | |||
| 826 | Returns: a L<Paws::OpsWorksCM::StartMaintenanceResponse> instance | ||
| 827 | |||
| 828 | Manually starts server maintenance. This command can be useful if an | ||
| 829 | earlier maintenance attempt failed, and the underlying cause of | ||
| 830 | maintenance failure has been resolved. The server is in an | ||
| 831 | C<UNDER_MAINTENANCE> state while maintenance is in progress. | ||
| 832 | |||
| 833 | Maintenance can only be started on servers in C<HEALTHY> and | ||
| 834 | C<UNHEALTHY> states. Otherwise, an C<InvalidStateException> is thrown. | ||
| 835 | A C<ResourceNotFoundException> is thrown when the server does not | ||
| 836 | exist. A C<ValidationException> is raised when parameters of the | ||
| 837 | request are not valid. | ||
| 838 | |||
| 839 | |||
| 840 | =head2 TagResource | ||
| 841 | |||
| 842 | =over | ||
| 843 | |||
| 844 | =item ResourceArn => Str | ||
| 845 | |||
| 846 | =item Tags => ArrayRef[L<Paws::OpsWorksCM::Tag>] | ||
| 847 | |||
| 848 | |||
| 849 | =back | ||
| 850 | |||
| 851 | Each argument is described in detail in: L<Paws::OpsWorksCM::TagResource> | ||
| 852 | |||
| 853 | Returns: a L<Paws::OpsWorksCM::TagResourceResponse> instance | ||
| 854 | |||
| 855 | Applies tags to an AWS OpsWorks for Chef Automate or AWS OpsWorks for | ||
| 856 | Puppet Enterprise server, or to server backups. | ||
| 857 | |||
| 858 | |||
| 859 | =head2 UntagResource | ||
| 860 | |||
| 861 | =over | ||
| 862 | |||
| 863 | =item ResourceArn => Str | ||
| 864 | |||
| 865 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 866 | |||
| 867 | |||
| 868 | =back | ||
| 869 | |||
| 870 | Each argument is described in detail in: L<Paws::OpsWorksCM::UntagResource> | ||
| 871 | |||
| 872 | Returns: a L<Paws::OpsWorksCM::UntagResourceResponse> instance | ||
| 873 | |||
| 874 | Removes specified tags from an AWS OpsWorks-CM server or backup. | ||
| 875 | |||
| 876 | |||
| 877 | =head2 UpdateServer | ||
| 878 | |||
| 879 | =over | ||
| 880 | |||
| 881 | =item ServerName => Str | ||
| 882 | |||
| 883 | =item [BackupRetentionCount => Int] | ||
| 884 | |||
| 885 | =item [DisableAutomatedBackup => Bool] | ||
| 886 | |||
| 887 | =item [PreferredBackupWindow => Str] | ||
| 888 | |||
| 889 | =item [PreferredMaintenanceWindow => Str] | ||
| 890 | |||
| 891 | |||
| 892 | =back | ||
| 893 | |||
| 894 | Each argument is described in detail in: L<Paws::OpsWorksCM::UpdateServer> | ||
| 895 | |||
| 896 | Returns: a L<Paws::OpsWorksCM::UpdateServerResponse> instance | ||
| 897 | |||
| 898 | Updates settings for a server. | ||
| 899 | |||
| 900 | This operation is synchronous. | ||
| 901 | |||
| 902 | |||
| 903 | =head2 UpdateServerEngineAttributes | ||
| 904 | |||
| 905 | =over | ||
| 906 | |||
| 907 | =item AttributeName => Str | ||
| 908 | |||
| 909 | =item ServerName => Str | ||
| 910 | |||
| 911 | =item [AttributeValue => Str] | ||
| 912 | |||
| 913 | |||
| 914 | =back | ||
| 915 | |||
| 916 | Each argument is described in detail in: L<Paws::OpsWorksCM::UpdateServerEngineAttributes> | ||
| 917 | |||
| 918 | Returns: a L<Paws::OpsWorksCM::UpdateServerEngineAttributesResponse> instance | ||
| 919 | |||
| 920 | Updates engine-specific attributes on a specified server. The server | ||
| 921 | enters the C<MODIFYING> state when this operation is in progress. Only | ||
| 922 | one update can occur at a time. You can use this command to reset a | ||
| 923 | Chef server's public key (C<CHEF_PIVOTAL_KEY>) or a Puppet server's | ||
| 924 | admin password (C<PUPPET_ADMIN_PASSWORD>). | ||
| 925 | |||
| 926 | This operation is asynchronous. | ||
| 927 | |||
| 928 | This operation can only be called for servers in C<HEALTHY> or | ||
| 929 | C<UNHEALTHY> states. Otherwise, an C<InvalidStateException> is raised. | ||
| 930 | A C<ResourceNotFoundException> is thrown when the server does not | ||
| 931 | exist. A C<ValidationException> is raised when parameters of the | ||
| 932 | request are not valid. | ||
| 933 | |||
| 934 | |||
| 935 | |||
| 936 | |||
| 937 | =head1 PAGINATORS | ||
| 938 | |||
| 939 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 940 | |||
| 941 | =head2 DescribeAllBackups(sub { },[BackupId => Str, MaxResults => Int, NextToken => Str, ServerName => Str]) | ||
| 942 | |||
| 943 | =head2 DescribeAllBackups([BackupId => Str, MaxResults => Int, NextToken => Str, ServerName => Str]) | ||
| 944 | |||
| 945 | |||
| 946 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 947 | |||
| 948 | - Backups, passing the object as the first parameter, and the string 'Backups' as the second parameter | ||
| 949 | |||
| 950 | If not, it will return a a L<Paws::OpsWorksCM::DescribeBackupsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 951 | |||
| 952 | |||
| 953 | =head2 DescribeAllEvents(sub { },ServerName => Str, [MaxResults => Int, NextToken => Str]) | ||
| 954 | |||
| 955 | =head2 DescribeAllEvents(ServerName => Str, [MaxResults => Int, NextToken => Str]) | ||
| 956 | |||
| 957 | |||
| 958 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 959 | |||
| 960 | - ServerEvents, passing the object as the first parameter, and the string 'ServerEvents' as the second parameter | ||
| 961 | |||
| 962 | If not, it will return a a L<Paws::OpsWorksCM::DescribeEventsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 963 | |||
| 964 | |||
| 965 | =head2 DescribeAllServers(sub { },[MaxResults => Int, NextToken => Str, ServerName => Str]) | ||
| 966 | |||
| 967 | =head2 DescribeAllServers([MaxResults => Int, NextToken => Str, ServerName => Str]) | ||
| 968 | |||
| 969 | |||
| 970 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 971 | |||
| 972 | - Servers, passing the object as the first parameter, and the string 'Servers' as the second parameter | ||
| 973 | |||
| 974 | If not, it will return a a L<Paws::OpsWorksCM::DescribeServersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 975 | |||
| 976 | |||
| 977 | =head2 ListAllTagsForResource(sub { },ResourceArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 978 | |||
| 979 | =head2 ListAllTagsForResource(ResourceArn => Str, [MaxResults => Int, NextToken => Str]) | ||
| 980 | |||
| 981 | |||
| 982 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 983 | |||
| 984 | - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter | ||
| 985 | |||
| 986 | If not, it will return a a L<Paws::OpsWorksCM::ListTagsForResourceResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 987 | |||
| 988 | |||
| 989 | |||
| 990 | |||
| 991 | |||
| 992 | =head1 SEE ALSO | ||
| 993 | |||
| 994 | This service class forms part of L<Paws> | ||
| 995 | |||
| 996 | =head1 BUGS and CONTRIBUTIONS | ||
| 997 | |||
| 998 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 999 | |||
| 1000 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 1001 | |||
| 1002 | =cut | ||
| 1003 |