GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::RDS::RestoreDBClusterToPointInTime(3) User Contributed Perl Documentation Paws::RDS::RestoreDBClusterToPointInTime(3)

Paws::RDS::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on Paws::RDS

This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method RestoreDBClusterToPointInTime.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterToPointInTime.

    my $rds = Paws->service('RDS');
 # To restore a DB cluster to a point in time.
 # The following example restores a DB cluster to a new DB cluster at a point in
 # time from the source DB cluster.
    my $RestoreDBClusterToPointInTimeResult =
      $rds->RestoreDBClusterToPointInTime(
      'DBClusterIdentifier'       => 'sample-restored-cluster1',
      'RestoreToTime'             => '2016-09-13T18:45:00Z',
      'SourceDBClusterIdentifier' => 'sample-cluster1'
      );
    # Results:
    my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster;
    # Returns a L<Paws::RDS::RestoreDBClusterToPointInTimeResult> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterToPointInTime>

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

•
If specified, this value must be set to a number from 0 to 259,200 (72 hours).

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

REQUIRED DBClusterIdentifier => Str

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens
  • First character must be a letter
  • Can't end with a hyphen or contain two consecutive hyphens

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing DB cluster parameter group.
  • Must be 1 to 255 letters, numbers, or hyphens.
  • First character must be a letter.
  • Can't end with a hyphen or contain two consecutive hyphens.

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: "mySubnetgroup"

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the Amazon Aurora User Guide.

Specify the name of the IAM role to be used when making API calls to the Directory Service.

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the Amazon Aurora User Guide.

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the Amazon Aurora User Guide.

The engine mode of the new cluster. Specify "provisioned" or "serverless", depending on the type of the cluster you are creating. You can create an Aurora Serverless clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless cluster. To create a clone that is an Aurora Serverless cluster, the original cluster must be an Aurora Serverless cluster or an encrypted provisioned cluster.

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK identified by the "KmsKeyId" parameter.

If you don't specify a value for the "KmsKeyId" parameter, then the following occurs:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the Amazon Web Services KMS CMK that was used to encrypt the source DB cluster.
  • If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

If "DBClusterIdentifier" refers to a DB cluster that isn't encrypted, then the restore request is rejected.

The name of the option group for the new DB cluster.

The port number on which the new DB cluster accepts connections.

Constraints: A value from "1150-65535".

Default: The default port for the engine.

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance
  • Must be specified if "UseLatestRestorableTime" parameter isn't provided
  • Can't be specified if the "UseLatestRestorableTime" parameter is enabled
  • Can't be specified if the "RestoreType" parameter is "copy-on-write"

Example: "2015-03-07T23:45:00Z"

The type of restore to be performed. You can specify one of the following values:

  • "full-copy" - The new DB cluster is restored as a full copy of the source DB cluster.
  • "copy-on-write" - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify "copy-on-write" if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a "RestoreType" value, then the new DB cluster is restored as a full copy of the source DB cluster.

For DB clusters in "serverless" DB engine mode, the scaling properties of the DB cluster.

REQUIRED SourceDBClusterIdentifier => Str

The identifier of the source DB cluster from which to restore.

Constraints:

•
Must match the identifier of an existing DBCluster.

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

Constraints: Can't be specified if "RestoreToTime" parameter is provided.

A list of VPC security groups that the new DB cluster belongs to.

This class forms part of Paws, documenting arguments for method RestoreDBClusterToPointInTime in Paws::RDS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.