You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Neptune::Types::RestoreDBClusterToPointInTimeMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::Neptune::Types::RestoreDBClusterToPointInTimeMessage
- Defined in:
- (unknown)
Overview
When passing RestoreDBClusterToPointInTimeMessage as input to an Aws::Client method, you can use a vanilla Hash:
{
db_cluster_identifier: "String", # required
restore_type: "String",
source_db_cluster_identifier: "String", # required
restore_to_time: Time.now,
use_latest_restorable_time: false,
port: 1,
db_subnet_group_name: "String",
option_group_name: "String",
vpc_security_group_ids: ["String"],
tags: [
{
key: "String",
value: "String",
},
],
kms_key_id: "String",
enable_iam_database_authentication: false,
enable_cloudwatch_logs_exports: ["String"],
db_cluster_parameter_group_name: "String",
deletion_protection: false,
}
Instance Attribute Summary collapse
-
#db_cluster_identifier ⇒ String
The name of the new DB cluster to be created.
-
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group to associate with the new DB cluster.
-
#db_subnet_group_name ⇒ String
The DB subnet group name to use for the new DB cluster.
-
#deletion_protection ⇒ Boolean
A value that indicates whether the DB cluster has deletion protection enabled.
-
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
-
#enable_iam_database_authentication ⇒ Boolean
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
-
#kms_key_id ⇒ String
The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
-
#option_group_name ⇒ String
(Not supported by Neptune).
-
#port ⇒ Integer
The port number on which the new DB cluster accepts connections.
-
#restore_to_time ⇒ Time
The date and time to restore the DB cluster to.
-
#restore_type ⇒ String
The type of restore to be performed.
-
#source_db_cluster_identifier ⇒ String
The identifier of the source DB cluster from which to restore.
-
#tags ⇒ Array<Types::Tag>
The tags to be applied to the restored DB cluster.
-
#use_latest_restorable_time ⇒ Boolean
A value that is set to
true
to restore the DB cluster to the latest restorable backup time, andfalse
otherwise. -
#vpc_security_group_ids ⇒ Array<String>
A list of VPC security groups that the new DB cluster belongs to.
Instance Attribute Details
#db_cluster_identifier ⇒ String
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
#db_cluster_parameter_group_name ⇒ String
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.
^
#db_subnet_group_name ⇒ String
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
#deletion_protection ⇒ Boolean
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.
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
#enable_iam_database_authentication ⇒ Boolean
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
#kms_key_id ⇒ String
The AWS 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 AWS 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.
#option_group_name ⇒ String
(Not supported by Neptune)
#port ⇒ Integer
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.
#restore_to_time ⇒ Time
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 is not providedCannot be specified if
UseLatestRestorableTime
parameter is trueCannot be specified if
RestoreType
parameter iscopy-on-write
Example: 2015-03-07T23:45:00Z
#restore_type ⇒ String
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.
#source_db_cluster_identifier ⇒ String
The identifier of the source DB cluster from which to restore.
Constraints:
- Must match the identifier of an existing DBCluster.
^
#tags ⇒ Array<Types::Tag>
The tags to be applied to the restored DB cluster.
#use_latest_restorable_time ⇒ Boolean
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.
#vpc_security_group_ids ⇒ Array<String>
A list of VPC security groups that the new DB cluster belongs to.