/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::DocDB::RestoreDBClusterToPointInTime

NAME

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

DESCRIPTION

This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the Amazon DocumentDB with MongoDB compatibility 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.

SYNOPSIS

my $rds = Paws->service('DocDB');
my $RestoreDBClusterToPointInTimeResult =
  $rds->RestoreDBClusterToPointInTime(
  DBClusterIdentifier         => 'MyString',
  SourceDBClusterIdentifier   => 'MyString',
  DBSubnetGroupName           => 'MyString',               # OPTIONAL
  DeletionProtection          => 1,                        # OPTIONAL
  EnableCloudwatchLogsExports => [ 'MyString', ... ],      # OPTIONAL
  KmsKeyId                    => 'MyString',               # OPTIONAL
  Port                        => 1,                        # OPTIONAL
  RestoreToTime               => '1970-01-01T01:00:00',    # OPTIONAL
  Tags                        => [
    {
      Key   => 'MyString',
      Value => 'MyString',
    },
    ...
  ],                                                       # OPTIONAL
  UseLatestRestorableTime => 1,                            # OPTIONAL
  VpcSecurityGroupIds     => [ 'MyString', ... ],          # OPTIONAL
  );

# Results:
my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster;

# Returns a L<Paws::DocDB::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

ATTRIBUTES

REQUIRED DBClusterIdentifier => Str

The name of the new cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

DBSubnetGroupName => Str

The subnet group name to use for the new cluster.

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

Example: mySubnetgroup

DeletionProtection => Bool

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

EnableCloudwatchLogsExports => ArrayRef[Str|Undef]

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

KmsKeyId => Str

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.

  • If the cluster is not encrypted, then the restored cluster is not encrypted.

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

Port => Int

The port number on which the new cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

RestoreToTime => Str

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

  • Must be before the latest restorable time for the instance.

  • Must be specified if the UseLatestRestorableTime parameter is not provided.

  • Cannot be specified if the UseLatestRestorableTime parameter is true.

  • Cannot be specified if the RestoreType parameter is copy-on-write.

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

REQUIRED SourceDBClusterIdentifier => Str

The identifier of the source cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

Tags => ArrayRef[Paws::DocDB::Tag]

The tags to be assigned to the restored cluster.

UseLatestRestorableTime => Bool

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

VpcSecurityGroupIds => ArrayRef[Str|Undef]

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

SEE ALSO

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

BUGS and CONTRIBUTIONS

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