software.amazon.awssdk.services.rds.model

Interface OrderableDBInstanceOption.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>, SdkBuilder<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>, SdkPojo

Enclosing class:

OrderableDBInstanceOption

public static interface OrderableDBInstanceOption.Builder
extends SdkPojo, CopyableBuilder<OrderableDBInstanceOption.Builder,OrderableDBInstanceOption>

Method Summary

Modifier and Type	Method and Description
OrderableDBInstanceOption.Builder	availabilityZoneGroup(String availabilityZoneGroup) The Availability Zone group for a DB instance.
OrderableDBInstanceOption.Builder	availabilityZones(AvailabilityZone... availabilityZones) A list of Availability Zones for a DB instance.
OrderableDBInstanceOption.Builder	availabilityZones(Collection<AvailabilityZone> availabilityZones) A list of Availability Zones for a DB instance.
OrderableDBInstanceOption.Builder	availabilityZones(Consumer<AvailabilityZone.Builder>... availabilityZones) A list of Availability Zones for a DB instance.
OrderableDBInstanceOption.Builder	availableProcessorFeatures(AvailableProcessorFeature... availableProcessorFeatures) A list of the available processor features for the DB instance class of a DB instance.
OrderableDBInstanceOption.Builder	availableProcessorFeatures(Collection<AvailableProcessorFeature> availableProcessorFeatures) A list of the available processor features for the DB instance class of a DB instance.
OrderableDBInstanceOption.Builder	availableProcessorFeatures(Consumer<AvailableProcessorFeature.Builder>... availableProcessorFeatures) A list of the available processor features for the DB instance class of a DB instance.
OrderableDBInstanceOption.Builder	dbInstanceClass(String dbInstanceClass) The DB instance class for a DB instance.
OrderableDBInstanceOption.Builder	engine(String engine) The engine type of a DB instance.
OrderableDBInstanceOption.Builder	engineVersion(String engineVersion) The engine version of a DB instance.
OrderableDBInstanceOption.Builder	licenseModel(String licenseModel) The license model for a DB instance.
OrderableDBInstanceOption.Builder	maxIopsPerDbInstance(Integer maxIopsPerDbInstance) Maximum total provisioned IOPS for a DB instance.
OrderableDBInstanceOption.Builder	maxIopsPerGib(Double maxIopsPerGib) Maximum provisioned IOPS per GiB for a DB instance.
OrderableDBInstanceOption.Builder	maxStorageSize(Integer maxStorageSize) Maximum storage size for a DB instance.
OrderableDBInstanceOption.Builder	maxStorageThroughputPerDbInstance(Integer maxStorageThroughputPerDbInstance) Maximum storage throughput for a DB instance.
OrderableDBInstanceOption.Builder	maxStorageThroughputPerIops(Double maxStorageThroughputPerIops) Maximum storage throughput to provisioned IOPS ratio for a DB instance.
OrderableDBInstanceOption.Builder	minIopsPerDbInstance(Integer minIopsPerDbInstance) Minimum total provisioned IOPS for a DB instance.
OrderableDBInstanceOption.Builder	minIopsPerGib(Double minIopsPerGib) Minimum provisioned IOPS per GiB for a DB instance.
OrderableDBInstanceOption.Builder	minStorageSize(Integer minStorageSize) Minimum storage size for a DB instance.
OrderableDBInstanceOption.Builder	minStorageThroughputPerDbInstance(Integer minStorageThroughputPerDbInstance) Minimum storage throughput for a DB instance.
OrderableDBInstanceOption.Builder	minStorageThroughputPerIops(Double minStorageThroughputPerIops) Minimum storage throughput to provisioned IOPS ratio for a DB instance.
OrderableDBInstanceOption.Builder	multiAZCapable(Boolean multiAZCapable) Indicates whether a DB instance is Multi-AZ capable.
OrderableDBInstanceOption.Builder	outpostCapable(Boolean outpostCapable) Indicates whether a DB instance supports RDS on Outposts.
OrderableDBInstanceOption.Builder	readReplicaCapable(Boolean readReplicaCapable) Indicates whether a DB instance can have a read replica.
OrderableDBInstanceOption.Builder	storageType(String storageType) The storage type for a DB instance.
OrderableDBInstanceOption.Builder	supportedActivityStreamModes(Collection<String> supportedActivityStreamModes) The list of supported modes for Database Activity Streams.
OrderableDBInstanceOption.Builder	supportedActivityStreamModes(String... supportedActivityStreamModes) The list of supported modes for Database Activity Streams.
OrderableDBInstanceOption.Builder	supportedEngineModes(Collection<String> supportedEngineModes) A list of the supported DB engine modes.
OrderableDBInstanceOption.Builder	supportedEngineModes(String... supportedEngineModes) A list of the supported DB engine modes.
OrderableDBInstanceOption.Builder	supportedNetworkTypes(Collection<String> supportedNetworkTypes) The network types supported by the DB instance (IPV4 or DUAL).
OrderableDBInstanceOption.Builder	supportedNetworkTypes(String... supportedNetworkTypes) The network types supported by the DB instance (IPV4 or DUAL).
OrderableDBInstanceOption.Builder	supportsClusters(Boolean supportsClusters) Indicates whether DB instances can be configured as a Multi-AZ DB cluster.
OrderableDBInstanceOption.Builder	supportsEnhancedMonitoring(Boolean supportsEnhancedMonitoring) Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
OrderableDBInstanceOption.Builder	supportsGlobalDatabases(Boolean supportsGlobalDatabases) Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
OrderableDBInstanceOption.Builder	supportsIAMDatabaseAuthentication(Boolean supportsIAMDatabaseAuthentication) Indicates whether a DB instance supports IAM database authentication.
OrderableDBInstanceOption.Builder	supportsIops(Boolean supportsIops) Indicates whether a DB instance supports provisioned IOPS.
OrderableDBInstanceOption.Builder	supportsKerberosAuthentication(Boolean supportsKerberosAuthentication) Indicates whether a DB instance supports Kerberos Authentication.
OrderableDBInstanceOption.Builder	supportsPerformanceInsights(Boolean supportsPerformanceInsights) Indicates whether a DB instance supports Performance Insights.
OrderableDBInstanceOption.Builder	supportsStorageAutoscaling(Boolean supportsStorageAutoscaling) Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
OrderableDBInstanceOption.Builder	supportsStorageEncryption(Boolean supportsStorageEncryption) Indicates whether a DB instance supports encrypted storage.
OrderableDBInstanceOption.Builder	supportsStorageThroughput(Boolean supportsStorageThroughput) Indicates whether a DB instance supports storage throughput.
OrderableDBInstanceOption.Builder	vpc(Boolean vpc) Indicates whether a DB instance is in a VPC.

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

