software.amazon.awssdk.services.rds.model

Interface DescribeOrderableDbInstanceOptionsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeOrderableDbInstanceOptionsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeOrderableDbInstanceOptionsRequest.Builder	availabilityZoneGroup(String availabilityZoneGroup) The Availability Zone group associated with a Local Zone.
DescribeOrderableDbInstanceOptionsRequest.Builder	dbInstanceClass(String dbInstanceClass) The DB instance class filter value.
DescribeOrderableDbInstanceOptionsRequest.Builder	engine(String engine) The name of the engine to retrieve DB instance options for.
DescribeOrderableDbInstanceOptionsRequest.Builder	engineVersion(String engineVersion) The engine version filter value.
DescribeOrderableDbInstanceOptionsRequest.Builder	filters(Collection<Filter> filters) This parameter isn't currently supported.
DescribeOrderableDbInstanceOptionsRequest.Builder	filters(Consumer<Filter.Builder>... filters) This parameter isn't currently supported.
DescribeOrderableDbInstanceOptionsRequest.Builder	filters(Filter... filters) This parameter isn't currently supported.
DescribeOrderableDbInstanceOptionsRequest.Builder	licenseModel(String licenseModel) The license model filter value.
DescribeOrderableDbInstanceOptionsRequest.Builder	marker(String marker) An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request.
DescribeOrderableDbInstanceOptionsRequest.Builder	maxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeOrderableDbInstanceOptionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeOrderableDbInstanceOptionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeOrderableDbInstanceOptionsRequest.Builder	vpc(Boolean vpc) A value that indicates whether to show only VPC or non-VPC offerings.

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

engine

DescribeOrderableDbInstanceOptionsRequest.Builder engine(String engine)

The name of the engine to retrieve DB instance options for.

Valid Values:

• aurora (for MySQL 5.6-compatible Aurora)

• aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

• aurora-postgresql

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Parameters:

engine - The name of the engine to retrieve DB instance options for.

Valid Values:

• aurora (for MySQL 5.6-compatible Aurora)

• aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)

• aurora-postgresql

• 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.

engineVersion

DescribeOrderableDbInstanceOptionsRequest.Builder engineVersion(String engineVersion)

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

Parameters:

engineVersion - The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

Returns:

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

dbInstanceClass

DescribeOrderableDbInstanceOptionsRequest.Builder dbInstanceClass(String dbInstanceClass)

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Parameters:

dbInstanceClass - The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

Returns:

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

licenseModel

DescribeOrderableDbInstanceOptionsRequest.Builder licenseModel(String licenseModel)

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

Parameters:

licenseModel - The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.

Returns:

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

availabilityZoneGroup

DescribeOrderableDbInstanceOptionsRequest.Builder availabilityZoneGroup(String availabilityZoneGroup)

The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

Parameters:

availabilityZoneGroup - The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

Omit this parameter to show the available offerings in the specified Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

Returns:

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

vpc

DescribeOrderableDbInstanceOptionsRequest.Builder vpc(Boolean vpc)

A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

Parameters:

vpc - A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

Returns:

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

filters

DescribeOrderableDbInstanceOptionsRequest.Builder filters(Collection<Filter> filters)

This parameter isn't currently supported.

Parameters:

filters - This parameter isn't currently supported.

Returns:

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

filters

DescribeOrderableDbInstanceOptionsRequest.Builder filters(Filter... filters)

This parameter isn't currently supported.

Parameters:

filters - This parameter isn't currently supported.

Returns:

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

filters

DescribeOrderableDbInstanceOptionsRequest.Builder filters(Consumer<Filter.Builder>... filters)

This parameter isn't currently supported.

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

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

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

maxRecords

DescribeOrderableDbInstanceOptionsRequest.Builder maxRecords(Integer maxRecords)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

Parameters:

maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.

Returns:

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

marker

DescribeOrderableDbInstanceOptionsRequest.Builder marker(String marker)

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameters:

marker - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

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

overrideConfiguration

DescribeOrderableDbInstanceOptionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeOrderableDbInstanceOptionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder