NAME
Paws::Neptune::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on Paws::Neptune
DESCRIPTION
This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the Amazon Neptune 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('Neptune');
my $RestoreDBClusterToPointInTimeResult =
$rds->RestoreDBClusterToPointInTime(
DBClusterIdentifier => 'MyString',
SourceDBClusterIdentifier => 'MyString',
DBClusterParameterGroupName => 'MyString', # OPTIONAL
DBSubnetGroupName => 'MyString', # OPTIONAL
DeletionProtection => 1, # OPTIONAL
EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL
EnableIAMDatabaseAuthentication => 1, # OPTIONAL
KmsKeyId => 'MyString', # OPTIONAL
OptionGroupName => 'MyString', # OPTIONAL
Port => 1, # OPTIONAL
RestoreToTime => '1970-01-01T01:00:00', # OPTIONAL
RestoreType => 'MyString', # OPTIONAL
Tags => [
{
Key => 'MyString',
Value => 'MyString',
},
...
], # OPTIONAL
UseLatestRestorableTime => 1, # OPTIONAL
VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL
);
# Results:
my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster;
# Returns a L<Paws::Neptune::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 DB cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
DBClusterParameterGroupName => Str
The name of the DB cluster parameter group to associate with the new DB cluster.
Constraints:
If supplied, must match the name of an existing DBClusterParameterGroup.
DBSubnetGroupName => Str
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
DeletionProtection => Bool
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.
EnableCloudwatchLogsExports => ArrayRef[Str|Undef]
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
EnableIAMDatabaseAuthentication => Bool
True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
KmsKeyId => Str
The Amazon KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB 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 will occur:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.
If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.
OptionGroupName => Str
(Not supported by Neptune)
Port => Int
The port number on which the new DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
RestoreToTime => Str
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
UseLatestRestorableTimeparameter is not providedCannot be specified if
UseLatestRestorableTimeparameter is trueCannot be specified if
RestoreTypeparameter iscopy-on-write
Example: 2015-03-07T23:45:00Z
RestoreType => Str
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.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source 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.
Tags => ArrayRef[Paws::Neptune::Tag]
The tags to be applied to the restored DB cluster.
UseLatestRestorableTime => Bool
A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if RestoreToTime parameter is provided.
VpcSecurityGroupIds => ArrayRef[Str|Undef]
A list of VPC security groups that the new DB cluster belongs to.
SEE ALSO
This class forms part of Paws, documenting arguments for method RestoreDBClusterToPointInTime in Paws::Neptune
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