class Aws::DocDB::Types::RestoreDBClusterToPointInTimeMessage
Represents the input to RestoreDBClusterToPointInTime.
@note When making an API call, you may pass RestoreDBClusterToPointInTimeMessage
data as a hash: { db_cluster_identifier: "String", # required source_db_cluster_identifier: "String", # required restore_to_time: Time.now, use_latest_restorable_time: false, port: 1, db_subnet_group_name: "String", vpc_security_group_ids: ["String"], tags: [ { key: "String", value: "String", }, ], kms_key_id: "String", enable_cloudwatch_logs_exports: ["String"], deletion_protection: false, }
@!attribute [rw] db_cluster_identifier
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. @return [String]
@!attribute [rw] source_db_cluster_identifier
The identifier of the source cluster from which to restore. Constraints: * Must match the identifier of an existing `DBCluster`. ^ @return [String]
@!attribute [rw] restore_to_time
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` @return [Time]
@!attribute [rw] use_latest_restorable_time
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. @return [Boolean]
@!attribute [rw] port
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. @return [Integer]
@!attribute [rw] db_subnet_group_name
The subnet group name to use for the new cluster. Constraints: If provided, must match the name of an existing `DBSubnetGroup`. Example: `mySubnetgroup` @return [String]
@!attribute [rw] vpc_security_group_ids
A list of VPC security groups that the new cluster belongs to. @return [Array<String>]
@!attribute [rw] tags
The tags to be assigned to the restored cluster. @return [Array<Types::Tag>]
@!attribute [rw] kms_key_id
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. @return [String]
@!attribute [rw] enable_cloudwatch_logs_exports
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs. @return [Array<String>]
@!attribute [rw] deletion_protection
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. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeMessage AWS API Documentation
Constants
- SENSITIVE