class Aws::RDS::Types::RestoreDBClusterToPointInTimeMessage

@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",
    }

@!attribute [rw] db_cluster_identifier

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
@return [String]

@!attribute [rw] restore_type

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.
@return [String]

@!attribute [rw] source_db_cluster_identifier

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

Constraints:

* Must match the identifier of an existing DBCluster.

^
@return [String]

@!attribute [rw] restore_to_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`
@return [Time]

@!attribute [rw] use_latest_restorable_time

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.
@return [Boolean]

@!attribute [rw] port

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

Constraints: A value from `1150-65535`.

Default: The default port for the engine.
@return [Integer]

@!attribute [rw] db_subnet_group_name

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`
@return [String]

@!attribute [rw] option_group_name

The name of the option group for the new DB cluster.
@return [String]

@!attribute [rw] vpc_security_group_ids

A list of VPC security groups that the new DB cluster belongs to.
@return [Array<String>]

@!attribute [rw] tags

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

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
@return [Array<Types::Tag>]

@!attribute [rw] kms_key_id

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 Amazon Web Services KMS customer
master key (CMK). To use a CMK 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 Amazon Web Services KMS CMK that is different than the Amazon
Web Services KMS key used to encrypt the source DB cluster. The new
DB cluster is encrypted with the Amazon Web Services KMS CMK
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 Amazon Web Services KMS CMK 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.
@return [String]

@!attribute [rw] enable_iam_database_authentication

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

For more information, see [ IAM Database Authentication][1] in the
*Amazon Aurora User Guide.*

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@return [Boolean]

@!attribute [rw] backtrack_window

The target backtrack window, in seconds. To disable backtracking,
set this value to 0.

<note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.

 </note>

Default: 0

Constraints:

* If specified, this value must be set to a number from 0 to 259,200
  (72 hours).

^
@return [Integer]

@!attribute [rw] enable_cloudwatch_logs_exports

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][1] in the *Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@return [Array<String>]

@!attribute [rw] db_cluster_parameter_group_name

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.
@return [String]

@!attribute [rw] deletion_protection

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 is disabled.
@return [Boolean]

@!attribute [rw] copy_tags_to_snapshot

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.
@return [Boolean]

@!attribute [rw] domain

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][1] in the
*Amazon Aurora User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
@return [String]

@!attribute [rw] domain_iam_role_name

Specify the name of the IAM role to be used when making API calls to
the Directory Service.
@return [String]

@!attribute [rw] scaling_configuration

For DB clusters in `serverless` DB engine mode, the scaling
properties of the DB cluster.
@return [Types::ScalingConfiguration]

@!attribute [rw] engine_mode

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 clone from a provisioned
cluster, or a provisioned clone from an Aurora Serverless cluster.
To create a clone that is an Aurora Serverless cluster, the original
cluster must be an Aurora Serverless cluster or an encrypted
provisioned cluster.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterToPointInTimeMessage AWS API Documentation

Constants

SENSITIVE