RestoreDbInstanceFromDbSnapshotRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>, RdsRequest.Builder, SdkBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RestoreDbInstanceFromDbSnapshotRequest
```
public static interface RestoreDbInstanceFromDbSnapshotRequest.Builder
extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbInstanceFromDbSnapshotRequest.Builder,RestoreDbInstanceFromDbSnapshotRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)` A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`availabilityZone(String availabilityZone)` The Availability Zone (AZ) where the DB instance will be created.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`backupTarget(String backupTarget)` Specifies where automated backups and manual snapshots are stored for the restored DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`customIamInstanceProfile(String customIamInstanceProfile)` The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbInstanceClass(String dbInstanceClass)` The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbInstanceIdentifier(String dbInstanceIdentifier)` Name of the DB instance to create from the DB snapshot.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbName(String dbName)` The database name for the restored DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbParameterGroupName(String dbParameterGroupName)` The name of the DB parameter group to associate with this DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbSnapshotIdentifier(String dbSnapshotIdentifier)` The identifier for the DB snapshot to restore from.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)` The DB subnet group name to use for the new instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`deletionProtection(Boolean deletionProtection)` A value that indicates whether the DB instance has deletion protection enabled.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`domain(String domain)` Specify the Active Directory directory ID to restore the DB instance in.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`domainIAMRoleName(String domainIAMRoleName)` Specify the name of the IAM role to be used when making API calls to the Directory Service.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)` The list of logs that the restored DB instance is to export to CloudWatch Logs.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)` The list of logs that the restored DB instance is to export to CloudWatch Logs.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`enableCustomerOwnedIp(Boolean enableCustomerOwnedIp)` A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.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.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`engine(String engine)` The database engine to use for the new instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`iops(Integer iops)` Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`licenseModel(String licenseModel)` License model information for the restored DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`multiAZ(Boolean multiAZ)` A value that indicates whether the DB instance is a Multi-AZ deployment.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`optionGroupName(String optionGroupName)` The name of the option group to be used for the restored DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`port(Integer port)` The port number on which the database accepts connections.
`RestoreDbInstanceFromDbSnapshotRequest.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.
`RestoreDbInstanceFromDbSnapshotRequest.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.
`RestoreDbInstanceFromDbSnapshotRequest.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.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`publiclyAccessible(Boolean publiclyAccessible)` A value that indicates whether the DB instance is publicly accessible.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`storageType(String storageType)` Specifies the storage type to be associated with the DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`tags(Collection<Tag> tags)` Sets the value of the Tags property for this object.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` Sets the value of the Tags property for this object.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`tags(Tag... tags)` Sets the value of the Tags property for this object.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`tdeCredentialArn(String tdeCredentialArn)` The ARN from the key store with which to associate the instance for TDE encryption.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`tdeCredentialPassword(String tdeCredentialPassword)` The password for the given ARN from the key store in order to access the device.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)` A value that indicates whether the DB instance class of the DB instance uses its default processor features.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB instance.
`RestoreDbInstanceFromDbSnapshotRequest.Builder`	`vpcSecurityGroupIds(String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB instance.

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - dbInstanceIdentifier
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbInstanceIdentifier(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
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSnapshotIdentifier
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbSnapshotIdentifier(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbInstanceClass
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbInstanceClass(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 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.
    
    Default: The same DBInstanceClass as the original DB instance.
    
    Parameters:
    
    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 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.
    
    Default: The same DBInstanceClass as the original DB instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - port
```
RestoreDbInstanceFromDbSnapshotRequest.Builder port(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - availabilityZone
```
RestoreDbInstanceFromDbSnapshotRequest.Builder availabilityZone(String availabilityZone)
```
    The Availability Zone (AZ) where the DB instance will be created.
    
    Default: A random, system-chosen Availability Zone.
    
    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
    
    Example: us-east-1a
    
    Parameters:
    
    availabilityZone - The Availability Zone (AZ) where the DB instance will be created.
    
    Default: A random, system-chosen Availability Zone.
    
    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
    
    Example: us-east-1a
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbSubnetGroupName
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbSubnetGroupName(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: mydbsubnetgroup
    
    Parameters:
    
    dbSubnetGroupName - The DB subnet group name to use for the new instance.
    
    Constraints: If supplied, must match the name of an existing DBSubnetGroup.
    
    Example: mydbsubnetgroup
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - multiAZ
```
RestoreDbInstanceFromDbSnapshotRequest.Builder multiAZ(Boolean multiAZ)
```
    A value that indicates whether the DB instance is a Multi-AZ deployment.
    
    This setting doesn't apply to RDS Custom.
    
    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
    
    Parameters:
    
    multiAZ - A value that indicates whether the DB instance is a Multi-AZ deployment.
    
    This setting doesn't apply to RDS Custom.
    
    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - publiclyAccessible
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - autoMinorVersionUpgrade
```
RestoreDbInstanceFromDbSnapshotRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
```
    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
    
    If you restore an RDS Custom DB instance, you must disable this parameter.
    
    Parameters:
    
    autoMinorVersionUpgrade - A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
    
    If you restore an RDS Custom DB instance, you must disable this parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - licenseModel
```
RestoreDbInstanceFromDbSnapshotRequest.Builder licenseModel(String licenseModel)
```
    License model information for the restored DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Default: Same as source.
    
    Valid values: license-included | bring-your-own-license | general-public-license
    
    Parameters:
    
    licenseModel - License model information for the restored DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Default: Same as source.
    
    Valid values: license-included | bring-your-own-license | general-public-license
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbName
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbName(String dbName)
```
    The database name for the restored DB instance.
    
    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
    
    Parameters:
    
    dbName - The database name for the restored DB instance.
    
    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - engine
```
RestoreDbInstanceFromDbSnapshotRequest.Builder engine(String engine)
```
    The database engine to use for the new instance.
    
    This setting doesn't apply to RDS Custom.
    
    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-ee-cdb
    - oracle-se2
    - oracle-se2-cdb
    - postgres
    - sqlserver-ee
    - sqlserver-se
    - sqlserver-ex
    - sqlserver-web
    Parameters:
    engine - The database engine to use for the new instance.
    
    This setting doesn't apply to RDS Custom.
    
    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-ee-cdb
    
    oracle-se2
    
    oracle-se2-cdb
    
    postgres
    
    sqlserver-ee
    
    sqlserver-se
    
    sqlserver-ex
    
    sqlserver-web
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - iops
```
RestoreDbInstanceFromDbSnapshotRequest.Builder iops(Integer iops)
```
    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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.
    
    Parameters:
    
    iops - Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - optionGroupName
```
RestoreDbInstanceFromDbSnapshotRequest.Builder optionGroupName(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 after it is associated with a DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    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 after it is associated with a DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDbInstanceFromDbSnapshotRequest.Builder tags(Collection<Tag> tags)
```
    Sets the value of the Tags property for this object.
    
    Parameters:
    
    tags - The new value for the Tags property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDbInstanceFromDbSnapshotRequest.Builder tags(Tag... tags)
```
    Sets the value of the Tags property for this object.
    
    Parameters:
    
    tags - The new value for the Tags property for this object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
RestoreDbInstanceFromDbSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)
```
    Sets the value of the Tags property for this object. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - storageType
```
RestoreDbInstanceFromDbSnapshotRequest.Builder storageType(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
    
    Parameters:
    
    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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tdeCredentialArn
```
RestoreDbInstanceFromDbSnapshotRequest.Builder tdeCredentialArn(String tdeCredentialArn)
```
    The ARN from the key store with which to associate the instance for TDE encryption.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tdeCredentialPassword
```
RestoreDbInstanceFromDbSnapshotRequest.Builder tdeCredentialPassword(String tdeCredentialPassword)
```
    The password for the given ARN from the key store in order to access the device.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    tdeCredentialPassword - The password for the given ARN from the key store in order to access the device.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroupIds
```
RestoreDbInstanceFromDbSnapshotRequest.Builder vpcSecurityGroupIds(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcSecurityGroupIds
```
RestoreDbInstanceFromDbSnapshotRequest.Builder vpcSecurityGroupIds(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domain
```
RestoreDbInstanceFromDbSnapshotRequest.Builder domain(String domain)
```
    Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
    
    For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    domain - Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
    
    For more information, see Kerberos Authentication in the Amazon RDS User Guide.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - copyTagsToSnapshot
```
RestoreDbInstanceFromDbSnapshotRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
    
    In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
    
    For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
    
    In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
    
    For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - domainIAMRoleName
```
RestoreDbInstanceFromDbSnapshotRequest.Builder domainIAMRoleName(String domainIAMRoleName)
```
    Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableIAMDatabaseAuthentication
```
RestoreDbInstanceFromDbSnapshotRequest.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 is disabled.
    
    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    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 is disabled.
    
    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    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.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCloudwatchLogsExports
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    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.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - processorFeatures
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - processorFeatures
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - processorFeatures
```
RestoreDbInstanceFromDbSnapshotRequest.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 setting doesn't apply to RDS Custom.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #processorFeatures(List).
    
    Parameters:
    
    processorFeatures - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #processorFeatures(List)
  - useDefaultProcessorFeatures
```
RestoreDbInstanceFromDbSnapshotRequest.Builder useDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
```
    A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    
    This setting doesn't apply to RDS Custom.
    
    Parameters:
    
    useDefaultProcessorFeatures - A value that indicates whether the DB instance class of the DB instance uses its default processor features.
    
    This setting doesn't apply to RDS Custom.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - dbParameterGroupName
```
RestoreDbInstanceFromDbSnapshotRequest.Builder dbParameterGroupName(String dbParameterGroupName)
```
    The name of the DB parameter group to associate with this DB instance.
    
    If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
    
    This setting doesn't apply to RDS Custom.
    
    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.
    Parameters:
    dbParameterGroupName - The name of the DB parameter group to associate with this DB instance.
    
    If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine.
    
    This setting doesn't apply to RDS Custom.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - deletionProtection
```
RestoreDbInstanceFromDbSnapshotRequest.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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableCustomerOwnedIp
```
RestoreDbInstanceFromDbSnapshotRequest.Builder enableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
```
    A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
    
    A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
    
    This setting doesn't apply to RDS Custom.
    
    For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
    
    For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
    
    Parameters:
    
    enableCustomerOwnedIp - A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
    
    A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
    
    This setting doesn't apply to RDS Custom.
    
    For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
    
    For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - customIamInstanceProfile
```
RestoreDbInstanceFromDbSnapshotRequest.Builder customIamInstanceProfile(String customIamInstanceProfile)
```
    The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
    - The profile must exist in your account.
    - The profile must have an IAM role that Amazon EC2 has permissions to assume.
    - The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
    
    This setting is required for RDS Custom.
    Parameters:
    customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
    
    The profile must exist in your account.
    
    The profile must have an IAM role that Amazon EC2 has permissions to assume.
    
    The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
    
    For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
    
    This setting is required for RDS Custom.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - backupTarget
```
RestoreDbInstanceFromDbSnapshotRequest.Builder backupTarget(String backupTarget)
```
    Specifies where automated backups and manual snapshots are stored for the restored DB instance.
    
    Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
    
    For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
    
    Parameters:
    
    backupTarget - Specifies where automated backups and manual snapshots are stored for the restored DB instance.
    
    Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
    
    For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
RestoreDbInstanceFromDbSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
RestoreDbInstanceFromDbSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface RestoreDbInstanceFromDbSnapshotRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

dbInstanceIdentifier

dbSnapshotIdentifier

dbInstanceClass

port

availabilityZone

dbSubnetGroupName

multiAZ

publiclyAccessible

autoMinorVersionUpgrade

licenseModel

dbName

engine

iops

optionGroupName

tags

tags

tags

storageType

tdeCredentialArn

tdeCredentialPassword

vpcSecurityGroupIds

vpcSecurityGroupIds

domain

copyTagsToSnapshot

domainIAMRoleName

enableIAMDatabaseAuthentication

enableCloudwatchLogsExports

enableCloudwatchLogsExports

processorFeatures

processorFeatures

processorFeatures

useDefaultProcessorFeatures

dbParameterGroupName

deletionProtection

enableCustomerOwnedIp

customIamInstanceProfile

backupTarget

overrideConfiguration

overrideConfiguration