You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RDS::Types::RestoreDBClusterToPointInTimeMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::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,
backtrack_window: 1,
enable_cloudwatch_logs_exports: ["String"],
db_cluster_parameter_group_name: "String",
deletion_protection: false,
copy_tags_to_snapshot: false,
domain: "String",
domain_iam_role_name: "String",
}
Instance Attribute Summary collapse
-
#backtrack_window ⇒ Integer
The target backtrack window, in seconds.
-
#copy_tags_to_snapshot ⇒ Boolean
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
-
#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 this 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.
-
#domain ⇒ String
Specify the Active Directory directory ID to restore the DB cluster in.
-
#domain_iam_role_name ⇒ String
Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
#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
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
-
#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
The name of the option group for the new DB cluster.
-
#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>
A list of tags.
-
#use_latest_restorable_time ⇒ Boolean
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
-
#vpc_security_group_ids ⇒ Array<String>
A list of VPC security groups that the new DB cluster belongs to.
Instance Attribute Details
#backtrack_window ⇒ Integer
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
- If specified, this value must be set to a number from 0 to 259,200 (72 hours).
^
#copy_tags_to_snapshot ⇒ Boolean
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.
#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
Can\'t 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 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.
#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.
#domain ⇒ String
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 in the Amazon Aurora User Guide.
#domain_iam_role_name ⇒ String
Specify the name of the IAM role to be used when making API calls to the Directory Service.
#enable_cloudwatch_logs_exports ⇒ Array<String>
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 in the Amazon Aurora User Guide.
#enable_iam_database_authentication ⇒ Boolean
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
#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 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 KMS key 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.
#option_group_name ⇒ String
The name of the option group for the new DB cluster.
#port ⇒ Integer
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535
.
Default: The default port for the engine.
#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 isn\'t providedCan\'t be specified if the
UseLatestRestorableTime
parameter is enabledCan\'t be specified if the
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.
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.
#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>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
#use_latest_restorable_time ⇒ Boolean
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.
#vpc_security_group_ids ⇒ Array<String>
A list of VPC security groups that the new DB cluster belongs to.