class Aws::DocDB::Types::RestoreDBClusterFromSnapshotMessage
Represents the input to RestoreDBClusterFromSnapshot.
@note When making an API call, you may pass RestoreDBClusterFromSnapshotMessage
data as a hash: { availability_zones: ["String"], db_cluster_identifier: "String", # required snapshot_identifier: "String", # required engine: "String", # required engine_version: "String", 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] availability_zones
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in. @return [Array<String>]
@!attribute [rw] db_cluster_identifier
The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive. 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. Example: `my-snapshot-id` @return [String]
@!attribute [rw] snapshot_identifier
The identifier for the snapshot or cluster snapshot to restore from. You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot. Constraints: * Must match the identifier of an existing snapshot. ^ @return [String]
@!attribute [rw] engine
The database engine to use for the new cluster. Default: The same as source. Constraint: Must be compatible with the engine of the source. @return [String]
@!attribute [rw] engine_version
The version of the database engine to use for the new cluster. @return [String]
@!attribute [rw] port
The port number on which the new cluster accepts connections. Constraints: Must be a value from `1150` to `65535`. Default: The same port as the original cluster. @return [Integer]
@!attribute [rw] db_subnet_group_name
The name of the subnet group 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 virtual private cloud (VPC) security groups that the new cluster will belong 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 a DB snapshot or cluster snapshot. 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. If you do not specify a value for the `KmsKeyId` parameter, then the following occurs: * If the snapshot or cluster snapshot in `SnapshotIdentifier` is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot. * If the snapshot or the cluster snapshot in `SnapshotIdentifier` is not encrypted, then the restored DB cluster is not encrypted. @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/RestoreDBClusterFromSnapshotMessage AWS API Documentation
Constants
- SENSITIVE