class Aws::RDS::Types::RestoreDBClusterFromS3Message
@note When making an API call, you may pass RestoreDBClusterFromS3Message
data as a hash: { availability_zones: ["String"], backup_retention_period: 1, character_set_name: "String", database_name: "String", db_cluster_identifier: "String", # required db_cluster_parameter_group_name: "String", vpc_security_group_ids: ["String"], db_subnet_group_name: "String", engine: "String", # required engine_version: "String", port: 1, master_username: "String", # required master_user_password: "String", # required option_group_name: "String", preferred_backup_window: "String", preferred_maintenance_window: "String", tags: [ { key: "String", value: "String", }, ], storage_encrypted: false, kms_key_id: "String", enable_iam_database_authentication: false, source_engine: "String", # required source_engine_version: "String", # required s3_bucket_name: "String", # required s3_prefix: "String", s3_ingestion_role_arn: "String", # required backtrack_window: 1, enable_cloudwatch_logs_exports: ["String"], deletion_protection: false, copy_tags_to_snapshot: false, domain: "String", domain_iam_role_name: "String", }
@!attribute [rw] availability_zones
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created. @return [Array<String>]
@!attribute [rw] backup_retention_period
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1. Default: 1 Constraints: * Must be a value from 1 to 35 ^ @return [Integer]
@!attribute [rw] character_set_name
A value that indicates that the restored DB cluster should be associated with the specified CharacterSet. @return [String]
@!attribute [rw] database_name
The database name for the restored DB cluster. @return [String]
@!attribute [rw] db_cluster_identifier
The name of the DB cluster to create from the source data in the Amazon S3 bucket. 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-cluster1` @return [String]
@!attribute [rw] db_cluster_parameter_group_name
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, `default.aurora5.6` is used. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup. ^ @return [String]
@!attribute [rw] vpc_security_group_ids
A list of EC2 VPC security groups to associate with the restored DB cluster. @return [Array<String>]
@!attribute [rw] db_subnet_group_name
A DB subnet group to associate with the restored DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: `mySubnetgroup` @return [String]
@!attribute [rw] engine
The name of the database engine to be used for this DB cluster. Valid Values: `aurora` (for MySQL 5.6-compatible Aurora), `aurora-mysql` (for MySQL 5.7-compatible Aurora), and `aurora-postgresql` @return [String]
@!attribute [rw] engine_version
The version number of the database engine to use. 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"` **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 instances in the restored DB cluster accept connections. Default: `3306` @return [Integer]
@!attribute [rw] master_username
The name of the master user for the restored DB cluster. Constraints: * Must be 1 to 16 letters or numbers. * First character must be a letter. * Can't be a reserved word for the chosen database engine. @return [String]
@!attribute [rw] master_user_password
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@". Constraints: Must contain from 8 to 41 characters. @return [String]
@!attribute [rw] option_group_name
A value that indicates that the restored DB cluster should be associated with the specified option group. Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster. @return [String]
@!attribute [rw] preferred_backup_window
The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. To view the time blocks available, see [ Backup window][1] in the *Amazon Aurora User Guide.* Constraints: * Must be in the format `hh24:mi-hh24:mi`. * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow @return [String]
@!attribute [rw] preferred_maintenance_window
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: `ddd:hh24:mi-ddd:hh24:mi` The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon Aurora User Guide.* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. Constraints: Minimum 30-minute window. [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora @return [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] storage_encrypted
A value that indicates whether the restored DB cluster is encrypted. @return [Boolean]
@!attribute [rw] kms_key_id
The Amazon Web Services KMS key identifier for 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. If the StorageEncrypted parameter is enabled, and you do not specify a value for the `KmsKeyId` parameter, then Amazon RDS will use your default CMK. There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region. @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] source_engine
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket. Valid values: `mysql` @return [String]
@!attribute [rw] source_engine_version
The version of the database that the backup files were created from. MySQL versions 5.5, 5.6, and 5.7 are supported. Example: `5.6.40`, `5.7.28` @return [String]
@!attribute [rw] s3_bucket_name
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster. @return [String]
@!attribute [rw] s3_prefix
The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a **SourceS3Prefix** value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket. @return [String]
@!attribute [rw] s3_ingestion_role_arn
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf. @return [String]
@!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] 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]
@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBClusterFromS3Message AWS API Documentation
Constants
- SENSITIVE