« blib/lib/Paws/RDS/RestoreDBClusterFromSnapshotResult.pm
↑ Summary
blib/lib/Paws/RDS/RestoreDBClusterToPointInTimeResult.pm »
| 1 | |||
| 2 | package Paws::RDS::RestoreDBClusterToPointInTime; | ||
| 3 | use Moose; | ||
| 4 | has BacktrackWindow => (is => 'ro', isa => 'Int'); | ||
| 5 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 6 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 8 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 9 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 10 | has Domain => (is => 'ro', isa => 'Str'); | ||
| 11 | has DomainIAMRoleName => (is => 'ro', isa => 'Str'); | ||
| 12 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 13 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 14 | has EngineMode => (is => 'ro', isa => 'Str'); | ||
| 15 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 16 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 17 | has Port => (is => 'ro', isa => 'Int'); | ||
| 18 | has RestoreToTime => (is => 'ro', isa => 'Str'); | ||
| 19 | has RestoreType => (is => 'ro', isa => 'Str'); | ||
| 20 | has ScalingConfiguration => (is => 'ro', isa => 'Paws::RDS::ScalingConfiguration'); | ||
| 21 | has SourceDBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 22 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RDS::Tag]'); | ||
| 23 | has UseLatestRestorableTime => (is => 'ro', isa => 'Bool'); | ||
| 24 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 25 | |||
| 26 | use MooseX::ClassAttribute; | ||
| 27 | |||
| 28 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTime'); | ||
| 29 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::RestoreDBClusterToPointInTimeResult'); | ||
| 30 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTimeResult'); | ||
| 31 | 1; | ||
| 32 | |||
| 33 | ### main pod documentation begin ### | ||
| 34 | |||
| 35 | =head1 NAME | ||
| 36 | |||
| 37 | Paws::RDS::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on L<Paws::RDS> | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the | ||
| 42 | L<Amazon Relational Database Service|Paws::RDS> service. Use the attributes of this class | ||
| 43 | as arguments to method RestoreDBClusterToPointInTime. | ||
| 44 | |||
| 45 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterToPointInTime. | ||
| 46 | |||
| 47 | =head1 SYNOPSIS | ||
| 48 | |||
| 49 | my $rds = Paws->service('RDS'); | ||
| 50 | # To restore a DB cluster to a point in time. | ||
| 51 | # The following example restores a DB cluster to a new DB cluster at a point in | ||
| 52 | # time from the source DB cluster. | ||
| 53 | my $RestoreDBClusterToPointInTimeResult = | ||
| 54 | $rds->RestoreDBClusterToPointInTime( | ||
| 55 | 'DBClusterIdentifier' => 'sample-restored-cluster1', | ||
| 56 | 'RestoreToTime' => '2016-09-13T18:45:00Z', | ||
| 57 | 'SourceDBClusterIdentifier' => 'sample-cluster1' | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster; | ||
| 62 | |||
| 63 | # Returns a L<Paws::RDS::RestoreDBClusterToPointInTimeResult> object. | ||
| 64 | |||
| 65 | 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. | ||
| 66 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterToPointInTime> | ||
| 67 | |||
| 68 | =head1 ATTRIBUTES | ||
| 69 | |||
| 70 | |||
| 71 | =head2 BacktrackWindow => Int | ||
| 72 | |||
| 73 | The target backtrack window, in seconds. To disable backtracking, set | ||
| 74 | this value to 0. | ||
| 75 | |||
| 76 | Currently, Backtrack is only supported for Aurora MySQL DB clusters. | ||
| 77 | |||
| 78 | Default: 0 | ||
| 79 | |||
| 80 | Constraints: | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | If specified, this value must be set to a number from 0 to 259,200 (72 | ||
| 87 | hours). | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 CopyTagsToSnapshot => Bool | ||
| 95 | |||
| 96 | A value that indicates whether to copy all tags from the restored DB | ||
| 97 | cluster to snapshots of the restored DB cluster. The default is not to | ||
| 98 | copy them. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 103 | |||
| 104 | The name of the new DB cluster to be created. | ||
| 105 | |||
| 106 | Constraints: | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | Must contain from 1 to 63 letters, numbers, or hyphens | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | First character must be a letter | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | Can't end with a hyphen or contain two consecutive hyphens | ||
| 121 | |||
| 122 | =back | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 DBClusterParameterGroupName => Str | ||
| 128 | |||
| 129 | The name of the DB cluster parameter group to associate with this DB | ||
| 130 | cluster. If this argument is omitted, the default DB cluster parameter | ||
| 131 | group for the specified engine is used. | ||
| 132 | |||
| 133 | Constraints: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | If supplied, must match the name of an existing DB cluster parameter | ||
| 140 | group. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | Must be 1 to 255 letters, numbers, or hyphens. | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | First character must be a letter. | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | Can't end with a hyphen or contain two consecutive hyphens. | ||
| 153 | |||
| 154 | =back | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 DBSubnetGroupName => Str | ||
| 160 | |||
| 161 | The DB subnet group name to use for the new DB cluster. | ||
| 162 | |||
| 163 | Constraints: If supplied, must match the name of an existing | ||
| 164 | DBSubnetGroup. | ||
| 165 | |||
| 166 | Example: C<mySubnetgroup> | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 DeletionProtection => Bool | ||
| 171 | |||
| 172 | A value that indicates whether the DB cluster has deletion protection | ||
| 173 | enabled. The database can't be deleted when deletion protection is | ||
| 174 | enabled. By default, deletion protection is disabled. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 Domain => Str | ||
| 179 | |||
| 180 | Specify the Active Directory directory ID to restore the DB cluster in. | ||
| 181 | The domain must be created prior to this operation. | ||
| 182 | |||
| 183 | For Amazon Aurora DB clusters, Amazon RDS can use Kerberos | ||
| 184 | Authentication to authenticate users that connect to the DB cluster. | ||
| 185 | For more information, see Kerberos Authentication | ||
| 186 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) | ||
| 187 | in the I<Amazon Aurora User Guide>. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 DomainIAMRoleName => Str | ||
| 192 | |||
| 193 | Specify the name of the IAM role to be used when making API calls to | ||
| 194 | the Directory Service. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 199 | |||
| 200 | The list of logs that the restored DB cluster is to export to | ||
| 201 | CloudWatch Logs. The values in the list depend on the DB engine being | ||
| 202 | used. For more information, see Publishing Database Logs to Amazon | ||
| 203 | CloudWatch Logs | ||
| 204 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) | ||
| 205 | in the I<Amazon Aurora User Guide>. | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 210 | |||
| 211 | A value that indicates whether to enable mapping of Amazon Web Services | ||
| 212 | Identity and Access Management (IAM) accounts to database accounts. By | ||
| 213 | default, mapping is disabled. | ||
| 214 | |||
| 215 | For more information, see IAM Database Authentication | ||
| 216 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) | ||
| 217 | in the I<Amazon Aurora User Guide.> | ||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head2 EngineMode => Str | ||
| 222 | |||
| 223 | The engine mode of the new cluster. Specify C<provisioned> or | ||
| 224 | C<serverless>, depending on the type of the cluster you are creating. | ||
| 225 | You can create an Aurora Serverless clone from a provisioned cluster, | ||
| 226 | or a provisioned clone from an Aurora Serverless cluster. To create a | ||
| 227 | clone that is an Aurora Serverless cluster, the original cluster must | ||
| 228 | be an Aurora Serverless cluster or an encrypted provisioned cluster. | ||
| 229 | |||
| 230 | |||
| 231 | |||
| 232 | =head2 KmsKeyId => Str | ||
| 233 | |||
| 234 | The Amazon Web Services KMS key identifier to use when restoring an | ||
| 235 | encrypted DB cluster from an encrypted DB cluster. | ||
| 236 | |||
| 237 | The Amazon Web Services KMS key identifier is the key ARN, key ID, | ||
| 238 | alias ARN, or alias name for the Amazon Web Services KMS customer | ||
| 239 | master key (CMK). To use a CMK in a different Amazon Web Services | ||
| 240 | account, specify the key ARN or alias ARN. | ||
| 241 | |||
| 242 | You can restore to a new DB cluster and encrypt the new DB cluster with | ||
| 243 | a Amazon Web Services KMS CMK that is different than the Amazon Web | ||
| 244 | Services KMS key used to encrypt the source DB cluster. The new DB | ||
| 245 | cluster is encrypted with the Amazon Web Services KMS CMK identified by | ||
| 246 | the C<KmsKeyId> parameter. | ||
| 247 | |||
| 248 | If you don't specify a value for the C<KmsKeyId> parameter, then the | ||
| 249 | following occurs: | ||
| 250 | |||
| 251 | =over | ||
| 252 | |||
| 253 | =item * | ||
| 254 | |||
| 255 | If the DB cluster is encrypted, then the restored DB cluster is | ||
| 256 | encrypted using the Amazon Web Services KMS CMK that was used to | ||
| 257 | encrypt the source DB cluster. | ||
| 258 | |||
| 259 | =item * | ||
| 260 | |||
| 261 | If the DB cluster isn't encrypted, then the restored DB cluster isn't | ||
| 262 | encrypted. | ||
| 263 | |||
| 264 | =back | ||
| 265 | |||
| 266 | If C<DBClusterIdentifier> refers to a DB cluster that isn't encrypted, | ||
| 267 | then the restore request is rejected. | ||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | =head2 OptionGroupName => Str | ||
| 272 | |||
| 273 | The name of the option group for the new DB cluster. | ||
| 274 | |||
| 275 | |||
| 276 | |||
| 277 | =head2 Port => Int | ||
| 278 | |||
| 279 | The port number on which the new DB cluster accepts connections. | ||
| 280 | |||
| 281 | Constraints: A value from C<1150-65535>. | ||
| 282 | |||
| 283 | Default: The default port for the engine. | ||
| 284 | |||
| 285 | |||
| 286 | |||
| 287 | =head2 RestoreToTime => Str | ||
| 288 | |||
| 289 | The date and time to restore the DB cluster to. | ||
| 290 | |||
| 291 | Valid Values: Value must be a time in Universal Coordinated Time (UTC) | ||
| 292 | format | ||
| 293 | |||
| 294 | Constraints: | ||
| 295 | |||
| 296 | =over | ||
| 297 | |||
| 298 | =item * | ||
| 299 | |||
| 300 | Must be before the latest restorable time for the DB instance | ||
| 301 | |||
| 302 | =item * | ||
| 303 | |||
| 304 | Must be specified if C<UseLatestRestorableTime> parameter isn't | ||
| 305 | provided | ||
| 306 | |||
| 307 | =item * | ||
| 308 | |||
| 309 | Can't be specified if the C<UseLatestRestorableTime> parameter is | ||
| 310 | enabled | ||
| 311 | |||
| 312 | =item * | ||
| 313 | |||
| 314 | Can't be specified if the C<RestoreType> parameter is C<copy-on-write> | ||
| 315 | |||
| 316 | =back | ||
| 317 | |||
| 318 | Example: C<2015-03-07T23:45:00Z> | ||
| 319 | |||
| 320 | |||
| 321 | |||
| 322 | =head2 RestoreType => Str | ||
| 323 | |||
| 324 | The type of restore to be performed. You can specify one of the | ||
| 325 | following values: | ||
| 326 | |||
| 327 | =over | ||
| 328 | |||
| 329 | =item * | ||
| 330 | |||
| 331 | C<full-copy> - The new DB cluster is restored as a full copy of the | ||
| 332 | source DB cluster. | ||
| 333 | |||
| 334 | =item * | ||
| 335 | |||
| 336 | C<copy-on-write> - The new DB cluster is restored as a clone of the | ||
| 337 | source DB cluster. | ||
| 338 | |||
| 339 | =back | ||
| 340 | |||
| 341 | Constraints: You can't specify C<copy-on-write> if the engine version | ||
| 342 | of the source DB cluster is earlier than 1.11. | ||
| 343 | |||
| 344 | If you don't specify a C<RestoreType> value, then the new DB cluster is | ||
| 345 | restored as a full copy of the source DB cluster. | ||
| 346 | |||
| 347 | |||
| 348 | |||
| 349 | =head2 ScalingConfiguration => L<Paws::RDS::ScalingConfiguration> | ||
| 350 | |||
| 351 | For DB clusters in C<serverless> DB engine mode, the scaling properties | ||
| 352 | of the DB cluster. | ||
| 353 | |||
| 354 | |||
| 355 | |||
| 356 | =head2 B<REQUIRED> SourceDBClusterIdentifier => Str | ||
| 357 | |||
| 358 | The identifier of the source DB cluster from which to restore. | ||
| 359 | |||
| 360 | Constraints: | ||
| 361 | |||
| 362 | =over | ||
| 363 | |||
| 364 | =item * | ||
| 365 | |||
| 366 | Must match the identifier of an existing DBCluster. | ||
| 367 | |||
| 368 | =back | ||
| 369 | |||
| 370 | |||
| 371 | |||
| 372 | |||
| 373 | =head2 Tags => ArrayRef[L<Paws::RDS::Tag>] | ||
| 374 | |||
| 375 | |||
| 376 | |||
| 377 | |||
| 378 | |||
| 379 | =head2 UseLatestRestorableTime => Bool | ||
| 380 | |||
| 381 | A value that indicates whether to restore the DB cluster to the latest | ||
| 382 | restorable backup time. By default, the DB cluster isn't restored to | ||
| 383 | the latest restorable backup time. | ||
| 384 | |||
| 385 | Constraints: Can't be specified if C<RestoreToTime> parameter is | ||
| 386 | provided. | ||
| 387 | |||
| 388 | |||
| 389 | |||
| 390 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 391 | |||
| 392 | A list of VPC security groups that the new DB cluster belongs to. | ||
| 393 | |||
| 394 | |||
| 395 | |||
| 396 | |||
| 397 | =head1 SEE ALSO | ||
| 398 | |||
| 399 | This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterToPointInTime in L<Paws::RDS> | ||
| 400 | |||
| 401 | =head1 BUGS and CONTRIBUTIONS | ||
| 402 | |||
| 403 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 404 | |||
| 405 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 406 | |||
| 407 | =cut | ||
| 408 |