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

Class: Aws::RDS::Types::RestoreDBClusterFromSnapshotMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/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",
  database_name: "String",
  option_group_name: "String",
  vpc_security_group_ids: ["String"],
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enable_iam_database_authentication: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

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

Returns:

  • (Array<String>)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#database_nameString

The database name for the restored DB cluster.

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  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 255 letters, numbers, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#db_subnet_group_nameString

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

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

Example: mySubnetgroup

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

Returns:

  • (Boolean)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  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)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#engine_versionString

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

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#kms_key_idString

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

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB 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 will occur:

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

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

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#option_group_nameString

The name of the option group to use for the restored DB cluster.

Returns:

  • (String)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#portInteger

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

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Returns:

  • (Integer)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  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)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be assigned to the restored DB cluster.

Returns:



11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

A list of VPC security groups that the new DB cluster will belong to.

Returns:

  • (Array<String>)


11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11540

class RestoreDBClusterFromSnapshotMessage < Struct.new(
  :availability_zones,
  :db_cluster_identifier,
  :snapshot_identifier,
  :engine,
  :engine_version,
  :port,
  :db_subnet_group_name,
  :database_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end