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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RestoreDBClusterFromSnapshotMessage as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

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>) —

    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. 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) —

    The name of the cluster to create from the snapshot or cluster snapshot.

#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) —

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

#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) —

    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.

Returns:

  • (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.

Default: The same as source.

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

Returns:

  • (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.

Returns:

  • (String) —

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

#kms_key_id ⇒ String

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

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new 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 snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the AWS 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) —

    The AWS 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.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original cluster.

Returns:

  • (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.

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) —

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

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the restored cluster.

Returns:

  • (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.

Returns:

  • (Array<String>) —

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