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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  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",
  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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifier ⇒ String

The name of the new 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) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group_name ⇒ String

The subnet group name to use for the new cluster.

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

Example: `mySubnetgroup`

Returns:

  • (String) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

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) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exports ⇒ Array<String>

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

Returns:

  • (Array<String>) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

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

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

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

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

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

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

Returns:

  • (String) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port number on which the new cluster accepts connections.

Constraints: Must be a value from `1150` to `65535`.

Default: The default port for the engine.

Returns:

  • (Integer) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#restore_to_time ⇒ Time

The date and time to restore the cluster to.

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

Constraints:

  • Must be before the latest restorable time for the 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) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#restore_type ⇒ String

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.

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) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_cluster_identifier ⇒ String

The identifier of the source cluster from which to restore.

Constraints:

  • Must match the identifier of an existing `DBCluster`.

^

Returns:

  • (String) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags to be assigned to the restored cluster.

Returns:



5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#use_latest_restorable_time ⇒ Boolean

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

Default: `false`

Constraints: Cannot be specified if the `RestoreToTime` parameter is provided.

Returns:

  • (Boolean) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ Array<String>

A list of VPC security groups that the new cluster belongs to.

Returns:

  • (Array<String>) 


5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
 
# File 'lib/aws-sdk-docdb/types.rb', line 5933

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,
  :vpc_security_group_ids,
  :tags,
  :kms_key_id,
  :enable_cloudwatch_logs_exports,
  :deletion_protection)
  SENSITIVE = []
  include Aws::Structure
end