class Aws::RDS::Types::RestoreDBInstanceFromS3Message

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

protocol or the IPv4 and the IPv6 protocols (‘DUAL`).
the DB instance. A `DBSubnetGroup` can support only the IPv4
The network type is determined by the `DBSubnetGroup` specified for
* `DUAL`
* `IPV4`
Valid Values:
The network type of the DB instance.
@!attribute [rw] network_type
@return [Integer] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling storage autoscaling] in the *Amazon RDS User Guide*.
apply to it, see [ Managing capacity automatically with Amazon RDS
For more information about this setting, including limitations that
automatically scale the storage of the DB instance.
The upper limit in gibibytes (GiB) to which Amazon RDS can
@!attribute [rw] max_allocated_storage
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html information, see [ Deleting a DB Instance].
By default, deletion protection isn’t enabled. For more
The database can’t be deleted when deletion protection is enabled.
Specifies whether to enable deletion protection for the DB instance.
@!attribute [rw] deletion_protection
@return [Boolean]
default processor features.
Specifies whether the DB instance class of the DB instance uses its
@!attribute [rw] use_default_processor_features
@return [Array<Types::ProcessorFeature>]
DB instance class of the DB instance.
The number of CPU cores and the number of threads per core for the
@!attribute [rw] processor_features
@return [Array<String>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch Amazon CloudWatch Logs] in the *Amazon RDS User Guide*.
being used. For more information, see [Publishing Database Logs to
CloudWatch Logs. The values in the list depend on the DB engine
The list of logs that the restored DB instance is to export to
@!attribute [rw] enable_cloudwatch_logs_exports
@return [Integer]
value, RDS issues an error.
If you specify a retention period such as 94, which isn’t a valid
* 731
* 589 (19 months * 31)
* 341 (11 months * 31)
* 93 (3 months * 31)
For example, the following values are valid:
* 731
* month * 31, where month is a number of months from 1-23
* 7
is 7 days. The following values are valid:
The number of days to retain Performance Insights data. The default
@!attribute [rw] performance_insights_retention_period
@return [String]
Region.
account has a different default KMS key for each Amazon Web Services
key for your Amazon Web Services account. Your Amazon Web Services
then Amazon RDS uses your default KMS key. There is a default KMS
If you do not specify a value for ‘PerformanceInsightsKMSKeyId`,
alias ARN, or alias name for the KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID,
Performance Insights data.
The Amazon Web Services KMS key identifier for encryption of
@!attribute [rw] performance_insights_kms_key_id
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html the *Amazon RDS User Guide*.
For more information, see [Using Amazon Performance Insights] in
instance.
Specifies whether to enable Performance Insights for the DB
@!attribute [rw] enable_performance_insights
@return [String]
allow Amazon RDS to access your Amazon S3 bucket.
An Amazon Web Services Identity and Access Management (IAM) role to
@!attribute [rw] s3_ingestion_role_arn
@return [String]
The prefix of your Amazon S3 bucket.
@!attribute [rw] s3_prefix
@return [String]
file.
The name of your Amazon S3 bucket that contains your database backup
@!attribute [rw] s3_bucket_name
@return [String]
Example: `5.6.40`
MySQL versions 5.6 and 5.7 are supported.
The version of the database that the backup files were created from.
@!attribute [rw] source_engine_version
@return [String]
Valid Values: `mysql`
The name of the engine of your source database.
@!attribute [rw] source_engine
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html RDS User Guide.*
Database Authentication for MySQL and PostgreSQL] in the *Amazon
For more information about IAM database authentication, see [ IAM
default, mapping isn’t enabled.
and Access Management (IAM) accounts to database accounts. By
Specifies whether to enable mapping of Amazon Web Services Identity
@!attribute [rw] enable_iam_database_authentication
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling must supply a ‘MonitoringRoleArn` value.
If `MonitoringInterval` is set to a value other than 0, then you Monitoring] in the *Amazon RDS User Guide.*
creating a monitoring role, see [Setting Up and Enabling Enhanced
`arn:aws:iam:123456789012:role/emaccess`. For information on
monitoring metrics to Amazon CloudWatch Logs. For example,
The ARN for the IAM role that permits RDS to send enhanced
@!attribute [rw] monitoring_role_arn
@return [Integer]
Default: `0`
Valid Values: 0, 1, 5, 10, 15, 30, 60
`MonitoringInterval` to a value other than 0.
If `MonitoringRoleArn` is specified, then you must also set
Enhanced Monitoring metrics, specify 0.
metrics are collected for the DB instance. To disable collecting
The interval, in seconds, between points when Enhanced Monitoring
@!attribute [rw] monitoring_interval
@return [Boolean]
of the DB instance. By default, tags are not copied.
Specifies whether to copy all tags from the DB instance to snapshots
@!attribute [rw] copy_tags_to_snapshot
@return [String]
different default KMS key for each Amazon Web Services Region.
Web Services account. Your Amazon Web Services account has a
use your default KMS key. There is a default KMS key for your Amazon
specify a value for the `KmsKeyId` parameter, then Amazon RDS will
If the `StorageEncrypted` parameter is enabled, and you do not
ARN.
different Amazon Web Services account, specify the key ARN or alias
alias ARN, or alias name for the KMS key. To use a KMS key in a
The Amazon Web Services KMS key identifier is the key ARN, key ID,
instance.
The Amazon Web Services KMS key identifier for an encrypted DB
@!attribute [rw] kms_key_id
@return [Boolean]
Specifies whether the new DB instance is encrypted or not.
@!attribute [rw] storage_encrypted
@return [String]
Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`
for the `Iops` parameter.
If you specify `io1`, `io2`, or `gp3`, you must also include a value
Valid Values: `gp2 | gp3 | io1 | io2 | standard`
Specifies the storage type to be associated with the DB instance.
@!attribute [rw] storage_type
@return [Array<Types::Tag>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html RDS User Guide.*
information, see [Tagging Amazon RDS Resources] in the *Amazon
A list of tags to associate with this DB instance. For more
@!attribute [rw] tags
@return [Boolean]
For more information, see CreateDBInstance.
DB instance with a DNS name that resolves to a private IP address.
When the DB instance isn’t publicly accessible, it is an internal
to the DB instance doesn’t permit it.
That public access is not permitted if the security group assigned
instance is ultimately controlled by the security group it uses.
IP address from outside of the DB instance’s VPC. Access to the DB
instance’s virtual private cloud (VPC). It resolves to the public
(DNS) endpoint resolves to the private IP address from within the DB
When the DB instance is publicly accessible, its Domain Name System
Specifies whether the DB instance is publicly accessible.
@!attribute [rw] publicly_accessible
@return [String]
engine is used.
this argument is omitted, the default option group for the specified
The name of the option group to associate with this DB instance. If
@!attribute [rw] option_group_name
@return [Integer] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS the *Amazon RDS User Guide.*
valid IOPS values, see [Amazon RDS Provisioned IOPS storage] in
to allocate initially for the DB instance. For information about
The amount of Provisioned IOPS (input/output operations per second)
@!attribute [rw] iops
@return [String]
‘general-public-license`.
The license model for this DB instance. Use
@!attribute [rw] license_model
@return [Boolean]
engine upgrades are not applied automatically.
the DB instance during the maintenance window. By default, minor
Specifies whether to automatically apply minor engine upgrades to
@!attribute [rw] auto_minor_version_upgrade
@return [String]
`DescribeDBEngineVersions`.
versions, see `CreateDBInstance`, or call
minor version of your database engine. For information about engine
The version number of the database engine to use. Choose the latest
@!attribute [rw] engine_version
@return [Boolean]
`AvailabilityZone` parameter.
DB instance is a Multi-AZ deployment, you can’t set the
Specifies whether the DB instance is a Multi-AZ deployment. If the
@!attribute [rw] multi_az
@return [Integer]
Default: ‘3306`
Valid Values: `1150`-`65535`
Type: Integer
The port number on which the database accepts connections.
@!attribute [rw] port
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow * Must be at least 30 minutes.
* Must not conflict with the preferred maintenance window.
* Must be in Universal Coordinated Time (UTC).
* Must be in the format `hh24:mi-hh24:mi`. Constraints: window] in the *Amazon RDS User Guide.*
if automated backups are enabled. For more information, see [Backup
The time range each day during which automated backups are created
@!attribute [rw] preferred_backup_window
@return [Integer]
information, see `CreateDBInstance`.
this parameter to a positive number enables backups. For more
The number of days for which automated backups are retained. Setting
@!attribute [rw] backup_retention_period
@return [String]
default `DBParameterGroup` for the specified DB engine is used.
If you do not specify a value for `DBParameterGroupName`, then the
instance.
The name of the DB parameter group to associate with this DB
@!attribute [rw] db_parameter_group_name
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance * Must be at least 30 minutes.
* Must not conflict with the preferred backup window.
* Must be in Universal Coordinated Time (UTC).
* Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
* Must be in the format `ddd:hh24:mi-ddd:hh24:mi`.
Constraints:
[Amazon RDS Maintenance Window] in the *Amazon RDS User Guide.*
in Universal Coordinated Time (UTC). For more information, see
The time range each week during which system maintenance can occur,
@!attribute [rw] preferred_maintenance_window
@return [String]
Example: `mydbsubnetgroup`
DBSubnetGroup.
Constraints: If supplied, must match the name of an existing
A DB subnet group to associate with this DB instance.
@!attribute [rw] db_subnet_group_name
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html endpoint.
Zone must be in the same Amazon Web Services Region as the current
the DB instance is a Multi-AZ deployment. The specified Availability
Constraint: The `AvailabilityZone` parameter can’t be specified if
Example: ‘us-east-1d`
endpoint’s Amazon Web Services Region.
Default: A random, system-chosen Availability Zone in the
User Guide.*
Zones, see [Regions and Availability Zones] in the *Amazon RDS
information about Amazon Web Services Regions and Availability
The Availability Zone that the DB instance is created in. For
@!attribute [rw] availability_zone
@return [Array<String>]
A list of VPC security groups to associate with this DB instance.
@!attribute [rw] vpc_security_group_ids
@return [Array<String>]
Default: The default DB security group for the database engine.
A list of DB security groups to associate with this DB instance.
@!attribute [rw] db_security_groups
@return [String]
* RDS for PostgreSQL - Must contain from 8 to 128 characters.
* RDS for Oracle - Must contain from 8 to 30 characters.
* RDS for MySQL - Must contain from 8 to 41 characters.
characters.
* RDS for Microsoft SQL Server - Must contain from 8 to 128
* RDS for MariaDB - Must contain from 8 to 41 characters.
* RDS for Db2 - Must contain from 8 to 128 characters.
Length Constraints:
(ampersand) or the “‘” (single quotes) character.
“@”. For RDS for Oracle, can’t include the “&”
* Can include any printable ASCII character except “/”, “”“, or
* Can’t be specified if ‘ManageMasterUserPassword` is turned on.
Constraints:
The password for the master user.
@!attribute [rw] master_user_password
@return [String]
* Can’t be a reserved word for the chosen database engine.
* First character must be a letter.
* Must be 1 to 16 letters or numbers.
Constraints:
The name for the master user.
@!attribute [rw] master_username
@return [String]
Valid Values: ‘mysql`
The name of the database engine to be used for this instance.
@!attribute [rw] engine
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html instance class.
Importing from Amazon S3 isn’t supported on the db.t2.micro DB
Instance Class] in the *Amazon RDS User Guide.*
of DB instance classes, and availability for your engine, see [DB
Web Services Regions, or for all database engines. For the full list
db.m4.large. Not all DB instance classes are available in all Amazon
The compute and memory capacity of the DB instance, for example
@!attribute [rw] db_instance_class
@return [Integer]
</note>
storage for future growth.
the restore operation can succeed. You can also allocate additional
<note markdown=”1“> Be sure to allocate enough storage for your new DB instance so that
`CreateDBInstance`.
DB instance. Follow the allocation rules specified in
The amount of storage (in gibibytes) to allocate initially for the
@!attribute [rw] allocated_storage
@return [String]
Example: ‘mydbinstance`
* Can’t end with a hyphen or contain two consecutive hyphens.
* First character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
string.
The DB instance identifier. This parameter is stored as a lowercase
@!attribute [rw] db_instance_identifier
@return [String]
Follow the naming rules specified in ‘CreateDBInstance`.
The name of the database to create when the DB instance is created.
@!attribute [rw] db_name

class Aws::RDS::Types::RestoreDBInstanceFromS3Message

Namespace

Included Modules

Defined in