« blib/lib/Paws/RDS/ModifyDBClusterResult.pm
↑ Summary
blib/lib/Paws/RDS/ModifyDBClusterSnapshotAttributeResult.pm »
| 1 | |||
| 2 | package Paws::RDS::ModifyDBClusterSnapshotAttribute; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ValuesToAdd => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has ValuesToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDBClusterSnapshotAttribute'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::ModifyDBClusterSnapshotAttributeResult'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'ModifyDBClusterSnapshotAttributeResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::RDS::ModifyDBClusterSnapshotAttribute - Arguments for method ModifyDBClusterSnapshotAttribute on L<Paws::RDS> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ModifyDBClusterSnapshotAttribute on the | ||
| 25 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 26 | as arguments to method ModifyDBClusterSnapshotAttribute. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDBClusterSnapshotAttribute. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('RDS'); | ||
| 33 | # To add or remove access to a manual DB cluster snapshot | ||
| 34 | # The following example gives two AWS accounts access to a manual DB cluster | ||
| 35 | # snapshot and ensures that the DB cluster snapshot is private by removing the | ||
| 36 | # value "all". | ||
| 37 | my $ModifyDBClusterSnapshotAttributeResult = | ||
| 38 | $rds->ModifyDBClusterSnapshotAttribute( | ||
| 39 | 'AttributeName' => 'restore', | ||
| 40 | 'DBClusterSnapshotIdentifier' => 'manual-cluster-snapshot1', | ||
| 41 | 'ValuesToAdd' => [ 123451234512, 123456789012 ], | ||
| 42 | 'ValuesToRemove' => ['all'] | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $DBClusterSnapshotAttributesResult = | ||
| 47 | $ModifyDBClusterSnapshotAttributeResult | ||
| 48 | ->DBClusterSnapshotAttributesResult; | ||
| 49 | |||
| 50 | # Returns a L<Paws::RDS::ModifyDBClusterSnapshotAttributeResult> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/ModifyDBClusterSnapshotAttribute> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> AttributeName => Str | ||
| 59 | |||
| 60 | The name of the DB cluster snapshot attribute to modify. | ||
| 61 | |||
| 62 | To manage authorization for other Amazon Web Services accounts to copy | ||
| 63 | or restore a manual DB cluster snapshot, set this value to C<restore>. | ||
| 64 | |||
| 65 | To view the list of attributes available to modify, use the | ||
| 66 | DescribeDBClusterSnapshotAttributes API action. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> DBClusterSnapshotIdentifier => Str | ||
| 71 | |||
| 72 | The identifier for the DB cluster snapshot to modify the attributes | ||
| 73 | for. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 ValuesToAdd => ArrayRef[Str|Undef] | ||
| 78 | |||
| 79 | A list of DB cluster snapshot attributes to add to the attribute | ||
| 80 | specified by C<AttributeName>. | ||
| 81 | |||
| 82 | To authorize other Amazon Web Services accounts to copy or restore a | ||
| 83 | manual DB cluster snapshot, set this list to include one or more Amazon | ||
| 84 | Web Services account IDs, or C<all> to make the manual DB cluster | ||
| 85 | snapshot restorable by any Amazon Web Services account. Do not add the | ||
| 86 | C<all> value for any manual DB cluster snapshots that contain private | ||
| 87 | information that you don't want available to all Amazon Web Services | ||
| 88 | accounts. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 ValuesToRemove => ArrayRef[Str|Undef] | ||
| 93 | |||
| 94 | A list of DB cluster snapshot attributes to remove from the attribute | ||
| 95 | specified by C<AttributeName>. | ||
| 96 | |||
| 97 | To remove authorization for other Amazon Web Services accounts to copy | ||
| 98 | or restore a manual DB cluster snapshot, set this list to include one | ||
| 99 | or more Amazon Web Services account identifiers, or C<all> to remove | ||
| 100 | authorization for any Amazon Web Services account to copy or restore | ||
| 101 | the DB cluster snapshot. If you specify C<all>, an Amazon Web Services | ||
| 102 | account whose account ID is explicitly added to the C<restore> | ||
| 103 | attribute can still copy or restore a manual DB cluster snapshot. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method ModifyDBClusterSnapshotAttribute in L<Paws::RDS> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |