« blib/lib/Paws/OpsWorksCM/ServerEvent.pm
↑ Summary
blib/lib/Paws/OpsWorksCM/StartMaintenanceResponse.pm »
| 1 | |||
| 2 | package Paws::OpsWorksCM::StartMaintenance; | ||
| 3 | use Moose; | ||
| 4 | has EngineAttributes => (is => 'ro', isa => 'ArrayRef[Paws::OpsWorksCM::EngineAttribute]'); | ||
| 5 | has ServerName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartMaintenance'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::OpsWorksCM::StartMaintenanceResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::OpsWorksCM::StartMaintenance - Arguments for method StartMaintenance on L<Paws::OpsWorksCM> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method StartMaintenance on the | ||
| 23 | L<AWS OpsWorks CM|Paws::OpsWorksCM> service. Use the attributes of this class | ||
| 24 | as arguments to method StartMaintenance. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartMaintenance. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $opsworks-cm = Paws->service('OpsWorksCM'); | ||
| 31 | my $StartMaintenanceResponse = $opsworks -cm->StartMaintenance( | ||
| 32 | ServerName => 'MyServerName', | ||
| 33 | EngineAttributes => [ | ||
| 34 | { | ||
| 35 | Name => 'MyEngineAttributeName', # max: 10000; OPTIONAL | ||
| 36 | Value => 'MyEngineAttributeValue', # max: 10000; OPTIONAL | ||
| 37 | }, | ||
| 38 | ... | ||
| 39 | ], # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $Server = $StartMaintenanceResponse->Server; | ||
| 44 | |||
| 45 | # Returns a L<Paws::OpsWorksCM::StartMaintenanceResponse> object. | ||
| 46 | |||
| 47 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_StartMaintenance.html> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 EngineAttributes => ArrayRef[L<Paws::OpsWorksCM::EngineAttribute>] | ||
| 54 | |||
| 55 | Engine attributes that are specific to the server on which you want to | ||
| 56 | run maintenance. | ||
| 57 | |||
| 58 | B<Attributes accepted in a StartMaintenance request for Chef> | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | C<CHEF_MAJOR_UPGRADE>: If a Chef Automate server is eligible for | ||
| 65 | upgrade to Chef Automate 2, add this engine attribute to a | ||
| 66 | C<StartMaintenance> request and set the value to C<true> to upgrade the | ||
| 67 | server to Chef Automate 2. For more information, see Upgrade an AWS | ||
| 68 | OpsWorks for Chef Automate Server to Chef Automate 2 | ||
| 69 | (https://docs.aws.amazon.com/opsworks/latest/userguide/opscm-a2upgrade.html). | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> ServerName => Str | ||
| 77 | |||
| 78 | The name of the server on which to run maintenance. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method StartMaintenance in L<Paws::OpsWorksCM> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |