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

Class: Aws::DocDB::Types::RestoreDBClusterToPointInTimeMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass RestoreDBClusterToPointInTimeMessage data as a hash:

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

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 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#db_subnet_group_nameString

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

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

Example: mySubnetgroup

Returns:

  • (String)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#deletion_protectionBoolean

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)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#enable_cloudwatch_logs_exportsArray<String>

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

Returns:

  • (Array<String>)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#kms_key_idString

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

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

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

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

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS 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)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#portInteger

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

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

Returns:

  • (Integer)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#restore_to_timeTime

The date and time to restore the DB cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

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

  • Must be specified if the UseLatestRestorableTime parameter is not provided.

  • Cannot be specified if the UseLatestRestorableTime parameter is true.

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

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

Returns:

  • (Time)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#source_db_cluster_identifierString

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

Constraints:

  • Must match the identifier of an existing DBCluster.

^

Returns:

  • (String)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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

#tagsArray<Types::Tag>

The tags to be assigned to the restored DB cluster.

Returns:



4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  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 the RestoreToTime parameter is provided.

Returns:

  • (Boolean)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

class RestoreDBClusterToPointInTimeMessage < Struct.new(
  :db_cluster_identifier,
  :source_db_cluster_identifier,
  :restore_to_time,
  :use_latest_restorable_time,
  :port,
  :db_subnet_group_name,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  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>)


4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4594

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