« blib/lib/Paws/Neptune/CopyDBClusterParameterGroupResult.pm
↑ Summary
blib/lib/Paws/Neptune/CopyDBClusterSnapshotResult.pm »
| 1 | |||
| 2 | package Paws::Neptune::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::Neptune::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::Neptune::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::Neptune::CopyDBClusterSnapshot - Arguments for method CopyDBClusterSnapshot on L<Paws::Neptune> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CopyDBClusterSnapshot on the | ||
| 27 | L<Amazon Neptune|Paws::Neptune> 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('Neptune'); | ||
| 35 | my $CopyDBClusterSnapshotResult = $rds->CopyDBClusterSnapshot( | ||
| 36 | SourceDBClusterSnapshotIdentifier => 'MyString', | ||
| 37 | TargetDBClusterSnapshotIdentifier => 'MyString', | ||
| 38 | CopyTags => 1, # OPTIONAL | ||
| 39 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 40 | PreSignedUrl => 'MyString', # OPTIONAL | ||
| 41 | Tags => [ | ||
| 42 | { | ||
| 43 | Key => 'MyString', | ||
| 44 | Value => 'MyString', | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $DBClusterSnapshot = $CopyDBClusterSnapshotResult->DBClusterSnapshot; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Neptune::CopyDBClusterSnapshotResult> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CopyDBClusterSnapshot> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CopyTags => Bool | ||
| 62 | |||
| 63 | True to copy all tags from the source DB cluster snapshot to the target | ||
| 64 | DB cluster snapshot, and otherwise false. The default is false. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 KmsKeyId => Str | ||
| 69 | |||
| 70 | The Amazon Amazon KMS key ID for an encrypted DB cluster snapshot. The | ||
| 71 | KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or | ||
| 72 | the KMS key alias for the KMS encryption key. | ||
| 73 | |||
| 74 | If you copy an encrypted DB cluster snapshot from your Amazon account, | ||
| 75 | you can specify a value for C<KmsKeyId> to encrypt the copy with a new | ||
| 76 | KMS encryption key. If you don't specify a value for C<KmsKeyId>, then | ||
| 77 | the copy of the DB cluster snapshot is encrypted with the same KMS key | ||
| 78 | as the source DB cluster snapshot. | ||
| 79 | |||
| 80 | If you copy an encrypted DB cluster snapshot that is shared from | ||
| 81 | another Amazon account, then you must specify a value for C<KmsKeyId>. | ||
| 82 | |||
| 83 | KMS encryption keys are specific to the Amazon Region that they are | ||
| 84 | created in, and you can't use encryption keys from one Amazon Region in | ||
| 85 | another Amazon Region. | ||
| 86 | |||
| 87 | You cannot encrypt an unencrypted DB cluster snapshot when you copy it. | ||
| 88 | If you try to copy an unencrypted DB cluster snapshot and specify a | ||
| 89 | value for the KmsKeyId parameter, an error is returned. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 PreSignedUrl => Str | ||
| 94 | |||
| 95 | Not currently supported. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> SourceDBClusterSnapshotIdentifier => Str | ||
| 100 | |||
| 101 | The identifier of the DB cluster snapshot to copy. This parameter is | ||
| 102 | not case-sensitive. | ||
| 103 | |||
| 104 | Constraints: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Must specify a valid system snapshot in the "available" state. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | Specify a valid DB snapshot identifier. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | Example: C<my-cluster-snapshot1> | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>] | ||
| 123 | |||
| 124 | The tags to assign to the new DB cluster snapshot copy. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 B<REQUIRED> TargetDBClusterSnapshotIdentifier => Str | ||
| 129 | |||
| 130 | The identifier of the new DB cluster snapshot to create from the source | ||
| 131 | DB cluster snapshot. This parameter is not case-sensitive. | ||
| 132 | |||
| 133 | Constraints: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | First character must be a letter. | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 148 | |||
| 149 | =back | ||
| 150 | |||
| 151 | Example: C<my-cluster-snapshot2> | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, documenting arguments for method CopyDBClusterSnapshot in L<Paws::Neptune> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |