« blib/lib/Paws/RDS/AddTagsToResource.pm
↑ Summary
blib/lib/Paws/RDS/ApplyPendingMaintenanceActionResult.pm »
| 1 | |||
| 2 | package Paws::RDS::ApplyPendingMaintenanceAction; | ||
| 3 | use Moose; | ||
| 4 | has ApplyAction => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has OptInType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ResourceIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ApplyPendingMaintenanceAction'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ApplyPendingMaintenanceActionResult'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ApplyPendingMaintenanceActionResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::RDS::ApplyPendingMaintenanceAction - Arguments for method ApplyPendingMaintenanceAction on L<Paws::RDS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ApplyPendingMaintenanceAction on the | ||
| 24 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 25 | as arguments to method ApplyPendingMaintenanceAction. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ApplyPendingMaintenanceAction. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $rds = Paws->service('RDS'); | ||
| 32 | # To apply a pending maintenance action | ||
| 33 | # This example immediately applies a pending system update to a DB instance. | ||
| 34 | my $ApplyPendingMaintenanceActionResult = | ||
| 35 | $rds->ApplyPendingMaintenanceAction( | ||
| 36 | 'ApplyAction' => 'system-update', | ||
| 37 | 'OptInType' => 'immediate', | ||
| 38 | 'ResourceIdentifier' => | ||
| 39 | 'arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance' | ||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $ResourcePendingMaintenanceActions = | ||
| 44 | $ApplyPendingMaintenanceActionResult->ResourcePendingMaintenanceActions; | ||
| 45 | |||
| 46 | # Returns a L<Paws::RDS::ApplyPendingMaintenanceActionResult> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ApplyPendingMaintenanceAction> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> ApplyAction => Str | ||
| 55 | |||
| 56 | The pending maintenance action to apply to this resource. | ||
| 57 | |||
| 58 | Valid values: C<system-update>, C<db-upgrade>, C<hardware-maintenance>, | ||
| 59 | C<ca-certificate-rotation> | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> OptInType => Str | ||
| 64 | |||
| 65 | A value that specifies the type of opt-in request, or undoes an opt-in | ||
| 66 | request. An opt-in request of type C<immediate> can't be undone. | ||
| 67 | |||
| 68 | Valid values: | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<immediate> - Apply the maintenance action immediately. | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<next-maintenance> - Apply the maintenance action during the next | ||
| 79 | maintenance window for the resource. | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<undo-opt-in> - Cancel any existing C<next-maintenance> opt-in | ||
| 84 | requests. | ||
| 85 | |||
| 86 | =back | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> ResourceIdentifier => Str | ||
| 92 | |||
| 93 | The RDS Amazon Resource Name (ARN) of the resource that the pending | ||
| 94 | maintenance action applies to. For information about creating an ARN, | ||
| 95 | see Constructing an RDS Amazon Resource Name (ARN) | ||
| 96 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing). | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method ApplyPendingMaintenanceAction in L<Paws::RDS> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |