Class: Aws::DocDB::Types::RestoreDBClusterFromSnapshotMessage

Inherits:

Struct

Object
Struct
Aws::DocDB::Types::RestoreDBClusterFromSnapshotMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-docdb/types.rb

Overview

Represents the input to RestoreDBClusterFromSnapshot.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zones ⇒ Array<String>

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
#db_cluster_identifier ⇒ String

The name of the cluster to create from the snapshot or cluster snapshot.
#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 name of the subnet group to use for the new cluster.
#deletion_protection ⇒ Boolean

Specifies whether this cluster can be deleted.
#enable_cloudwatch_logs_exports ⇒ Array<String>

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
#engine ⇒ String

The database engine to use for the new cluster.
#engine_version ⇒ String

The version of the database engine to use for the new cluster.
#kms_key_id ⇒ String

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
#port ⇒ Integer

The port number on which the new cluster accepts connections.
#snapshot_identifier ⇒ String

The identifier for the snapshot or cluster snapshot to restore from.
#storage_type ⇒ String

The storage type to associate with the DB cluster.
#tags ⇒ Array<Types::Tag>

The tags to be assigned to the restored cluster.
#vpc_security_group_ids ⇒ Array<String>

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Instance Attribute Details

#availability_zones ⇒ `Array<String>`

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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`

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ `String`

The name of the DB cluster parameter group to associate with this DB cluster.

Type: String. Required: No.

If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group_name ⇒ `String`

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`

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The database engine to use for the new cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version of the database engine to use for the new cluster.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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 Amazon Web Services 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.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

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.

Returns:

(Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_identifier ⇒ `String`

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.

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the *Amazon DocumentDB Developer Guide*.

Valid values for storage type - ‘standard | iopt1`

Default value is ‘standard `

Returns:

(String)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

The tags to be assigned to the restored cluster.

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

A list of virtual private cloud (VPC) security groups that the new cluster will belong to.

Returns:

(Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 5309

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :db_cluster_parameter_group_name,
  :storage_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::DocDB::Types::RestoreDBClusterFromSnapshotMessage

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

#db_cluster_identifier ⇒ String

#db_cluster_parameter_group_name ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#enable_cloudwatch_logs_exports ⇒ Array<String>

#engine ⇒ String

#engine_version ⇒ String

#kms_key_id ⇒ String

#port ⇒ Integer

#snapshot_identifier ⇒ String

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc_security_group_ids ⇒ Array<String>

#availability_zones ⇒ `Array<String>`

#db_cluster_identifier ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

#engine ⇒ `String`

#engine_version ⇒ `String`

#kms_key_id ⇒ `String`

#port ⇒ `Integer`

#snapshot_identifier ⇒ `String`

#storage_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#vpc_security_group_ids ⇒ `Array<String>`