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

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
}

Instance Attribute Summary collapse

#availability_zones ⇒ Array<String>

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
#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.
#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 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.
#enable_iam_database_authentication ⇒ Boolean

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
#engine ⇒ String

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

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

The KMS key identifier for an encrypted DB cluster.
#master_user_password ⇒ String

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

The name of the master user for the restored 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 AWS 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.
#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.
#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 EC2 Availability Zones that instances in the restored DB cluster can be created in.

Returns:

(Array<String>)

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

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

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

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

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)
  include Aws::Structure
end

#db_cluster_identifier ⇒ `String`

The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn’t case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: ‘my-cluster1`

Returns:

(String)

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

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)
  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, ‘default.aurora5.6` will be used.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Returns:

(String)

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

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)
  include Aws::Structure
end

#db_subnet_group_name ⇒ `String`

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

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: ‘mySubnetgroup`

Returns:

(String)

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

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)
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: ‘false`

Returns:

(Boolean)

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

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)
  include Aws::Structure
end

#engine ⇒ `String`

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

Valid Values: ‘aurora`

Returns:

(String)

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

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)
  include Aws::Structure
end

#engine_version ⇒ `String`

The version number of the database engine to use.

Aurora

Example: ‘5.6.10a`

Returns:

(String)

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

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)
  include Aws::Structure
end

#kms_key_id ⇒ `String`

The KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the ‘StorageEncrypted` parameter is true, and you do not specify a value for the `KmsKeyId` parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

Returns:

(String)

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

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

Returns:

(String)

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

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)
  include Aws::Structure
end

#master_username ⇒ `String`

The name of the master user for the restored DB cluster.

Constraints:

Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.

Returns:

(String)

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

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)
  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 cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

Returns:

(String)

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

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

Constraints:

Must be in the format ‘hh24:mi-hh24:mi`.
Times should 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/UserGuide/AdjustingTheMaintenanceWindow.html

Returns:

(String)

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

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

Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see [ Adjusting the Preferred Maintenance Window] in the *Amazon RDS User Guide.*

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

Constraints: Minimum 30-minute window.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html

Returns:

(String)

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

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

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)
  include Aws::Structure
end

#s3_ingestion_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the AWS 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 11237

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

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

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)
  include Aws::Structure
end

#source_engine_version ⇒ `String`

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

MySQL version 5.5 and 5.6 are supported.

Example: ‘5.6.22`

Returns:

(String)

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

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

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)
  include Aws::Structure
end

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

A list of tags.

Returns:

(Array<Types::Tag>)

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

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

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#availability_zones ⇒ Array<String>

#backup_retention_period ⇒ Integer

#character_set_name ⇒ String

#database_name ⇒ String

#db_cluster_identifier ⇒ String

#db_cluster_parameter_group_name ⇒ String

#db_subnet_group_name ⇒ String

#enable_iam_database_authentication ⇒ Boolean

#engine ⇒ String

#engine_version ⇒ String

#kms_key_id ⇒ String

#master_user_password ⇒ String

#master_username ⇒ 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

#source_engine ⇒ String

#source_engine_version ⇒ String

#storage_encrypted ⇒ Boolean

#tags ⇒ Array<Types::Tag>

#vpc_security_group_ids ⇒ Array<String>

#availability_zones ⇒ `Array<String>`

#backup_retention_period ⇒ `Integer`

#character_set_name ⇒ `String`

#database_name ⇒ `String`

#db_cluster_identifier ⇒ `String`

#db_cluster_parameter_group_name ⇒ `String`

#db_subnet_group_name ⇒ `String`

#enable_iam_database_authentication ⇒ `Boolean`

#engine ⇒ `String`

#engine_version ⇒ `String`

#kms_key_id ⇒ `String`

#master_user_password ⇒ `String`

#master_username ⇒ `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`

#source_engine ⇒ `String`

#source_engine_version ⇒ `String`

#storage_encrypted ⇒ `Boolean`

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

#vpc_security_group_ids ⇒ `Array<String>`