You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

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,
}

Represents the input to RestoreDBClusterFromSnapshot.

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#db_cluster_identifierString

The name of the DB cluster to create from the DB snapshot or DB 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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#db_subnet_group_nameString

The name of the DB subnet group to use for the new DB cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#deletion_protectionBoolean

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)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#enable_cloudwatch_logs_exportsArray<String>

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

Returns:

  • (Array<String>)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#engineString

The database engine to use for the new DB cluster.

Default: The same as source.

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#engine_versionString

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

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#kms_key_idString

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot.

  • If the DB snapshot or the DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#portInteger

The port number on which the new DB cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original DB cluster.

Returns:

  • (Integer)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#snapshot_identifierString

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

^

Returns:

  • (String)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be assigned to the restored DB cluster.

Returns:



4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

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

Returns:

  • (Array<String>)


4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4421

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)
  include Aws::Structure
end