engine

OrderableDBInstanceOption.Builder engine(String engine)

The engine type of a DB instance.

Parameters:

engine - The engine type of a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

engineVersion

OrderableDBInstanceOption.Builder engineVersion(String engineVersion)

The engine version of a DB instance.

Parameters:

engineVersion - The engine version of a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

dbInstanceClass

OrderableDBInstanceOption.Builder dbInstanceClass(String dbInstanceClass)

The DB instance class for a DB instance.

Parameters:

dbInstanceClass - The DB instance class for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

licenseModel

OrderableDBInstanceOption.Builder licenseModel(String licenseModel)

The license model for a DB instance.

Parameters:

licenseModel - The license model for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZoneGroup

OrderableDBInstanceOption.Builder availabilityZoneGroup(String availabilityZoneGroup)

The Availability Zone group for a DB instance.

Parameters:

availabilityZoneGroup - The Availability Zone group for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

OrderableDBInstanceOption.Builder availabilityZones(Collection<AvailabilityZone> availabilityZones)

A list of Availability Zones for a DB instance.

Parameters:

availabilityZones - A list of Availability Zones for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

OrderableDBInstanceOption.Builder availabilityZones(AvailabilityZone... availabilityZones)

A list of Availability Zones for a DB instance.

Parameters:

availabilityZones - A list of Availability Zones for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availabilityZones

OrderableDBInstanceOption.Builder availabilityZones(Consumer<AvailabilityZone.Builder>... availabilityZones)

A list of Availability Zones for a DB instance.

This is a convenience method that creates an instance of the AvailabilityZone.Builder avoiding the need to create one manually via AvailabilityZone.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #availabilityZones(List).

Parameters:

availabilityZones - a consumer that will call methods on AvailabilityZone.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#availabilityZones(java.util.Collection)

multiAZCapable

OrderableDBInstanceOption.Builder multiAZCapable(Boolean multiAZCapable)

