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

Class: Aws::RDS::Types::RestoreDBClusterToPointInTimeMessage

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 RestoreDBClusterToPointInTimeMessage data as a hash:

{
  db_cluster_identifier: "String", # required
  restore_type: "String",
  source_db_cluster_identifier: "String", # required
  restore_to_time: Time.now,
  use_latest_restorable_time: false,
  port: 1,
  db_subnet_group_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

#db_cluster_identifierString

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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 DB subnet group name to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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 an encrypted DB cluster.

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.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

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

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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 for the new DB cluster.

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#restore_to_timeTime

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Cannot be specified if UseLatestRestorableTime parameter is true

  • Cannot be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Returns:

  • (Time)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#restore_typeString

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You cannot specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#source_db_cluster_identifierString

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must be the identifier of an existing database instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags.

Returns:



11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end

#use_latest_restorable_timeBoolean

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

Returns:

  • (Boolean)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_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 belongs to.

Returns:

  • (Array<String>)


11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 11552

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :restore_type,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :option_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_iam_database_authentication)
  include Aws::Structure
end