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,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  engine_mode: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
    seconds_before_timeout: 1,
  },
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  db_cluster_instance_class: "String",
  storage_type: "String",
  iops: 1,
  publicly_accessible: false,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zonesArray<String>

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only

Returns:

  • (Array<String>)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_windowInteger

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

  • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

^

Valid for: Aurora DB clusters only

Returns:

  • (Integer)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Boolean)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#database_nameString

The database name for the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_instance_classString

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_nameString

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

  • If supplied, must match the name of an existing default DB cluster parameter group.

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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 DB subnet group.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Boolean)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide.

Valid for: Aurora DB clusters only

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_nameString

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exportsArray<String>

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide..

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Array<String>)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Returns:

  • (Boolean)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#engine_modeString

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Valid for: Aurora DB clusters only

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

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

To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide.

Aurora PostgreSQL

See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide.

MySQL

See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

PostgreSQL

See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Integer)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

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

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When you don't 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 KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_nameString

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

DB clusters are associated with a default option group that can't be modified.

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

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

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Integer)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

  • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.

  • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

  • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.

  • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Boolean)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configurationTypes::ScalingConfiguration

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only



20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configurationTypes::ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.



20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

^

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (String)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be assigned to the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:



20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

  • (Array<String>)


20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20182

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :engine_mode,
  :scaling_configuration,
  :db_cluster_parameter_group_name,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :db_cluster_instance_class,
  :storage_type,
  :iops,
  :publicly_accessible,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end