Class: Aws::RDS::Types::RestoreDBInstanceFromS3Message

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass RestoreDBInstanceFromS3Message data as a hash:

{
  db_name: "String",
  db_instance_identifier: "String", # required
  allocated_storage: 1,
  db_instance_class: "String", # required
  engine: "String", # required
  master_username: "String",
  master_user_password: "String",
  db_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  availability_zone: "String",
  db_subnet_group_name: "String",
  preferred_maintenance_window: "String",
  db_parameter_group_name: "String",
  backup_retention_period: 1,
  preferred_backup_window: "String",
  port: 1,
  multi_az: false,
  engine_version: "String",
  auto_minor_version_upgrade: false,
  license_model: "String",
  iops: 1,
  option_group_name: "String",
  publicly_accessible: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  storage_encrypted: false,
  kms_key_id: "String",
  copy_tags_to_snapshot: false,
  monitoring_interval: 1,
  monitoring_role_arn: "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
  enable_performance_insights: false,
  performance_insights_kms_key_id: "String",
  performance_insights_retention_period: 1,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  deletion_protection: false,
  max_allocated_storage: 1,
  network_type: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in `CreateDBInstance`.

<note markdown=“1”> Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

</note>

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see [Regions and Availability Zones] in the *Amazon RDS User Guide.*

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.

Example: `us-east-1d`

Constraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.

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

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_periodInteger

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see `CreateDBInstance`.

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_classString

The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB Instance Class] in the *Amazon RDS User Guide.*

Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

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

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifierString

The DB instance identifier. This parameter is stored as a lowercase string.

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: `mydbinstance`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

The name of the database to create when the DB instance is created. Follow the naming rules specified in `CreateDBInstance`.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_parameter_group_nameString

The name of the DB parameter group to associate with this DB instance.

If you do not specify a value for `DBParameterGroupName`, then the default `DBParameterGroup` for the specified DB engine is used.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_security_groupsArray<String>

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

Returns:

  • (Array<String>)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group_nameString

A DB subnet group to associate with this DB instance.

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

Example: `mydbsubnetgroup`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [ Deleting a DB Instance].

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

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_cloudwatch_logs_exportsArray<String>

The list of logs that the restored DB instance 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] in the *Amazon RDS User Guide*.

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

Returns:

  • (Array<String>)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

A value that indicates 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 about IAM database authentication, see [ IAM Database Authentication for MySQL and PostgreSQL] in the *Amazon RDS User Guide.*

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

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_performance_insightsBoolean

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see [Using Amazon Performance Insights] in the *Amazon RDS User Guide.*.

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

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

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

Valid Values: `mysql`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#engine_versionString

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see [Amazon RDS Provisioned IOPS Storage to Improve Performance] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

The Amazon Web Services KMS key identifier for an encrypted DB instance.

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)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#license_modelString

The license model for this DB instance. Use `general-public-license`.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_passwordString

The password for the master user. The password can include any printable ASCII character except “/”, “”“, or ”@“.

Constraints: Must contain from 8 to 41 characters.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#master_usernameString

The name for the master user.

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)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_allocated_storageInteger

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling] in the *Amazon RDS User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_intervalInteger

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

If `MonitoringRoleArn` is specified, then you must also set `MonitoringInterval` to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

Default: `0`

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#monitoring_role_arnString

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, `arn:aws:iam:123456789012:role/emaccess`. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring] in the *Amazon RDS User Guide.*

If `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azBoolean

A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the `AvailabilityZone` parameter.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

The network type of the DB instance.

Valid values:

  • `IPV4`

  • `DUAL`

The network type is determined by the `DBSubnetGroup` specified for the DB instance. 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 RDS User Guide.*

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

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_nameString

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_idString

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for `PerformanceInsightsKMSKeyId`, then Amazon RDS uses 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)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_retention_periodInteger

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port number on which the database accepts connections.

Type: Integer

Valid Values: `1150`-`65535`

Default: `3306`

Returns:

  • (Integer)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_windowString

The time range each day during which automated backups are created if automated backups are enabled. For more information, see [Backup window] in the *Amazon RDS 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/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_windowString

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see

Amazon RDS Maintenance Window][1

in the *Amazon RDS User Guide.*

Constraints:

  • Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.

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

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred backup window.

  • Must be at least 30 minutes.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#processor_featuresArray<Types::ProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Returns:


21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_nameString

The name of your Amazon S3 bucket that contains your database backup file.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3_ingestion_role_arnString

An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3_prefixString

The prefix of your Amazon S3 bucket.

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_engineString

The name of the engine of your source database.

Valid Values: `mysql`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_engine_versionString

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

MySQL versions 5.6 and 5.7 are supported.

Example: `5.6.40`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encryptedBoolean

A value that indicates whether the new DB instance is encrypted or not.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

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

Valid values: `standard` | `gp2` | `io1`

If you specify `io1`, you must also include a value for the `Iops` parameter.

Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`

Returns:

  • (String)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to associate with this DB instance. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

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

Returns:


21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_processor_featuresBoolean

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Returns:

  • (Boolean)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

A list of VPC security groups to associate with this DB instance.

Returns:

  • (Array<String>)

21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
# File 'lib/aws-sdk-rds/types.rb', line 21823

class RestoreDBInstanceFromS3Message < Struct.new(
  :db_name,
  :db_instance_identifier,
  :allocated_storage,
  :db_instance_class,
  :engine,
  :master_username,
  :master_user_password,
  :db_security_groups,
  :vpc_security_group_ids,
  :availability_zone,
  :db_subnet_group_name,
  :preferred_maintenance_window,
  :db_parameter_group_name,
  :backup_retention_period,
  :preferred_backup_window,
  :port,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :license_model,
  :iops,
  :option_group_name,
  :publicly_accessible,
  :tags,
  :storage_type,
  :storage_encrypted,
  :kms_key_id,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :monitoring_role_arn,
  :enable_iam_database_authentication,
  :source_engine,
  :source_engine_version,
  :s3_bucket_name,
  :s3_prefix,
  :s3_ingestion_role_arn,
  :enable_performance_insights,
  :performance_insights_kms_key_id,
  :performance_insights_retention_period,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :deletion_protection,
  :max_allocated_storage,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end