Indicates whether a DB instance is Multi-AZ capable.

Parameters:

multiAZCapable - Indicates whether a DB instance is Multi-AZ capable.

Returns:

Returns a reference to this object so that method calls can be chained together.

readReplicaCapable

OrderableDBInstanceOption.Builder readReplicaCapable(Boolean readReplicaCapable)

Indicates whether a DB instance can have a read replica.

Parameters:

readReplicaCapable - Indicates whether a DB instance can have a read replica.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpc

OrderableDBInstanceOption.Builder vpc(Boolean vpc)

Indicates whether a DB instance is in a VPC.

Parameters:

vpc - Indicates whether a DB instance is in a VPC.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsStorageEncryption

OrderableDBInstanceOption.Builder supportsStorageEncryption(Boolean supportsStorageEncryption)

Indicates whether a DB instance supports encrypted storage.

Parameters:

supportsStorageEncryption - Indicates whether a DB instance supports encrypted storage.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageType

OrderableDBInstanceOption.Builder storageType(String storageType)

The storage type for a DB instance.

Parameters:

storageType - The storage type for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsIops

OrderableDBInstanceOption.Builder supportsIops(Boolean supportsIops)

Indicates whether a DB instance supports provisioned IOPS.

Parameters:

supportsIops - Indicates whether a DB instance supports provisioned IOPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsEnhancedMonitoring

OrderableDBInstanceOption.Builder supportsEnhancedMonitoring(Boolean supportsEnhancedMonitoring)

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Parameters:

supportsEnhancedMonitoring - Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsIAMDatabaseAuthentication

OrderableDBInstanceOption.Builder supportsIAMDatabaseAuthentication(Boolean supportsIAMDatabaseAuthentication)

Indicates whether a DB instance supports IAM database authentication.

Parameters:

supportsIAMDatabaseAuthentication - Indicates whether a DB instance supports IAM database authentication.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsPerformanceInsights

OrderableDBInstanceOption.Builder supportsPerformanceInsights(Boolean supportsPerformanceInsights)

Indicates whether a DB instance supports Performance Insights.

Parameters:

supportsPerformanceInsights - Indicates whether a DB instance supports Performance Insights.

Returns:

Returns a reference to this object so that method calls can be chained together.

minStorageSize

OrderableDBInstanceOption.Builder minStorageSize(Integer minStorageSize)

Minimum storage size for a DB instance.

Parameters:

minStorageSize - Minimum storage size for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxStorageSize

OrderableDBInstanceOption.Builder maxStorageSize(Integer maxStorageSize)

Maximum storage size for a DB instance.

Parameters:

maxStorageSize - Maximum storage size for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

minIopsPerDbInstance

OrderableDBInstanceOption.Builder minIopsPerDbInstance(Integer minIopsPerDbInstance)

Minimum total provisioned IOPS for a DB instance.

Parameters:

minIopsPerDbInstance - Minimum total provisioned IOPS for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxIopsPerDbInstance

OrderableDBInstanceOption.Builder maxIopsPerDbInstance(Integer maxIopsPerDbInstance)

Maximum total provisioned IOPS for a DB instance.

Parameters:

maxIopsPerDbInstance - Maximum total provisioned IOPS for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

minIopsPerGib

OrderableDBInstanceOption.Builder minIopsPerGib(Double minIopsPerGib)

Minimum provisioned IOPS per GiB for a DB instance.

Parameters:

minIopsPerGib - Minimum provisioned IOPS per GiB for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxIopsPerGib

OrderableDBInstanceOption.Builder maxIopsPerGib(Double maxIopsPerGib)

Maximum provisioned IOPS per GiB for a DB instance.

Parameters:

maxIopsPerGib - Maximum provisioned IOPS per GiB for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availableProcessorFeatures

OrderableDBInstanceOption.Builder availableProcessorFeatures(Collection<AvailableProcessorFeature> availableProcessorFeatures)

A list of the available processor features for the DB instance class of a DB instance.

Parameters:

availableProcessorFeatures - A list of the available processor features for the DB instance class of a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availableProcessorFeatures

OrderableDBInstanceOption.Builder availableProcessorFeatures(AvailableProcessorFeature... availableProcessorFeatures)

A list of the available processor features for the DB instance class of a DB instance.

Parameters:

availableProcessorFeatures - A list of the available processor features for the DB instance class of a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

availableProcessorFeatures

