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

Inherits:

Struct

Object
Struct
Aws::RDS::Types::RestoreDBClusterToPointInTimeMessage

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,
  backtrack_window: 1,
  enable_cloudwatch_logs_exports: ["String"],
  db_cluster_parameter_group_name: "String",
  deletion_protection: false,
  copy_tags_to_snapshot: false,
  domain: "String",
  domain_iam_role_name: "String",
  scaling_configuration: {
    min_capacity: 1,
    max_capacity: 1,
    auto_pause: false,
    seconds_until_auto_pause: 1,
    timeout_action: "String",
    seconds_before_timeout: 1,
  },
  engine_mode: "String",
  db_cluster_instance_class: "String",
  storage_type: "String",
  publicly_accessible: false,
  iops: 1,
  serverless_v2_scaling_configuration: {
    min_capacity: 1.0,
    max_capacity: 1.0,
  },
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#backtrack_window ⇒ Integer
The target backtrack window, in seconds.
#copy_tags_to_snapshot ⇒ Boolean
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
#db_cluster_identifier ⇒ String
The name of the new DB cluster to be created.
#db_cluster_instance_class ⇒ String
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge.
#db_cluster_parameter_group_name ⇒ String
The name of the DB cluster parameter group to associate with this DB cluster.
#db_subnet_group_name ⇒ String
The DB subnet group name to use for the new DB cluster.
#deletion_protection ⇒ Boolean
A value that indicates whether the DB cluster has deletion protection enabled.
#domain ⇒ String
Specify the Active Directory directory ID to restore the DB cluster in.
#domain_iam_role_name ⇒ String
Specify the name of the IAM role to be used when making API calls to the Directory Service.
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of logs that the restored DB cluster is to export to CloudWatch Logs.
#enable_iam_database_authentication ⇒ Boolean
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.
#engine_mode ⇒ String
The engine mode of the new cluster.
#iops ⇒ Integer
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
#kms_key_id ⇒ String
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
#option_group_name ⇒ String
The name of the option group for the new DB cluster.
#port ⇒ Integer
The port number on which the new DB cluster accepts connections.
#publicly_accessible ⇒ Boolean
A value that indicates whether the DB cluster is publicly accessible.
#restore_to_time ⇒ Time
The date and time to restore the DB cluster to.
#restore_type ⇒ String
The type of restore to be performed.
#scaling_configuration ⇒ Types::ScalingConfiguration
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
#source_db_cluster_identifier ⇒ String
The identifier of the source DB cluster from which to restore.
#storage_type ⇒ String
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
#tags ⇒ Array<Types::Tag>
A list of tags.
#use_latest_restorable_time ⇒ Boolean
A value that indicates whether to restore the DB cluster to the latest restorable backup time.
#vpc_security_group_ids ⇒ Array<String>
A list of VPC security groups that the new DB cluster belongs to.

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

Valid for: Aurora MySQL DB clusters only

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_instance_class ⇒ `String`

The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.

For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.

Valid for: Multi-AZ DB clusters only

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ `String`

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_name ⇒ `String`

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

RDS for MySQL

Possible values are error, general, and slowquery.

RDS for PostgreSQL

Possible values are postgresql and upgrade.

Aurora MySQL

Possible values are audit, error, general, and slowquery.

Aurora PostgreSQL

Possible value is postgresql.

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#engine_mode ⇒ `String`

The engine mode of the new cluster. Specify provisioned or serverless, depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.

Valid for: Aurora DB clusters only

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#iops ⇒ `Integer`

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Multi-AZ DB clusters only

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from 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 isn't encrypted, then the restored DB cluster isn't encrypted.

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

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

DB clusters are associated with a default option group that can't be modified.

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Integer)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

A value that indicates whether the DB cluster is publicly accessible.

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.

When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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 isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Time)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  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.

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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration ⇒ `Types::ScalingConfiguration`

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

Valid for: Aurora DB clusters only

Returns:

(Types::ScalingConfiguration)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.

For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.

Returns:

(Types::ServerlessV2ScalingConfiguration)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.

Valid values: io1

When specified, a value for the Iops parameter is required.

Default: io1

Valid for: Multi-AZ DB clusters only

Returns:

(String)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  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.

Returns:

(Array<Types::Tag>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_latest_restorable_time ⇒ `Boolean`

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

Constraints: Can't be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Boolean)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

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

Valid for: Aurora DB clusters and Multi-AZ DB clusters

Returns:

(Array<String>)

# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 20895

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,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :scaling_configuration,
  :engine_mode,
  :db_cluster_instance_class,
  :storage_type,
  :publicly_accessible,
  :iops,
  :serverless_v2_scaling_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#backtrack_window ⇒ Integer

#copy_tags_to_snapshot ⇒ Boolean

#db_cluster_identifier ⇒ String

#db_cluster_instance_class ⇒ String

#db_cluster_parameter_group_name ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#domain ⇒ String

#domain_iam_role_name ⇒ String

#enable_cloudwatch_logs_exports ⇒ Array<String>

#enable_iam_database_authentication ⇒ Boolean

#engine_mode ⇒ String

#iops ⇒ Integer

#kms_key_id ⇒ String

#option_group_name ⇒ String

#port ⇒ Integer

#publicly_accessible ⇒ Boolean

#restore_to_time ⇒ Time

#restore_type ⇒ String

#scaling_configuration ⇒ Types::ScalingConfiguration

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

#source_db_cluster_identifier ⇒ String

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#use_latest_restorable_time ⇒ Boolean

#vpc_security_group_ids ⇒ Array<String>

#backtrack_window ⇒ `Integer`

#copy_tags_to_snapshot ⇒ `Boolean`

#db_cluster_identifier ⇒ `String`

#db_cluster_instance_class ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#domain ⇒ `String`

#domain_iam_role_name ⇒ `String`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

#enable_iam_database_authentication ⇒ `Boolean`

#engine_mode ⇒ `String`

#iops ⇒ `Integer`

#kms_key_id ⇒ `String`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#publicly_accessible ⇒ `Boolean`

#restore_to_time ⇒ `Time`

#restore_type ⇒ `String`

#scaling_configuration ⇒ `Types::ScalingConfiguration`

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

#source_db_cluster_identifier ⇒ `String`

#storage_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#use_latest_restorable_time ⇒ `Boolean`

#vpc_security_group_ids ⇒ `Array<String>`