class Aws::RDS::Types::RestoreDBClusterFromSnapshotMessage

@note When making an API call, you may pass RestoreDBClusterFromSnapshotMessage

data as a hash:

    {
      availability_zones: ["String"],
      db_cluster_identifier: "String", # required
      snapshot_identifier: "String", # required
      engine: "String", # required
      engine_version: "String",
      port: 1,
      db_subnet_group_name: "String",
      database_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"],
      engine_mode: "String",
      scaling_configuration: {
        min_capacity: 1,
        max_capacity: 1,
        auto_pause: false,
        seconds_until_auto_pause: 1,
        timeout_action: "String",
        seconds_before_timeout: 1,
      },
      db_cluster_parameter_group_name: "String",
      deletion_protection: false,
      copy_tags_to_snapshot: false,
      domain: "String",
      domain_iam_role_name: "String",
    }

@!attribute [rw] availability_zones

Provides the list of Availability Zones (AZs) where instances in the
restored DB cluster can be created.
@return [Array<String>]

@!attribute [rw] db_cluster_identifier

The name of the DB cluster to create from the DB snapshot or DB
cluster snapshot. This parameter isn't case-sensitive.

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

Example: `my-snapshot-id`
@return [String]

@!attribute [rw] snapshot_identifier

The identifier for the DB snapshot or DB cluster snapshot to restore
from.

You can use either the name or the Amazon Resource Name (ARN) to
specify a DB cluster snapshot. However, you can use only the ARN to
specify a DB snapshot.

Constraints:

* Must match the identifier of an existing Snapshot.

^
@return [String]

@!attribute [rw] engine

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source
@return [String]

@!attribute [rw] engine_version

The version of the database engine to use for the new DB cluster.

To list all of the available engine versions for `aurora` (for MySQL
5.6-compatible Aurora), use the following command:

`aws rds describe-db-engine-versions --engine aurora --query
"DBEngineVersions[].EngineVersion"`

To list all of the available engine versions for `aurora-mysql` (for
MySQL 5.7-compatible Aurora), use the following command:

`aws rds describe-db-engine-versions --engine aurora-mysql --query
"DBEngineVersions[].EngineVersion"`

To list all of the available engine versions for
`aurora-postgresql`, use the following command:

`aws rds describe-db-engine-versions --engine aurora-postgresql
--query "DBEngineVersions[].EngineVersion"`

<note markdown="1"> If you aren't using the default engine version, then you must
specify the engine version.

 </note>

**Aurora MySQL**

Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`,
`5.7.mysql_aurora.2.04.5`

**Aurora PostgreSQL**

Example: `9.6.3`, `10.7`
@return [String]

@!attribute [rw] port

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

Constraints: This value must be `1150-65535`

Default: The same port as the original DB cluster.
@return [Integer]

@!attribute [rw] db_subnet_group_name

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

Constraints: If supplied, must match the name of an existing DB
subnet group.

Example: `mySubnetgroup`
@return [String]

@!attribute [rw] database_name

The database name for the restored DB cluster.
@return [String]

@!attribute [rw] option_group_name

The name of the option group to use for the restored DB cluster.
@return [String]

@!attribute [rw] vpc_security_group_ids

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

@!attribute [rw] tags

The tags to be assigned to the restored DB cluster.
@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 a DB snapshot or DB cluster snapshot.

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.

When you don't specify a value for the `KmsKeyId` parameter, then
the following occurs:

* If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
  is encrypted, then the restored DB cluster is encrypted using the
  Amazon Web Services KMS CMK that was used to encrypt the DB
  snapshot or DB cluster snapshot.

* If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
  isn't encrypted, then the restored DB cluster isn't encrypted.
@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 Amazon
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] engine_mode

The DB engine mode of the DB cluster, either `provisioned`,
`serverless`, `parallelquery`, `global`, or `multimaster`.

For more information, see [ CreateDBCluster][1].

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
@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] 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 default 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. Currently,
only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
instances can be created in an Active Directory Domain.

For more information, see [ Kerberos Authentication][1] in the
*Amazon RDS User Guide*.

[1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/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]

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

Constants

SENSITIVE