class Aws::RDS::Types::RestoreDBClusterFromS3Message

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Message AWS API Documentation
@return [String]
Valid for: Aurora DB clusters only
Default: ‘aurora`
Valid Values: `aurora`, `aurora-iopt1`
Specifies the storage type to be associated with the DB cluster.
@!attribute [rw] storage_type
@return [String]
each Amazon Web Services Region.
Your Amazon Web Services account has a different default KMS key for
There is a default KMS key for your Amazon Web Services account.
and you must use a customer managed KMS key.
can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret,
secret is in a different Amazon Web Services account, then you
`aws/secretsmanager` KMS key is used to encrypt the secret. If the
If you don’t specify ‘MasterUserSecretKmsKeyId`, then the
ARN.
different Amazon Web Services account, specify the key ARN or alias
alias ARN, or alias name for the KMS key. To use a KMS key in a
The Amazon Web Services KMS key identifier is the key ARN, key ID,
RDS in Amazon Web Services Secrets Manager for the DB cluster.
This setting is valid only if the master user password is managed by
Secrets Manager.
is automatically generated and managed in Amazon Web Services
The Amazon Web Services KMS key identifier to encrypt a secret that
@!attribute [rw] master_user_secret_kms_key_id
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html ^
Secrets Manager if `MasterUserPassword` is specified.
* Can’t manage the master user password with Amazon Web Services
Constraints:
the *Amazon Aurora User Guide.*
[Password management with Amazon Web Services Secrets Manager] in
Services Secrets Manager] in the *Amazon RDS User Guide* and
For more information, see [Password management with Amazon Web
Services Secrets Manager.
Specifies whether to manage the master user password with Amazon Web
@!attribute [rw] manage_master_user_password
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html in the *Amazon Aurora User Guide.*
For more information, see [ Working with a DB instance in a VPC][1]

or the IPv4 and the IPv6 protocols (‘DUAL`).
the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
The network type is determined by the `DBSubnetGroup` specified for
* `DUAL`
* `IPV4`
Valid Values:
The network type of the DB cluster.
@!attribute [rw] network_type
@return [Types::ServerlessV2ScalingConfiguration] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html the *Amazon Aurora User Guide*.
For more information, see [Using Amazon Aurora Serverless v2] in
cluster.
Contains the scaling configuration of an Aurora Serverless v2 DB
@!attribute [rw] serverless_v2_scaling_configuration
@return [String]
the Directory Service.
Specify the name of the IAM role to be used when making API calls to
@!attribute [rw] domain_iam_role_name
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html *Amazon Aurora User Guide*.
For more information, see [Kerberos Authentication] in the
Authentication to authenticate users that connect to the DB cluster.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
in. The domain must be created prior to this operation.
Specify the Active Directory directory ID to restore the DB cluster
@!attribute [rw] domain
@return [Boolean]
them.
snapshots of the restored DB cluster. The default is not to copy
Specifies whether to copy all tags from the restored DB cluster to
@!attribute [rw] copy_tags_to_snapshot
@return [Boolean]
By default, deletion protection isn’t enabled.
The database can’t be deleted when deletion protection is enabled.
Specifies whether to enable deletion protection for the DB cluster.
@!attribute [rw] deletion_protection
@return [Array<String>] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch in the *Amazon Aurora User Guide*.
Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][1]
For more information about exporting CloudWatch Logs for Amazon
Possible values are ‘audit`, `error`, `general`, and `slowquery`.
**Aurora MySQL**
being used.
CloudWatch Logs. The values in the list depend on the DB engine
The list of logs that the restored DB cluster is to export to
@!attribute [rw] enable_cloudwatch_logs_exports
@return [Integer]
^
(72 hours).
* If specified, this value must be set to a number from 0 to 259,200
Constraints:
Default: 0
</note>
<note markdown=“1”> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
set this value to 0.
The target backtrack window, in seconds. To disable backtracking,
@!attribute [rw] backtrack_window
@return [String]
access the Amazon S3 bucket on your behalf.
and Access Management (IAM) role that authorizes Amazon RDS to
The Amazon Resource Name (ARN) of the Amazon Web Services Identity
@!attribute [rw] s3_ingestion_role_arn
@return [String]
created by using all of the files in the Amazon S3 bucket.
SourceS3Prefix value, then the Amazon Aurora DB cluster is
create the Amazon Aurora DB cluster. If you do not specify a
The prefix for all of the file names that contain the data used to
@!attribute [rw] s3_prefix
@return [String]
create the Amazon Aurora DB cluster.
The name of the Amazon S3 bucket that contains the data used to
@!attribute [rw] s3_bucket_name
@return [String]
Example: `5.7.40`, `8.0.28`
MySQL versions 5.7 and 8.0 are supported.
The version of the database that the backup files were created from.
@!attribute [rw] source_engine_version
@return [String]
Valid Values: `mysql`
the files stored in the Amazon S3 bucket.
The identifier for the database engine that was backed up to create
@!attribute [rw] source_engine
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html *Amazon Aurora User Guide*.
For more information, see [ IAM Database Authentication] in the
default, mapping isn’t enabled.
and Access Management (IAM) accounts to database accounts. By
Specifies whether to enable mapping of Amazon Web Services Identity
@!attribute [rw] enable_iam_database_authentication
@return [String]
default KMS key for each Amazon Web Services Region.
Services account. Your Amazon Web Services account has a different
default KMS key. There is a default KMS key for your Amazon Web
a value for the ‘KmsKeyId` parameter, then Amazon RDS will use your
If the StorageEncrypted parameter is enabled, and you do not specify
ARN.
different Amazon Web Services account, specify the key ARN or alias
alias ARN, or alias name for the KMS key. To use a KMS key in a
The Amazon Web Services KMS key identifier is the key ARN, key ID,
cluster.
The Amazon Web Services KMS key identifier for an encrypted DB
@!attribute [rw] kms_key_id
@return [Boolean]
Specifies whether the restored DB cluster is encrypted.
@!attribute [rw] storage_encrypted
@return [Array<Types::Tag>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Resources][1] in the *Amazon RDS User Guide.*
A list of tags. For more information, see [Tagging Amazon RDS
@!attribute [rw] tags
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora Constraints: Minimum 30-minute window.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
User Guide*.
Adjusting the Preferred Maintenance Window] in the *Amazon Aurora
random day of the week. To see the time blocks available, see [
block of time for each Amazon Web Services Region, occurring on a
The default is a 30-minute window selected at random from an 8-hour
Format: `ddd:hh24:mi-ddd:hh24:mi`
Universal Coordinated Time (UTC).
The weekly time range during which system maintenance can occur, in
@!attribute [rw] preferred_maintenance_window
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow * Must be at least 30 minutes.
* Must not conflict with the preferred maintenance window.
* Must be in Universal Coordinated Time (UTC).
* Must be in the format `hh24:mi-hh24:mi`.
Constraints:
Guide*.
blocks available, see [ Backup window] in the *Amazon Aurora User
block of time for each Amazon Web Services Region. To view the time
The default is a 30-minute window selected at random from an 8-hour
parameter.
automated backups are enabled using the `BackupRetentionPeriod`
The daily time range during which automated backups are created if
@!attribute [rw] preferred_backup_window
@return [String]
a DB cluster.
group can’t be removed from a DB cluster once it is associated with
Permanent options can’t be removed from an option group. An option
associated with the specified option group.
A value that indicates that the restored DB cluster should be
@!attribute [rw] option_group_name
@return [String]
* Can’t be specified if ‘ManageMasterUserPassword` is turned on.
* Must contain from 8 to 41 characters.
Constraints:
any printable ASCII character except “/”, “”“, or ”@“.
The password for the master database user. This password can contain
@!attribute [rw] master_user_password
@return [String]
* Can’t be a reserved word for the chosen database engine.
* First character must be a letter.
* Must be 1 to 16 letters or numbers.
Constraints:
The name of the master user for the restored DB cluster.
@!attribute [rw] master_username
@return [Integer]
Default: ‘3306`
accept connections.
The port number on which the instances in the restored DB cluster
@!attribute [rw] port
@return [String]
Examples: `5.7.mysql_aurora.2.12.0`, `8.0.mysql_aurora.3.04.0`
**Aurora MySQL**
”DBEngineVersions[].EngineVersion“`
`aws rds describe-db-engine-versions –engine aurora-mysql –query
(Aurora MySQL), use the following command:
To list all of the available engine versions for `aurora-mysql`
The version number of the database engine to use.
@!attribute [rw] engine_version
@return [String]
Valid Values: `aurora-mysql` (for Aurora MySQL)
The name of the database engine to be used for this DB cluster.
@!attribute [rw] engine
@return [String]
Example: `mydbsubnetgroup`
DBSubnetGroup.
Constraints: If supplied, must match the name of an existing
A DB subnet group to associate with the restored DB cluster.
@!attribute [rw] db_subnet_group_name
@return [Array<String>]
cluster.
A list of EC2 VPC security groups to associate with the restored DB
@!attribute [rw] vpc_security_group_ids
@return [String]
^
DBClusterParameterGroup.
* If supplied, must match the name of an existing
Constraints:
parameter group for the engine version is used.
restored DB cluster. If this argument is omitted, the default
The name of the DB cluster parameter group to associate with the
@!attribute [rw] db_cluster_parameter_group_name
@return [String]
Example: `my-cluster1`
* Can’t end with a hyphen or contain two consecutive hyphens.
* First character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
Amazon S3 bucket. This parameter isn’t case-sensitive.
The name of the DB cluster to create from the source data in the
@!attribute [rw] db_cluster_identifier
@return [String]
The database name for the restored DB cluster.
@!attribute [rw] database_name
@return [String]
associated with the specified CharacterSet.
A value that indicates that the restored DB cluster should be
@!attribute [rw] character_set_name
@return [Integer]
^
* Must be a value from 1 to 35
Constraints:
Default: 1
cluster are retained. You must specify a minimum value of 1.
The number of days for which automated backups of the restored DB
@!attribute [rw] backup_retention_period
@return [Array<String>]
DB cluster can be created.
A list of Availability Zones (AZs) where instances in the restored
@!attribute [rw] availability_zones

class Aws::RDS::Types::RestoreDBClusterFromS3Message

Namespace

Included Modules

Defined in