Class: Aws::RDS::Types::RestoreDBClusterFromS3Message

Inherits:

Struct

Object
Struct
Aws::RDS::Types::RestoreDBClusterFromS3Message

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#availability_zones ⇒ Array<String>

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
#backtrack_window ⇒ Integer

The target backtrack window, in seconds.
#backup_retention_period ⇒ Integer

The number of days for which automated backups of the restored DB cluster are retained.
#character_set_name ⇒ String

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.
#copy_tags_to_snapshot ⇒ Boolean

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster.
#database_name ⇒ String

The database name for the restored DB cluster.
#db_cluster_identifier ⇒ String

The name of the DB cluster to create from the source data in the Amazon S3 bucket.
#db_cluster_parameter_group_name ⇒ String

The name of the DB cluster parameter group to associate with the restored DB cluster.
#db_subnet_group_name ⇒ String

A DB subnet group to associate with the restored DB cluster.
#deletion_protection ⇒ Boolean

Specifies whether to enable deletion protection for the DB cluster.
#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

Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts.
#engine ⇒ String

The name of the database engine to be used for this DB cluster.
#engine_lifecycle_support ⇒ String

The life cycle type for this DB cluster.
#engine_version ⇒ String

The version number of the database engine to use.
#kms_key_id ⇒ String

The Amazon Web Services KMS key identifier for an encrypted DB cluster.
#manage_master_user_password ⇒ Boolean

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
#master_user_password ⇒ String

The password for the master database user.
#master_user_secret_kms_key_id ⇒ String

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
#master_username ⇒ String

The name of the master user for the restored DB cluster.
#network_type ⇒ String

The network type of the DB cluster.
#option_group_name ⇒ String

A value that indicates that the restored DB cluster should be associated with the specified option group.
#port ⇒ Integer

The port number on which the instances in the restored DB cluster accept connections.
#preferred_backup_window ⇒ String

The daily time range during which automated backups are created if automated backups are enabled using the ‘BackupRetentionPeriod` parameter.
#preferred_maintenance_window ⇒ String

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
#s3_bucket_name ⇒ String

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
#s3_ingestion_role_arn ⇒ String

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.
#s3_prefix ⇒ String

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster.
#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
#source_engine ⇒ String

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
#source_engine_version ⇒ String

The version of the database that the backup files were created from.
#storage_encrypted ⇒ Boolean

Specifies whether the restored DB cluster is encrypted.
#storage_type ⇒ String

Specifies the storage type to be associated with the DB cluster.
#tags ⇒ Array<Types::Tag>

A list of tags.
#vpc_security_group_ids ⇒ Array<String>

A list of EC2 VPC security groups to associate with the restored DB cluster.

Instance Attribute Details

#availability_zones ⇒ `Array<String>`

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Returns:

(Array<String>)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#backtrack_window ⇒ `Integer`

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

Returns:

(Integer)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ `Integer`

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

Returns:

(Integer)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#character_set_name ⇒ `String`

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Returns:

(Boolean)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ `String`

The database name for the restored DB cluster.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

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`

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_parameter_group_name ⇒ `String`

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group_name ⇒ `String`

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: ‘mydbsubnetgroup`

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Specifies whether to enable deletion protection for the DB cluster. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled.

Returns:

(Boolean)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  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*.

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

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  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.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  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.

**Aurora MySQL**

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

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

Returns:

(Array<String>)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

Specifies 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*.

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

Returns:

(Boolean)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ `String`

The name of the database engine to be used for this DB cluster.

Valid Values: ‘aurora-mysql` (for Aurora MySQL)

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine_lifecycle_support ⇒ `String`

The life cycle type for this DB cluster.

<note markdown=“1”> By default, this value is set to ‘open-source-rds-extended-support`, which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to `open-source-rds-extended-support-disabled`. In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date.

</note>

You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:

Amazon Aurora - [Using Amazon RDS Extended Support] in the *Amazon Aurora User Guide*
Amazon RDS - [Using Amazon RDS Extended Support] in the *Amazon RDS User Guide*

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

Valid Values: ‘open-source-rds-extended-support | open-source-rds-extended-support-disabled`

Default: ‘open-source-rds-extended-support`

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version number of the database engine to use.

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

‘aws rds describe-db-engine-versions –engine aurora-mysql –query “DBEngineVersions[].EngineVersion”`

**Aurora MySQL**

Examples: ‘5.7.mysql_aurora.2.12.0`, `8.0.mysql_aurora.3.04.0`

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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 KMS key. To use a KMS key 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#manage_master_user_password ⇒ `Boolean`

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see [Password management with Amazon Web Services Secrets Manager] in the *Amazon RDS User Guide* and

Password management with Amazon Web Services Secrets Manager][2: in

the *Amazon Aurora User Guide.*

Constraints:

Can’t manage the master user password with Amazon Web Services Secrets Manager if ‘MasterUserPassword` is specified.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html

