public static interface RestoreDbInstanceFromS3Request.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>
| Modifier and Type | Method and Description |
|---|---|
RestoreDbInstanceFromS3Request.Builder |
allocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
RestoreDbInstanceFromS3Request.Builder |
availabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in.
|
RestoreDbInstanceFromS3Request.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
RestoreDbInstanceFromS3Request.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the DB instance, for example db.m4.large.
|
RestoreDbInstanceFromS3Request.Builder |
dbInstanceIdentifier(String dbInstanceIdentifier)
The DB instance identifier.
|
RestoreDbInstanceFromS3Request.Builder |
dbName(String dbName)
The name of the database to create when the DB instance is created.
|
RestoreDbInstanceFromS3Request.Builder |
dbParameterGroupName(String dbParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
dbSecurityGroups(Collection<String> dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
dbSecurityGroups(String... dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
RestoreDbInstanceFromS3Request.Builder |
enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDbInstanceFromS3Request.Builder |
enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDbInstanceFromS3Request.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
RestoreDbInstanceFromS3Request.Builder |
enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
engine(String engine)
The name of the database engine to be used for this instance.
|
RestoreDbInstanceFromS3Request.Builder |
engineVersion(String engineVersion)
The version number of the database engine to use.
|
RestoreDbInstanceFromS3Request.Builder |
iops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB
instance.
|
RestoreDbInstanceFromS3Request.Builder |
kmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
licenseModel(String licenseModel)
The license model for this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
manageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
|
RestoreDbInstanceFromS3Request.Builder |
masterUsername(String masterUsername)
The name for the master user.
|
RestoreDbInstanceFromS3Request.Builder |
masterUserPassword(String masterUserPassword)
The password for the master user.
|
RestoreDbInstanceFromS3Request.Builder |
masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
RestoreDbInstanceFromS3Request.Builder |
maxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
|
RestoreDbInstanceFromS3Request.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
RestoreDbInstanceFromS3Request.Builder |
multiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
RestoreDbInstanceFromS3Request.Builder |
networkType(String networkType)
The network type of the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
optionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RestoreDbInstanceFromS3Request.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RestoreDbInstanceFromS3Request.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
RestoreDbInstanceFromS3Request.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
RestoreDbInstanceFromS3Request.Builder |
port(Integer port)
The port number on which the database accepts connections.
|
RestoreDbInstanceFromS3Request.Builder |
preferredBackupWindow(String preferredBackupWindow)
The time range each day during which automated backups are created if automated backups are enabled.
|
RestoreDbInstanceFromS3Request.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
RestoreDbInstanceFromS3Request.Builder |
processorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
publiclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
|
RestoreDbInstanceFromS3Request.Builder |
s3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
|
RestoreDbInstanceFromS3Request.Builder |
s3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3
bucket.
|
RestoreDbInstanceFromS3Request.Builder |
s3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
|
RestoreDbInstanceFromS3Request.Builder |
sourceEngine(String sourceEngine)
The name of the engine of your source database.
|
RestoreDbInstanceFromS3Request.Builder |
sourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
RestoreDbInstanceFromS3Request.Builder |
storageEncrypted(Boolean storageEncrypted)
A value that indicates whether the new DB instance is encrypted or not.
|
RestoreDbInstanceFromS3Request.Builder |
storageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
tags(Collection<Tag> tags)
A list of tags to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of tags to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
tags(Tag... tags)
A list of tags to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
RestoreDbInstanceFromS3Request.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildRestoreDbInstanceFromS3Request.Builder dbName(String dbName)
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance.
dbName - The name of the database to create when the DB instance is created. Follow the naming rules specified
in CreateDBInstance.RestoreDbInstanceFromS3Request.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
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
dbInstanceIdentifier - 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
RestoreDbInstanceFromS3Request.Builder allocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance.
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.
allocatedStorage - The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation
rules specified in CreateDBInstance. 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.
RestoreDbInstanceFromS3Request.Builder dbInstanceClass(String dbInstanceClass)
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.
dbInstanceClass - 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.
RestoreDbInstanceFromS3Request.Builder engine(String engine)
The name of the database engine to be used for this instance.
Valid Values: mysql
engine - The name of the database engine to be used for this instance.
Valid Values: mysql
RestoreDbInstanceFromS3Request.Builder masterUsername(String masterUsername)
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.
masterUsername - 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.
RestoreDbInstanceFromS3Request.Builder masterUserPassword(String masterUserPassword)
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword - The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
RestoreDbInstanceFromS3Request.Builder dbSecurityGroups(Collection<String> dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dbSecurityGroups - A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
RestoreDbInstanceFromS3Request.Builder dbSecurityGroups(String... dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dbSecurityGroups - A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
RestoreDbInstanceFromS3Request.Builder vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
vpcSecurityGroupIds - A list of VPC security groups to associate with this DB instance.RestoreDbInstanceFromS3Request.Builder vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
vpcSecurityGroupIds - A list of VPC security groups to associate with this DB instance.RestoreDbInstanceFromS3Request.Builder availabilityZone(String availabilityZone)
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.
availabilityZone - 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.
RestoreDbInstanceFromS3Request.Builder dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dbSubnetGroupName - A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
RestoreDbInstanceFromS3Request.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window 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.
preferredMaintenanceWindow - The time range each week during which system maintenance can occur, in Universal Coordinated Time
(UTC). For more information, see Amazon RDS Maintenance Window 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.
RestoreDbInstanceFromS3Request.Builder dbParameterGroupName(String dbParameterGroupName)
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.
dbParameterGroupName - 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.
RestoreDbInstanceFromS3Request.Builder backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. For more information, see CreateDBInstance.
backupRetentionPeriod - The number of days for which automated backups are retained. Setting this parameter to a positive
number enables backups. For more information, see CreateDBInstance.RestoreDbInstanceFromS3Request.Builder preferredBackupWindow(String preferredBackupWindow)
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.
preferredBackupWindow - 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.
RestoreDbInstanceFromS3Request.Builder port(Integer port)
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
port - The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
RestoreDbInstanceFromS3Request.Builder multiAZ(Boolean multiAZ)
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.
multiAZ - 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.RestoreDbInstanceFromS3Request.Builder engineVersion(String engineVersion)
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.
engineVersion - 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.RestoreDbInstanceFromS3Request.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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.
autoMinorVersionUpgrade - 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.RestoreDbInstanceFromS3Request.Builder licenseModel(String licenseModel)
The license model for this DB instance. Use general-public-license.
licenseModel - The license model for this DB instance. Use general-public-license.RestoreDbInstanceFromS3Request.Builder iops(Integer iops)
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 in the Amazon RDS User Guide.
iops - 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 in the Amazon RDS User Guide.RestoreDbInstanceFromS3Request.Builder optionGroupName(String optionGroupName)
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.
optionGroupName - 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.RestoreDbInstanceFromS3Request.Builder publiclyAccessible(Boolean publiclyAccessible)
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.
publiclyAccessible - 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.
RestoreDbInstanceFromS3Request.Builder tags(Collection<Tag> tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
tags - A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.RestoreDbInstanceFromS3Request.Builder tags(Tag... tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
tags - A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.RestoreDbInstanceFromS3Request.Builder tags(Consumer<Tag.Builder>... tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
This is a convenience method that creates an instance of theTag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) RestoreDbInstanceFromS3Request.Builder storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops
parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
storageType - Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the
Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
RestoreDbInstanceFromS3Request.Builder storageEncrypted(Boolean storageEncrypted)
A value that indicates whether the new DB instance is encrypted or not.
storageEncrypted - A value that indicates whether the new DB instance is encrypted or not.RestoreDbInstanceFromS3Request.Builder kmsKeyId(String kmsKeyId)
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.
kmsKeyId - 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.
RestoreDbInstanceFromS3Request.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
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.
copyTagsToSnapshot - 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.RestoreDbInstanceFromS3Request.Builder monitoringInterval(Integer monitoringInterval)
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
monitoringInterval - 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
RestoreDbInstanceFromS3Request.Builder monitoringRoleArn(String monitoringRoleArn)
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.
monitoringRoleArn - 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.
RestoreDbInstanceFromS3Request.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
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.
enableIAMDatabaseAuthentication - 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.
RestoreDbInstanceFromS3Request.Builder sourceEngine(String sourceEngine)
The name of the engine of your source database.
Valid Values: mysql
sourceEngine - The name of the engine of your source database.
Valid Values: mysql
RestoreDbInstanceFromS3Request.Builder sourceEngineVersion(String sourceEngineVersion)
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
sourceEngineVersion - 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
RestoreDbInstanceFromS3Request.Builder s3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
s3BucketName - The name of your Amazon S3 bucket that contains your database backup file.RestoreDbInstanceFromS3Request.Builder s3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
s3Prefix - The prefix of your Amazon S3 bucket.RestoreDbInstanceFromS3Request.Builder s3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
s3IngestionRoleArn - An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your
Amazon S3 bucket.RestoreDbInstanceFromS3Request.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)
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.
enablePerformanceInsights - 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.
RestoreDbInstanceFromS3Request.Builder performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
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.
performanceInsightsKMSKeyId - 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.
RestoreDbInstanceFromS3Request.Builder performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values
are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
RestoreDbInstanceFromS3Request.Builder enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
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.
enableCloudwatchLogsExports - 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.RestoreDbInstanceFromS3Request.Builder enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
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.
enableCloudwatchLogsExports - 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.RestoreDbInstanceFromS3Request.Builder processorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.RestoreDbInstanceFromS3Request.Builder processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.RestoreDbInstanceFromS3Request.Builder processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This is a convenience method that creates an instance of theProcessorFeature.Builder avoiding the need to create one
manually via ProcessorFeature.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #processorFeatures(List.
processorFeatures - a consumer that will call methods on
ProcessorFeature.Builder#processorFeatures(java.util.Collection) RestoreDbInstanceFromS3Request.Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures - A value that indicates whether the DB instance class of the DB instance uses its default processor
features.RestoreDbInstanceFromS3Request.Builder deletionProtection(Boolean deletionProtection)
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.
deletionProtection - 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.RestoreDbInstanceFromS3Request.Builder maxAllocatedStorage(Integer maxAllocatedStorage)
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.
maxAllocatedStorage - 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.
RestoreDbInstanceFromS3Request.Builder networkType(String networkType)
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.
networkType - 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.
RestoreDbInstanceFromS3Request.Builder storageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageThroughput - Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
RestoreDbInstanceFromS3Request.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
manageMasterUserPassword - A value that indicates whether to manage the master user password with Amazon Web Services Secrets
Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword is specified.
RestoreDbInstanceFromS3Request.Builder masterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB 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 you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key
is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't
use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed
KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and
managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB 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 you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager
KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account,
then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use
a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
RestoreDbInstanceFromS3Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderRestoreDbInstanceFromS3Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.