OrderableDBInstanceOption.Builder availableProcessorFeatures(Consumer<AvailableProcessorFeature.Builder>... availableProcessorFeatures)

A list of the available processor features for the DB instance class of a DB instance.

This is a convenience method that creates an instance of the AvailableProcessorFeature.Builder avoiding the need to create one manually via AvailableProcessorFeature.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #availableProcessorFeatures(List).

Parameters:

availableProcessorFeatures - a consumer that will call methods on AvailableProcessorFeature.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#availableProcessorFeatures(java.util.Collection)

supportedEngineModes

OrderableDBInstanceOption.Builder supportedEngineModes(Collection<String> supportedEngineModes)

A list of the supported DB engine modes.

Parameters:

supportedEngineModes - A list of the supported DB engine modes.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedEngineModes

OrderableDBInstanceOption.Builder supportedEngineModes(String... supportedEngineModes)

A list of the supported DB engine modes.

Parameters:

supportedEngineModes - A list of the supported DB engine modes.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsStorageAutoscaling

OrderableDBInstanceOption.Builder supportsStorageAutoscaling(Boolean supportsStorageAutoscaling)

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Parameters:

supportsStorageAutoscaling - Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsKerberosAuthentication

OrderableDBInstanceOption.Builder supportsKerberosAuthentication(Boolean supportsKerberosAuthentication)

Indicates whether a DB instance supports Kerberos Authentication.

Parameters:

supportsKerberosAuthentication - Indicates whether a DB instance supports Kerberos Authentication.

Returns:

Returns a reference to this object so that method calls can be chained together.

outpostCapable

OrderableDBInstanceOption.Builder outpostCapable(Boolean outpostCapable)

Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Parameters:

outpostCapable - Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see 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.

supportedActivityStreamModes

OrderableDBInstanceOption.Builder supportedActivityStreamModes(Collection<String> supportedActivityStreamModes)

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

Parameters:

supportedActivityStreamModes - The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedActivityStreamModes

OrderableDBInstanceOption.Builder supportedActivityStreamModes(String... supportedActivityStreamModes)

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

Parameters:

supportedActivityStreamModes - The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsGlobalDatabases

OrderableDBInstanceOption.Builder supportsGlobalDatabases(Boolean supportsGlobalDatabases)

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Parameters:

supportsGlobalDatabases - Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsClusters

OrderableDBInstanceOption.Builder supportsClusters(Boolean supportsClusters)

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Parameters:

supportsClusters - Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedNetworkTypes

OrderableDBInstanceOption.Builder supportedNetworkTypes(Collection<String> supportedNetworkTypes)

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Parameters:

supportedNetworkTypes - The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportedNetworkTypes

OrderableDBInstanceOption.Builder supportedNetworkTypes(String... supportedNetworkTypes)

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Parameters:

supportedNetworkTypes - The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

supportsStorageThroughput

OrderableDBInstanceOption.Builder supportsStorageThroughput(Boolean supportsStorageThroughput)

Indicates whether a DB instance supports storage throughput.

Parameters:

supportsStorageThroughput - Indicates whether a DB instance supports storage throughput.

Returns:

Returns a reference to this object so that method calls can be chained together.

minStorageThroughputPerDbInstance

OrderableDBInstanceOption.Builder minStorageThroughputPerDbInstance(Integer minStorageThroughputPerDbInstance)

Minimum storage throughput for a DB instance.

Parameters:

minStorageThroughputPerDbInstance - Minimum storage throughput for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxStorageThroughputPerDbInstance

OrderableDBInstanceOption.Builder maxStorageThroughputPerDbInstance(Integer maxStorageThroughputPerDbInstance)

Maximum storage throughput for a DB instance.

Parameters:

maxStorageThroughputPerDbInstance - Maximum storage throughput for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

minStorageThroughputPerIops

OrderableDBInstanceOption.Builder minStorageThroughputPerIops(Double minStorageThroughputPerIops)

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Parameters:

minStorageThroughputPerIops - Minimum storage throughput to provisioned IOPS ratio for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxStorageThroughputPerIops

OrderableDBInstanceOption.Builder maxStorageThroughputPerIops(Double maxStorageThroughputPerIops)

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

Parameters:

maxStorageThroughputPerIops - Maximum storage throughput to provisioned IOPS ratio for a DB instance.

Returns:

Returns a reference to this object so that method calls can be chained together.