Returns:

(Boolean)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_password ⇒ `String`

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.
Can’t be specified if ‘ManageMasterUserPassword` is turned on.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_secret_kms_key_id ⇒ `String`

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

If you don’t specify ‘MasterUserSecretKmsKeyId`, then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the ‘aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#master_username ⇒ `String`

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.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ `String`

The network type of the DB cluster.

Valid Values:

‘IPV4`
‘DUAL`

The network type is determined by the ‘DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon Aurora User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_name ⇒ `String`

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.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ `Integer`

The port number on which the instances in the restored DB cluster accept connections.

Default: ‘3306`

Returns:

(Integer)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ `String`

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] 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]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ `String`

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

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_name ⇒ `String`

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#s3_ingestion_role_arn ⇒ `String`

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.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefix ⇒ `String`

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.

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  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*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html

Returns:

(Types::ServerlessV2ScalingConfiguration)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#source_engine ⇒ `String`

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid Values: ‘mysql`

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#source_engine_version ⇒ `String`

The version of the database that the backup files were created from.

MySQL versions 5.7 and 8.0 are supported.

Example: ‘5.7.40`, `8.0.28`

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ `Boolean`

Specifies whether the restored DB cluster is encrypted.

Returns:

(Boolean)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

Specifies the storage type to be associated with the DB cluster.

Valid Values: ‘aurora`, `aurora-iopt1`

Default: ‘aurora`

Valid for: Aurora DB clusters only

Returns:

(String)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  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* or [Tagging Amazon Aurora and Amazon RDS resources] in the *Amazon Aurora User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_ids ⇒ `Array<String>`

A list of EC2 VPC security groups to associate with the restored DB cluster.

Returns:

(Array<String>)

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

class RestoreDBClusterFromS3Message < Struct.new(
  :availability_zones,
  :backup_retention_period,
  :character_set_name,
  :database_name,
  :db_cluster_identifier,
  :db_cluster_parameter_group_name,
  :vpc_security_group_ids,
  :db_subnet_group_name,
  :engine,
  :engine_version,
  :port,
  :master_username,
  :master_user_password,
  :option_group_name,
  :preferred_backup_window,
  :preferred_maintenance_window,
  :tags,
  :storage_encrypted,
  :kms_key_id,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :backtrack_window,
  :enable_cloudwatch_logs_exports,
  :deletion_protection,
  :copy_tags_to_snapshot,
  :domain,
  :domain_iam_role_name,
  :serverless_v2_scaling_configuration,
  :network_type,
  :manage_master_user_password,
  :master_user_secret_kms_key_id,
  :storage_type,
  :engine_lifecycle_support)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::RDS::Types::RestoreDBClusterFromS3Message

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

#backtrack_window ⇒ Integer

#backup_retention_period ⇒ Integer

#character_set_name ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#database_name ⇒ String

#db_cluster_identifier ⇒ 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 ⇒ String

#engine_lifecycle_support ⇒ String

#engine_version ⇒ String

#kms_key_id ⇒ String

#manage_master_user_password ⇒ Boolean

#master_user_password ⇒ String

#master_user_secret_kms_key_id ⇒ String

#master_username ⇒ String

#network_type ⇒ String

#option_group_name ⇒ String

#port ⇒ Integer

#preferred_backup_window ⇒ String

#preferred_maintenance_window ⇒ String

#s3_bucket_name ⇒ String

#s3_ingestion_role_arn ⇒ String

#s3_prefix ⇒ String

#serverless_v2_scaling_configuration ⇒ Types::ServerlessV2ScalingConfiguration

#source_engine ⇒ String

#source_engine_version ⇒ String

#storage_encrypted ⇒ Boolean

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#vpc_security_group_ids ⇒ Array<String>

#availability_zones ⇒ `Array<String>`

#backtrack_window ⇒ `Integer`

#backup_retention_period ⇒ `Integer`

#character_set_name ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

#database_name ⇒ `String`

#db_cluster_identifier ⇒ `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 ⇒ `String`

#engine_lifecycle_support ⇒ `String`

#engine_version ⇒ `String`

#kms_key_id ⇒ `String`

#manage_master_user_password ⇒ `Boolean`

#master_user_password ⇒ `String`

#master_user_secret_kms_key_id ⇒ `String`

#master_username ⇒ `String`

#network_type ⇒ `String`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#preferred_backup_window ⇒ `String`

#preferred_maintenance_window ⇒ `String`

#s3_bucket_name ⇒ `String`

#s3_ingestion_role_arn ⇒ `String`

#s3_prefix ⇒ `String`

#serverless_v2_scaling_configuration ⇒ `Types::ServerlessV2ScalingConfiguration`

#source_engine ⇒ `String`

#source_engine_version ⇒ `String`

#storage_encrypted ⇒ `Boolean`

#storage_type ⇒ `String`

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

#vpc_security_group_ids ⇒ `Array<String>`