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

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 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,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

The name of the new DB cluster to be created.

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

Returns:

  • (String) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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 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) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#db_subnet_group_name ⇒ String

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

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

Example: ‘mySubnetgroup`

Returns:

  • (String) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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 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] in the *Amazon Aurora User Guide*.

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

Returns:

  • (Array<String>) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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 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 is encrypted with the KMS key identified by the ‘KmsKeyId` parameter.

If you don’t 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 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) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#option_group_name ⇒ String

The name of the option group for the new DB cluster.

Returns:

  • (String) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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: A value from ‘1150-65535`.

Default: The default port for the engine.

Returns:

  • (Integer) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#restore_to_time ⇒ Time

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

  • Can’t be specified if ‘UseLatestRestorableTime` parameter is true

  • Can’t be specified if ‘RestoreType` parameter is `copy-on-write`

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

Returns:

  • (Time) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  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.

Constraints: You can’t 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) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#source_db_cluster_identifier ⇒ String

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

Constraints:

  • Must match the identifier of an existing DBCluster.

^

Returns:

  • (String) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:



13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end

#use_latest_restorable_time ⇒ Boolean

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

Default: ‘false`

Constraints: Can’t be specified if ‘RestoreToTime` parameter is provided.

Returns:

  • (Boolean) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :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 belongs to.

Returns:

  • (Array<String>) 


13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
 
# File 'lib/aws-sdk-rds/types.rb', line 13793

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,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :db_cluster_parameter_group_name,
  :deletion_protection)
  include Aws::Structure
end