« blib/lib/Paws/RDS/CopyDBClusterParameterGroupResult.pm
↑ Summary
blib/lib/Paws/RDS/CopyDBClusterSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::RDS::CopyDBClusterSnapshot; | ||
| 3 | use Moose; | ||
| 4 | has CopyTags => (is => 'ro', isa => 'Bool'); | ||
| 5 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 6 | has PreSignedUrl => (is => 'ro', isa => 'Str'); | ||
| 7 | has SourceDBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 9 | has TargetDBClusterSnapshotIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyDBClusterSnapshot'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::CopyDBClusterSnapshotResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CopyDBClusterSnapshotResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::RDS::CopyDBClusterSnapshot - Arguments for method CopyDBClusterSnapshot on L<Paws::RDS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CopyDBClusterSnapshot on the | ||
| 27 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 28 | as arguments to method CopyDBClusterSnapshot. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyDBClusterSnapshot. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $rds = Paws->service('RDS'); | ||
| 35 | # To copy a DB cluster snapshot | ||
| 36 | # The following example copies an automated snapshot of a DB cluster to a new DB | ||
| 37 | # cluster snapshot. | ||
| 38 | my $CopyDBClusterSnapshotResult = $rds->CopyDBClusterSnapshot( | ||
| 39 | 'SourceDBClusterSnapshotIdentifier' => | ||
| 40 | 'rds:sample-cluster-2016-09-14-10-38', | ||
| 41 | 'TargetDBClusterSnapshotIdentifier' => 'cluster-snapshot-copy-1' | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $DBClusterSnapshot = $CopyDBClusterSnapshotResult->DBClusterSnapshot; | ||
| 46 | |||
| 47 | # Returns a L<Paws::RDS::CopyDBClusterSnapshotResult> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CopyDBClusterSnapshot> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CopyTags => Bool | ||
| 56 | |||
| 57 | A value that indicates whether to copy all tags from the source DB | ||
| 58 | cluster snapshot to the target DB cluster snapshot. By default, tags | ||
| 59 | are not copied. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 KmsKeyId => Str | ||
| 64 | |||
| 65 | The Amazon Web Services KMS key identifier for an encrypted DB cluster | ||
| 66 | snapshot. The Amazon Web Services KMS key identifier is the key ARN, | ||
| 67 | key ID, alias ARN, or alias name for the Amazon Web Services KMS | ||
| 68 | customer master key (CMK). | ||
| 69 | |||
| 70 | If you copy an encrypted DB cluster snapshot from your Amazon Web | ||
| 71 | Services account, you can specify a value for C<KmsKeyId> to encrypt | ||
| 72 | the copy with a new Amazon Web Services KMS CMK. If you don't specify a | ||
| 73 | value for C<KmsKeyId>, then the copy of the DB cluster snapshot is | ||
| 74 | encrypted with the same Amazon Web Services KMS key as the source DB | ||
| 75 | cluster snapshot. | ||
| 76 | |||
| 77 | If you copy an encrypted DB cluster snapshot that is shared from | ||
| 78 | another Amazon Web Services account, then you must specify a value for | ||
| 79 | C<KmsKeyId>. | ||
| 80 | |||
| 81 | To copy an encrypted DB cluster snapshot to another Amazon Web Services | ||
| 82 | Region, you must set C<KmsKeyId> to the Amazon Web Services KMS key | ||
| 83 | identifier you want to use to encrypt the copy of the DB cluster | ||
| 84 | snapshot in the destination Amazon Web Services Region. Amazon Web | ||
| 85 | Services KMS CMKs are specific to the Amazon Web Services Region that | ||
| 86 | they are created in, and you can't use CMKs from one Amazon Web | ||
| 87 | Services Region in another Amazon Web Services Region. | ||
| 88 | |||
| 89 | If you copy an unencrypted DB cluster snapshot and specify a value for | ||
| 90 | the C<KmsKeyId> parameter, an error is returned. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 PreSignedUrl => Str | ||
| 95 | |||
| 96 | The URL that contains a Signature Version 4 signed request for the | ||
| 97 | C<CopyDBClusterSnapshot> API action in the Amazon Web Services Region | ||
| 98 | that contains the source DB cluster snapshot to copy. The | ||
| 99 | C<PreSignedUrl> parameter must be used when copying an encrypted DB | ||
| 100 | cluster snapshot from another Amazon Web Services Region. Don't specify | ||
| 101 | C<PreSignedUrl> when you are copying an encrypted DB cluster snapshot | ||
| 102 | in the same Amazon Web Services Region. | ||
| 103 | |||
| 104 | The pre-signed URL must be a valid request for the | ||
| 105 | C<CopyDBClusterSnapshot> API action that can be executed in the source | ||
| 106 | Amazon Web Services Region that contains the encrypted DB cluster | ||
| 107 | snapshot to be copied. The pre-signed URL request must contain the | ||
| 108 | following parameter values: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<KmsKeyId> - The Amazon Web Services KMS key identifier for the | ||
| 115 | customer master key (CMK) to use to encrypt the copy of the DB cluster | ||
| 116 | snapshot in the destination Amazon Web Services Region. This is the | ||
| 117 | same identifier for both the C<CopyDBClusterSnapshot> action that is | ||
| 118 | called in the destination Amazon Web Services Region, and the action | ||
| 119 | contained in the pre-signed URL. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<DestinationRegion> - The name of the Amazon Web Services Region that | ||
| 124 | the DB cluster snapshot is to be created in. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | C<SourceDBClusterSnapshotIdentifier> - The DB cluster snapshot | ||
| 129 | identifier for the encrypted DB cluster snapshot to be copied. This | ||
| 130 | identifier must be in the Amazon Resource Name (ARN) format for the | ||
| 131 | source Amazon Web Services Region. For example, if you are copying an | ||
| 132 | encrypted DB cluster snapshot from the us-west-2 Amazon Web Services | ||
| 133 | Region, then your C<SourceDBClusterSnapshotIdentifier> looks like the | ||
| 134 | following example: | ||
| 135 | C<arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115>. | ||
| 136 | |||
| 137 | =back | ||
| 138 | |||
| 139 | To learn how to generate a Signature Version 4 signed request, see | ||
| 140 | Authenticating Requests: Using Query Parameters (Amazon Web Services | ||
| 141 | Signature Version 4) | ||
| 142 | (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) | ||
| 143 | and Signature Version 4 Signing Process | ||
| 144 | (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html). | ||
| 145 | |||
| 146 | If you are using an Amazon Web Services SDK tool or the CLI, you can | ||
| 147 | specify C<SourceRegion> (or C<--source-region> for the CLI) instead of | ||
| 148 | specifying C<PreSignedUrl> manually. Specifying C<SourceRegion> | ||
| 149 | autogenerates a pre-signed URL that is a valid request for the | ||
| 150 | operation that can be executed in the source Amazon Web Services | ||
| 151 | Region. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 B<REQUIRED> SourceDBClusterSnapshotIdentifier => Str | ||
| 156 | |||
| 157 | The identifier of the DB cluster snapshot to copy. This parameter isn't | ||
| 158 | case-sensitive. | ||
| 159 | |||
| 160 | You can't copy an encrypted, shared DB cluster snapshot from one Amazon | ||
| 161 | Web Services Region to another. | ||
| 162 | |||
| 163 | Constraints: | ||
| 164 | |||
| 165 | =over | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | Must specify a valid system snapshot in the "available" state. | ||
| 170 | |||
| 171 | =item * | ||
| 172 | |||
| 173 | If the source snapshot is in the same Amazon Web Services Region as the | ||
| 174 | copy, specify a valid DB snapshot identifier. | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | If the source snapshot is in a different Amazon Web Services Region | ||
| 179 | than the copy, specify a valid DB cluster snapshot ARN. For more | ||
| 180 | information, go to Copying Snapshots Across Amazon Web Services Regions | ||
| 181 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html#USER_CopySnapshot.AcrossRegions) | ||
| 182 | in the I<Amazon Aurora User Guide.> | ||
| 183 | |||
| 184 | =back | ||
| 185 | |||
| 186 | Example: C<my-cluster-snapshot1> | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head2 B<REQUIRED> TargetDBClusterSnapshotIdentifier => Str | ||
| 197 | |||
| 198 | The identifier of the new DB cluster snapshot to create from the source | ||
| 199 | DB cluster snapshot. This parameter isn't case-sensitive. | ||
| 200 | |||
| 201 | Constraints: | ||
| 202 | |||
| 203 | =over | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 208 | |||
| 209 | =item * | ||
| 210 | |||
| 211 | First character must be a letter. | ||
| 212 | |||
| 213 | =item * | ||
| 214 | |||
| 215 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 216 | |||
| 217 | =back | ||
| 218 | |||
| 219 | Example: C<my-cluster-snapshot2> | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | |||
| 224 | =head1 SEE ALSO | ||
| 225 | |||
| 226 | This class forms part of L<Paws>, documenting arguments for method CopyDBClusterSnapshot in L<Paws::RDS> | ||
| 227 | |||
| 228 | =head1 BUGS and CONTRIBUTIONS | ||
| 229 | |||
| 230 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 231 | |||
| 232 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 233 | |||
| 234 | =cut | ||
| 235 |