RestoreDbInstanceFromDbSnapshotRequest (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.RestoreDbInstanceFromDbSnapshotRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RestoreDbInstanceFromDbSnapshotRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`autoMinorVersionUpgrade()` Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
`String`	`availabilityZone()` The EC2 Availability Zone that the DB instance is created in.
`static RestoreDbInstanceFromDbSnapshotRequest.Builder`	`builder()`
`Boolean`	`copyTagsToSnapshot()` True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false.
`String`	`dbInstanceClass()` The compute and memory capacity of the Amazon RDS DB instance, for example, `db.m4.large`.
`String`	`dbInstanceIdentifier()` Name of the DB instance to create from the DB snapshot.
`String`	`dbName()` The database name for the restored DB instance.
`String`	`dbParameterGroupName()` The name of the DB parameter group to associate with this DB instance.
`String`	`dbSnapshotIdentifier()` The identifier for the DB snapshot to restore from.
`String`	`dbSubnetGroupName()` The DB subnet group name to use for the new instance.
`Boolean`	`deletionProtection()` Indicates if the DB instance should have deletion protection enabled.
`String`	`domain()` Specify the Active Directory Domain to restore the instance in.
`String`	`domainIAMRoleName()` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`List<String>`	`enableCloudwatchLogsExports()` The list of logs that the restored DB instance is to export to CloudWatch Logs.
`Boolean`	`enableIAMDatabaseAuthentication()` True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
`String`	`engine()` The database engine to use for the new instance.
`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()` Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.
`String`	`licenseModel()` License model information for the restored DB instance.
`Boolean`	`multiAZ()` Specifies if the DB instance is a Multi-AZ deployment.
`String`	`optionGroupName()` The name of the option group to be used for the restored DB instance.
`Integer`	`port()` The port number on which the database accepts connections.
`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()` Specifies the accessibility options for the DB instance.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RestoreDbInstanceFromDbSnapshotRequest.Builder>`	`serializableBuilderClass()`
`String`	`storageType()` Specifies the storage type to be associated with the DB instance.
`List<Tag>`	`tags()` Returns the value of the Tags property for this object.
`String`	`tdeCredentialArn()` The ARN from the key store with which to associate the instance for TDE encryption.
`String`	`tdeCredentialPassword()` The password for the given ARN from the key store in order to access the device.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Boolean`	`useDefaultProcessorFeatures()` A value that specifies that the DB instance class of the DB instance uses its default processor features.
`List<String>`	`vpcSecurityGroupIds()` A list of EC2 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
  - dbInstanceIdentifier
```
public String dbInstanceIdentifier()
```
    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
    
    Constraints:
    - Must contain from 1 to 63 numbers, letters, or hyphens
    - First character must be a letter
    - Can't end with a hyphen or contain two consecutive hyphens
    Example: my-snapshot-id
    Returns:
    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
    
    Constraints:
    
    Must contain from 1 to 63 numbers, letters, or hyphens
    
    First character must be a letter
    
    Can't end with a hyphen or contain two consecutive hyphens
    
    Example: my-snapshot-id
  - dbSnapshotIdentifier
```
public String dbSnapshotIdentifier()
```
    The identifier for the DB snapshot to restore from.
    
    Constraints:
    - Must match the identifier of an existing DBSnapshot.
    - If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
    Returns:
    The identifier for the DB snapshot to restore from.
    
    Constraints:
    
    Must match the identifier of an existing DBSnapshot.
    
    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
  - dbInstanceClass
```
public String dbInstanceClass()
```
    The compute and memory capacity of the Amazon RDS 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.
    
    Default: The same DBInstanceClass as the original DB instance.
    
    Returns:
    
    The compute and memory capacity of the Amazon RDS 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.
    
    Default: The same DBInstanceClass as the original DB instance.
  - port
```
public Integer port()
```
    The port number on which the database accepts connections.
    
    Default: The same port as the original DB instance
    
    Constraints: Value must be 1150-65535
    
    Returns:
    
    The port number on which the database accepts connections.
    
    Default: The same port as the original DB instance
    
    Constraints: Value must be 1150-65535
  - availabilityZone
```
public String availabilityZone()
```
    The EC2 Availability Zone that the DB instance is created in.
    
    Default: A random, system-chosen Availability Zone.
    
    Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true .
    
    Example: us-east-1a
    
    Returns:
    
    The EC2 Availability Zone that the DB instance is created in.
    
    Default: A random, system-chosen Availability Zone.
    
    Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
    
    Example: us-east-1a
  - dbSubnetGroupName
```
public String dbSubnetGroupName()
```
    The DB subnet group name to use for the new instance.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mySubnetgroup
    
    Returns:
    
    The DB subnet group name to use for the new instance.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mySubnetgroup
  - multiAZ
```
public Boolean multiAZ()
```
    Specifies if the DB instance is a Multi-AZ deployment.
    
    Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true .
    
    Returns:
    
    Specifies if the DB instance is a Multi-AZ deployment.
    
    Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
    
    Returns:
    
    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.
  - autoMinorVersionUpgrade
```
public Boolean autoMinorVersionUpgrade()
```
    Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
    
    Returns:
    
    Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
  - licenseModel
```
public String licenseModel()
```
    License model information for the restored DB instance.
    
    Default: Same as source.
    
    Valid values: license-included | bring-your-own-license | general-public-license
    
    Returns:
    
    License model information for the restored DB instance.
    
    Default: Same as source.
    
    Valid values: license-included | bring-your-own-license | general-public-license
  - dbName
```
public String dbName()
```
    The database name for the restored DB instance.
    
    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
    
    Returns:
    
    The database name for the restored DB instance.
    
    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
  - engine
```
public String engine()
```
    The database engine to use for the new instance.
    
    Default: The same as source
    
    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
    
    Valid Values:
    - mariadb
    - mysql
    - oracle-ee
    - oracle-se2
    - oracle-se1
    - oracle-se
    - postgres
    - sqlserver-ee
    - sqlserver-se
    - sqlserver-ex
    - sqlserver-web
    Returns:
    The database engine to use for the new instance.
    
    Default: The same as source
    
    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
    
    Valid Values:
    
    mariadb
    
    mysql
    
    oracle-ee
    
    oracle-se2
    
    oracle-se1
    
    oracle-se
    
    postgres
    
    sqlserver-ee
    
    sqlserver-se
    
    sqlserver-ex
    
    sqlserver-web
  - iops
```
public Integer iops()
```
    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
    
    The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
    
    Constraints: Must be an integer greater than 1000.
    
    Returns:
    
    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
    
    The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
    
    Constraints: Must be an integer greater than 1000.
  - optionGroupName
```
public String optionGroupName()
```
    The name of the option group to be used for the restored DB instance.
    
    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
    
    Returns:
    
    The name of the option group to be used for the restored DB instance.
    
    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
  - tags
```
public List<Tag> tags()
```
    Returns the value of the Tags property for this object.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The value of the Tags property for this object.
  - 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
  - tdeCredentialArn
```
public String tdeCredentialArn()
```
    The ARN from the key store with which to associate the instance for TDE encryption.
    
    Returns:
    
    The ARN from the key store with which to associate the instance for TDE encryption.
  - tdeCredentialPassword
```
public String tdeCredentialPassword()
```
    The password for the given ARN from the key store in order to access the device.
    
    Returns:
    
    The password for the given ARN from the key store in order to access the device.
  - vpcSecurityGroupIds
```
public List<String> vpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this DB instance.
    
    Default: The default EC2 VPC security group for the DB subnet group's VPC.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with this DB instance.
    
    Default: The default EC2 VPC security group for the DB subnet group's VPC.
  - domain
```
public String domain()
```
    Specify the Active Directory Domain to restore the instance in.
    
    Returns:
    
    Specify the Active Directory Domain to restore the instance in.
  - copyTagsToSnapshot
```
public Boolean copyTagsToSnapshot()
```
    True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.
    
    Returns:
    
    True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.
  - domainIAMRoleName
```
public String domainIAMRoleName()
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    Returns:
    
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
  - enableIAMDatabaseAuthentication
```
public Boolean enableIAMDatabaseAuthentication()
```
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    You can enable IAM database authentication for the following database engines
    - For MySQL 5.6, minor version 5.6.34 or higher
    - For MySQL 5.7, minor version 5.7.16 or higher
    Default: false
    Returns:
    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
    
    You can enable IAM database authentication for the following database engines
    
    For MySQL 5.6, minor version 5.6.34 or higher
    
    For MySQL 5.7, minor version 5.7.16 or higher
    
    Default: false
  - enableCloudwatchLogsExports
```
public 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 Aurora User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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 Aurora User Guide.
  - processorFeatures
```
public 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.
    
    Returns:
    
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
  - useDefaultProcessorFeatures
```
public Boolean useDefaultProcessorFeatures()
```
    A value that specifies that the DB instance class of the DB instance uses its default processor features.
    
    Returns:
    
    A value that specifies that the DB instance class of the DB instance uses its default processor features.
  - dbParameterGroupName
```
public String dbParameterGroupName()
```
    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
    
    Constraints:
    - If supplied, must match the name of an existing DBParameterGroup.
    - Must be 1 to 255 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't end with a hyphen or contain two consecutive hyphens.
    Returns:
    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
    
    Constraints:
    
    If supplied, must match the name of an existing DBParameterGroup.
    
    Must be 1 to 255 letters, numbers, or hyphens.
    
    First character must be a letter.
    
    Can't end with a hyphen or contain two consecutive hyphens.
  - deletionProtection
```
public Boolean deletionProtection()
```
    Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
    
    Returns:
    
    Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.
  - toBuilder
```
public RestoreDbInstanceFromDbSnapshotRequest.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<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>
    
    Specified by:
    
    toBuilder in class RdsRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RestoreDbInstanceFromDbSnapshotRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RestoreDbInstanceFromDbSnapshotRequest.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
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class RestoreDbInstanceFromDbSnapshotRequest

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

dbInstanceIdentifier

dbSnapshotIdentifier

dbInstanceClass

port

availabilityZone

dbSubnetGroupName

multiAZ

publiclyAccessible

autoMinorVersionUpgrade

licenseModel

dbName

engine

iops

optionGroupName

tags

storageType

tdeCredentialArn

tdeCredentialPassword

vpcSecurityGroupIds

domain

copyTagsToSnapshot

domainIAMRoleName

enableIAMDatabaseAuthentication

enableCloudwatchLogsExports

processorFeatures

useDefaultProcessorFeatures

dbParameterGroupName

deletionProtection

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields