« blib/lib/Paws/DocDB/RestoreDBClusterFromSnapshotResult.pm
↑ Summary
blib/lib/Paws/DocDB/RestoreDBClusterToPointInTimeResult.pm »
| 1 | |||
| 2 | package Paws::DocDB::RestoreDBClusterToPointInTime; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 6 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 7 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 9 | has Port => (is => 'ro', isa => 'Int'); | ||
| 10 | has RestoreToTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has SourceDBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Tag]'); | ||
| 13 | has UseLatestRestorableTime => (is => 'ro', isa => 'Bool'); | ||
| 14 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTime'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::RestoreDBClusterToPointInTimeResult'); | ||
| 20 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTimeResult'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::DocDB::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on L<Paws::DocDB> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the | ||
| 32 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 33 | as arguments to method RestoreDBClusterToPointInTime. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterToPointInTime. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $rds = Paws->service('DocDB'); | ||
| 40 | my $RestoreDBClusterToPointInTimeResult = | ||
| 41 | $rds->RestoreDBClusterToPointInTime( | ||
| 42 | DBClusterIdentifier => 'MyString', | ||
| 43 | SourceDBClusterIdentifier => 'MyString', | ||
| 44 | DBSubnetGroupName => 'MyString', # OPTIONAL | ||
| 45 | DeletionProtection => 1, # OPTIONAL | ||
| 46 | EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL | ||
| 47 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 48 | Port => 1, # OPTIONAL | ||
| 49 | RestoreToTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 50 | Tags => [ | ||
| 51 | { | ||
| 52 | Key => 'MyString', | ||
| 53 | Value => 'MyString', | ||
| 54 | }, | ||
| 55 | ... | ||
| 56 | ], # OPTIONAL | ||
| 57 | UseLatestRestorableTime => 1, # OPTIONAL | ||
| 58 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 59 | ); | ||
| 60 | |||
| 61 | # Results: | ||
| 62 | my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster; | ||
| 63 | |||
| 64 | # Returns a L<Paws::DocDB::RestoreDBClusterToPointInTimeResult> object. | ||
| 65 | |||
| 66 | 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. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterToPointInTime> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 73 | |||
| 74 | The name of the new cluster to be created. | ||
| 75 | |||
| 76 | Constraints: | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | The first character must be a letter. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 DBSubnetGroupName => Str | ||
| 98 | |||
| 99 | The subnet group name to use for the new cluster. | ||
| 100 | |||
| 101 | Constraints: If provided, must match the name of an existing | ||
| 102 | C<DBSubnetGroup>. | ||
| 103 | |||
| 104 | Example: C<mySubnetgroup> | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 DeletionProtection => Bool | ||
| 109 | |||
| 110 | Specifies whether this cluster can be deleted. If C<DeletionProtection> | ||
| 111 | is enabled, the cluster cannot be deleted unless it is modified and | ||
| 112 | C<DeletionProtection> is disabled. C<DeletionProtection> protects | ||
| 113 | clusters from being accidentally deleted. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 118 | |||
| 119 | A list of log types that must be enabled for exporting to Amazon | ||
| 120 | CloudWatch Logs. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 KmsKeyId => Str | ||
| 125 | |||
| 126 | The KMS key identifier to use when restoring an encrypted cluster from | ||
| 127 | an encrypted cluster. | ||
| 128 | |||
| 129 | The KMS key identifier is the Amazon Resource Name (ARN) for the KMS | ||
| 130 | encryption key. If you are restoring a cluster with the same account | ||
| 131 | that owns the KMS encryption key used to encrypt the new cluster, then | ||
| 132 | you can use the KMS key alias instead of the ARN for the KMS encryption | ||
| 133 | key. | ||
| 134 | |||
| 135 | You can restore to a new cluster and encrypt the new cluster with an | ||
| 136 | KMS key that is different from the KMS key used to encrypt the source | ||
| 137 | cluster. The new DB cluster is encrypted with the KMS key identified by | ||
| 138 | the C<KmsKeyId> parameter. | ||
| 139 | |||
| 140 | If you do not specify a value for the C<KmsKeyId> parameter, then the | ||
| 141 | following occurs: | ||
| 142 | |||
| 143 | =over | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | If the cluster is encrypted, then the restored cluster is encrypted | ||
| 148 | using the KMS key that was used to encrypt the source cluster. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | If the cluster is not encrypted, then the restored cluster is not | ||
| 153 | encrypted. | ||
| 154 | |||
| 155 | =back | ||
| 156 | |||
| 157 | If C<DBClusterIdentifier> refers to a cluster that is not encrypted, | ||
| 158 | then the restore request is rejected. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 Port => Int | ||
| 163 | |||
| 164 | The port number on which the new cluster accepts connections. | ||
| 165 | |||
| 166 | Constraints: Must be a value from C<1150> to C<65535>. | ||
| 167 | |||
| 168 | Default: The default port for the engine. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 RestoreToTime => Str | ||
| 173 | |||
| 174 | The date and time to restore the cluster to. | ||
| 175 | |||
| 176 | Valid values: A time in Universal Coordinated Time (UTC) format. | ||
| 177 | |||
| 178 | Constraints: | ||
| 179 | |||
| 180 | =over | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | Must be before the latest restorable time for the instance. | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | Must be specified if the C<UseLatestRestorableTime> parameter is not | ||
| 189 | provided. | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | Cannot be specified if the C<UseLatestRestorableTime> parameter is | ||
| 194 | C<true>. | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | Cannot be specified if the C<RestoreType> parameter is | ||
| 199 | C<copy-on-write>. | ||
| 200 | |||
| 201 | =back | ||
| 202 | |||
| 203 | Example: C<2015-03-07T23:45:00Z> | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 B<REQUIRED> SourceDBClusterIdentifier => Str | ||
| 208 | |||
| 209 | The identifier of the source cluster from which to restore. | ||
| 210 | |||
| 211 | Constraints: | ||
| 212 | |||
| 213 | =over | ||
| 214 | |||
| 215 | =item * | ||
| 216 | |||
| 217 | Must match the identifier of an existing C<DBCluster>. | ||
| 218 | |||
| 219 | =back | ||
| 220 | |||
| 221 | |||
| 222 | |||
| 223 | |||
| 224 | =head2 Tags => ArrayRef[L<Paws::DocDB::Tag>] | ||
| 225 | |||
| 226 | The tags to be assigned to the restored cluster. | ||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | =head2 UseLatestRestorableTime => Bool | ||
| 231 | |||
| 232 | A value that is set to C<true> to restore the cluster to the latest | ||
| 233 | restorable backup time, and C<false> otherwise. | ||
| 234 | |||
| 235 | Default: C<false> | ||
| 236 | |||
| 237 | Constraints: Cannot be specified if the C<RestoreToTime> parameter is | ||
| 238 | provided. | ||
| 239 | |||
| 240 | |||
| 241 | |||
| 242 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 243 | |||
| 244 | A list of VPC security groups that the new cluster belongs to. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | |||
| 249 | =head1 SEE ALSO | ||
| 250 | |||
| 251 | This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterToPointInTime in L<Paws::DocDB> | ||
| 252 | |||
| 253 | =head1 BUGS and CONTRIBUTIONS | ||
| 254 | |||
| 255 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 256 | |||
| 257 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 258 | |||
| 259 | =cut | ||
| 260 |