RestoreDbInstanceFromS3Request (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.rds.model.RdsRequest
    - - software.amazon.awssdk.services.rds.model.RestoreDbInstanceFromS3Request

All Implemented Interfaces:: ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>

@Generated(value="software.amazon.awssdk:codegen")
public final class RestoreDbInstanceFromS3Request
extends RdsRequest
implements ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RestoreDbInstanceFromS3Request.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RestoreDbInstanceFromS3Request.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`allocatedStorage()` The amount of storage (in gigabytes) to allocate initially for the DB instance.
`Boolean`	`autoMinorVersionUpgrade()` True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
`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()` True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
`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`	`enableIAMDatabaseAuthentication()` True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`Boolean`	`enablePerformanceInsights()` True to enable Performance Insights for the DB instance, and otherwise false.
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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`	`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()` Specifies 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`	`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).
`Boolean`	`publiclyAccessible()` Specifies whether the DB instance is publicly accessible or not.
`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.
`static Class<? extends RestoreDbInstanceFromS3Request.Builder>`	`serializableBuilderClass()`
`String`	`sourceEngine()` The name of the engine of your source database.
`String`	`sourceEngineVersion()` The engine version of your source database.
`Boolean`	`storageEncrypted()` Specifies 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<String>`	`vpcSecurityGroupIds()` A list of VPC security groups to associate with this DB instance.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dbName
```
public String dbName()
```
    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
    
    Returns:
    
    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.
  - dbInstanceIdentifier
```
public 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.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: mydbinstance
    Returns:
    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.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: mydbinstance
  - allocatedStorage
```
public 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.
    
    Returns:
    
    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.
  - dbInstanceClass
```
public 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 is not supported on the db.t2.micro DB instance class.
    
    Returns:
    
    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 is not supported on the db.t2.micro DB instance class.
  - engine
```
public String engine()
```
    The name of the database engine to be used for this instance.
    
    Valid Values: mysql
    
    Returns:
    
    The name of the database engine to be used for this instance.
    
    Valid Values: mysql
  - masterUsername
```
public String masterUsername()
```
    The name for the master user.
    
    Constraints:
    - Must be 1 to 16 letters or numbers.
    - First character must be a letter.
    - Cannot be a reserved word for the chosen database engine.
    Returns:
    The name for the master user.
    
    Constraints:
    
    Must be 1 to 16 letters or numbers.
    
    First character must be a letter.
    
    Cannot be a reserved word for the chosen database engine.
  - masterUserPassword
```
public 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.
    
    Returns:
    
    The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
    
    Constraints: Must contain from 8 to 41 characters.
  - dbSecurityGroups
```
public 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.
    
    Returns:
    
    A list of DB security groups to associate with this DB instance.
    
    Default: The default DB security group for the database engine.
  - vpcSecurityGroupIds
```
public 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.
    
    Returns:
    
    A list of VPC security groups to associate with this DB instance.
  - availabilityZone
```
public 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.
    
    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 MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
    
    Returns:
    
    The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones.
    
    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 MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
  - dbSubnetGroupName
```
public String dbSubnetGroupName()
```
    A DB subnet group to associate with this DB instance.
    
    Returns:
    
    A DB subnet group to associate with this DB instance.
  - preferredMaintenanceWindow
```
public 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.
    
    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.
    Returns:
    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
    
    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.
  - dbParameterGroupName
```
public String dbParameterGroupName()
```
    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
    
    Returns:
    
    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
  - backupRetentionPeriod
```
public 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.
    
    Returns:
    
    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.
  - preferredBackupWindow
```
public String preferredBackupWindow()
```
    The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window.
    
    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.
    Returns:
    The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window.
    
    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.
  - port
```
public Integer port()
```
    The port number on which the database accepts connections.
    
    Type: Integer
    
    Valid Values: 1150-65535
    
    Default: 3306
    
    Returns:
    
    The port number on which the database accepts connections.
    
    Type: Integer
    
    Valid Values: 1150-65535
    
    Default: 3306
  - multiAZ
```
public Boolean multiAZ()
```
    Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.
    
    Returns:
    
    Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.
  - engineVersion
```
public String engineVersion()
```
    The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance.
    
    Returns:
    
    The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance.
  - autoMinorVersionUpgrade
```
public Boolean autoMinorVersionUpgrade()
```
    True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
    
    Default: true
    
    Returns:
    
    True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
    
    Default: true
  - licenseModel
```
public String licenseModel()
```
    The license model for this DB instance. Use general-public-license.
    
    Returns:
    
    The license model for this DB instance. Use general-public-license.
  - iops
```
public 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 see Amazon RDS Provisioned IOPS Storage to Improve Performance.
    
    Returns:
    
    The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance.
  - optionGroupName
```
public 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.
    
    Returns:
    
    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.
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance.
    
    Returns:
    
    Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance.
  - tags
```
public List<Tag> tags()
```
    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
  - storageType
```
public 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 standard
    
    Returns:
    
    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 standard
  - storageEncrypted
```
public Boolean storageEncrypted()
```
    Specifies whether the new DB instance is encrypted or not.
    
    Returns:
    
    Specifies whether the new DB instance is encrypted or not.
  - kmsKeyId
```
public String kmsKeyId()
```
    The AWS KMS key identifier for an encrypted DB instance.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
    
    Returns:
    
    The AWS KMS key identifier for an encrypted DB instance.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
    
    If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
  - copyTagsToSnapshot
```
public Boolean copyTagsToSnapshot()
```
    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
    
    Default: false.
    
    Returns:
    
    True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
    
    Default: false.
  - monitoringInterval
```
public 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
    
    Returns:
    
    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
  - monitoringRoleArn
```
public 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.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
    
    Returns:
    
    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.
    
    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
  - enableIAMDatabaseAuthentication
```
public Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
    
    Returns:
    
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    Default: false
  - sourceEngine
```
public String sourceEngine()
```
    The name of the engine of your source database.
    
    Valid Values: mysql
    
    Returns:
    
    The name of the engine of your source database.
    
    Valid Values: mysql
  - sourceEngineVersion
```
public String sourceEngineVersion()
```
    The engine version of your source database.
    
    Valid Values: 5.6
    
    Returns:
    
    The engine version of your source database.
    
    Valid Values: 5.6
  - s3BucketName
```
public String s3BucketName()
```
    The name of your Amazon S3 bucket that contains your database backup file.
    
    Returns:
    
    The name of your Amazon S3 bucket that contains your database backup file.
  - s3Prefix
```
public String s3Prefix()
```
    The prefix of your Amazon S3 bucket.
    
    Returns:
    
    The prefix of your Amazon S3 bucket.
  - s3IngestionRoleArn
```
public String s3IngestionRoleArn()
```
    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
    
    Returns:
    
    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
  - enablePerformanceInsights
```
public Boolean enablePerformanceInsights()
```
    True to enable Performance Insights for the DB instance, and otherwise false.
    
    Returns:
    
    True to enable Performance Insights for the DB instance, and otherwise false.
  - performanceInsightsKMSKeyId
```
public String performanceInsightsKMSKeyId()
```
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
    
    Returns:
    
    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
  - toBuilder
```
public RestoreDbInstanceFromS3Request.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RestoreDbInstanceFromS3Request.Builder,RestoreDbInstanceFromS3Request>
    
    Specified by:
    
    toBuilder in class RdsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RestoreDbInstanceFromS3Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbInstanceFromS3Request.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class RestoreDbInstanceFromS3Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dbName

dbInstanceIdentifier

allocatedStorage

dbInstanceClass

engine

masterUsername

masterUserPassword

dbSecurityGroups

vpcSecurityGroupIds

availabilityZone

dbSubnetGroupName

preferredMaintenanceWindow

dbParameterGroupName

backupRetentionPeriod

preferredBackupWindow

port

multiAZ

engineVersion

autoMinorVersionUpgrade

licenseModel

iops

optionGroupName

publiclyAccessible

tags

storageType

storageEncrypted

kmsKeyId

copyTagsToSnapshot

monitoringInterval

monitoringRoleArn

enableIAMDatabaseAuthentication

sourceEngine

sourceEngineVersion

s3BucketName

s3Prefix

s3IngestionRoleArn

enablePerformanceInsights

performanceInsightsKMSKeyId

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField