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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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,
  },
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
}

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


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#backtrack_window ⇒ Integer

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

Default: 0

Constraints:

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

^

Returns:

  • (Integer) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#database_name ⇒ String

The database name for the restored DB cluster.

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#db_cluster_identifier ⇒ String

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`

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#db_cluster_parameter_group_name ⇒ String

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.

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#db_subnet_group_name ⇒ String

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: ‘mySubnetgroup`

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#deletion_protection ⇒ Boolean

Indicates if the DB cluster should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false.

Returns:

  • (Boolean) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#enable_cloudwatch_logs_exports ⇒ Array<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. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

Returns:

  • (Array<String>) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#enable_iam_database_authentication ⇒ Boolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: ‘false`

Returns:

  • (Boolean) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#engine ⇒ String

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) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#engine_mode ⇒ String

The DB engine mode of the DB cluster, either ‘provisioned`, `serverless`, or `parallelquery`.

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#engine_version ⇒ String

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

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#kms_key_id ⇒ String

The AWS 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 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` is not encrypted, then the restored DB cluster is not encrypted.

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#option_group_name ⇒ String

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

Returns:

  • (String) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#port ⇒ Integer

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.

Returns:

  • (Integer) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#scaling_configuration ⇒ Types::ScalingConfiguration

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

Returns:



13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#snapshot_identifier ⇒ String

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) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the restored DB cluster.

Returns:



13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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

#vpc_security_group_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
 
# File 'lib/aws-sdk-rds/types.rb', line 13414

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