@Generated(value="software.amazon.awssdk:codegen") public final class RestoreDbInstanceFromS3Request extends RdsRequest implements ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>
| Modifier and Type | Class and Description |
|---|---|
static interface |
RestoreDbInstanceFromS3Request.Builder |
| Modifier and Type | Method and Description |
|---|---|
Integer |
allocatedStorage()
The amount of storage (in gigabytes) to allocate initially for the DB instance.
|
Boolean |
autoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
availabilityZone()
The Availability Zone that the DB instance is created in.
|
Integer |
backupRetentionPeriod()
The number of days for which automated backups are retained.
|
static RestoreDbInstanceFromS3Request.Builder |
builder() |
Boolean |
copyTagsToSnapshot()
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance.
|
String |
dbInstanceClass()
The compute and memory capacity of the DB instance, for example,
db.m4.large. |
String |
dbInstanceIdentifier()
The DB instance identifier.
|
String |
dbName()
The name of the database to create when the DB instance is created.
|
String |
dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
List<String> |
dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
|
String |
dbSubnetGroupName()
A DB subnet group to associate with this DB instance.
|
Boolean |
deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
List<String> |
enableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
Boolean |
enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
enablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
String |
engine()
The name of the database engine to be used for this instance.
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDbSecurityGroups()
Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasProcessorFeatures()
Returns true if the ProcessorFeatures property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Integer |
iops()
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.
|
String |
kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
|
String |
licenseModel()
The license model for this DB instance.
|
String |
masterUsername()
The name for the master user.
|
String |
masterUserPassword()
The password for the master user.
|
Integer |
maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
String |
optionGroupName()
The name of the option group to associate with this DB instance.
|
String |
performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
Integer |
port()
The port number on which the database accepts connections.
|
String |
preferredBackupWindow()
The time range each day during which automated backups are created if automated backups are enabled.
|
String |
preferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
List<ProcessorFeature> |
processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Boolean |
publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
String |
s3BucketName()
The name of your Amazon S3 bucket that contains your database backup file.
|
String |
s3IngestionRoleArn()
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
|
String |
s3Prefix()
The prefix of your Amazon S3 bucket.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestoreDbInstanceFromS3Request.Builder> |
serializableBuilderClass() |
String |
sourceEngine()
The name of the engine of your source database.
|
String |
sourceEngineVersion()
The version of the database that the backup files were created from.
|
Boolean |
storageEncrypted()
A value that indicates whether the new DB instance is encrypted or not.
|
String |
storageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
tags()
A list of tags to associate with this DB instance.
|
RestoreDbInstanceFromS3Request.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
useDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
List<String> |
vpcSecurityGroupIds()
A list of VPC security groups to associate with this DB instance.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String dbName()
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance.
CreateDBInstance.public final 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
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
public final Integer allocatedStorage()
The amount of storage (in gigabytes) 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.
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.
public final 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 AWS 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.
db.m4.large. Not all DB
instance classes are available in all AWS 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.
public final String engine()
The name of the database engine to be used for this instance.
Valid Values: mysql
Valid Values: mysql
public final 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.
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.
public final String masterUserPassword()
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Constraints: Must contain from 8 to 41 characters.
public final boolean hasDbSecurityGroups()
public final List<String> dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDbSecurityGroups() to see if a value was sent in this field.
Default: The default DB security group for the database engine.
public final boolean hasVpcSecurityGroupIds()
public final List<String> vpcSecurityGroupIds()
A list of VPC security groups to associate with this DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
public final String availabilityZone()
The Availability Zone that the DB instance is created in. For information about AWS 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 AWS 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 AWS Region as the current endpoint.
Default: A random, system-chosen Availability Zone in the endpoint's AWS 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 AWS Region as the current
endpoint.
public final String dbSubnetGroupName()
A DB subnet group to associate with this DB instance.
public final 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.
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.
public final 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.
If you do not specify a value for DBParameterGroupName, then the default
DBParameterGroup for the specified DB engine is used.
public final 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.
CreateDBInstance.public final 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.
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.
public final Integer port()
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150-65535
Default: 3306
Type: Integer
Valid Values: 1150-65535
Default: 3306
public final 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.
AvailabilityZone parameter.public final 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.
CreateDBInstance, or call
DescribeDBEngineVersions.public final 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.
public final String licenseModel()
The license model for this DB instance. Use general-public-license.
general-public-license.public final 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 to Improve Performance in the Amazon RDS User Guide.
public final 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.
public final Boolean publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and 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, and 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.
public final boolean hasTags()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags() to see if a value was sent in this field.
public final String storageType()
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
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
public final Boolean storageEncrypted()
A value that indicates whether the new DB instance is encrypted or not.
public final String kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 CMK. There is a default CMK for your AWS
account. Your AWS account has a different default CMK for each AWS Region.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS 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 CMK. There is a default CMK for
your AWS account. Your AWS account has a different default CMK for each AWS Region.
public final 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.
public final 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
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
public final 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.
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.
public final Boolean enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public final String sourceEngine()
The name of the engine of your source database.
Valid Values: mysql
Valid Values: mysql
public final 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
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
public final String s3BucketName()
The name of your Amazon S3 bucket that contains your database backup file.
public final String s3Prefix()
The prefix of your Amazon S3 bucket.
public final String s3IngestionRoleArn()
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
public final 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 Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public final String performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default
CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS
Region.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your
default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK
for each AWS Region.
public final Integer performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public final boolean hasEnableCloudwatchLogsExports()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
public final boolean hasProcessorFeatures()
public final List<ProcessorFeature> processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProcessorFeatures() to see if a value was sent in this field.
public final Boolean useDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
public final 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 is disabled. For more information, see Deleting a DB Instance.
public final Integer maxAllocatedStorage()
The upper limit 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.
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.
public RestoreDbInstanceFromS3Request.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>toBuilder in class RdsRequestpublic static RestoreDbInstanceFromS3Request.Builder builder()
public static Class<? extends RestoreDbInstanceFromS3Request.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.