Package 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 Details

    • engine

      DescribeOrderableDbInstanceOptionsRequest.Builder engine(String engine)

      The name of the database engine to describe DB instance options for.

      Valid Values:

      • aurora-mysql

      • aurora-postgresql

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      • db2-ae

      • db2-se

      • 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 database engine to describe DB instance options for.

      Valid Values:

      • aurora-mysql

      • aurora-postgresql

      • custom-oracle-ee

      • custom-oracle-ee-cdb

      • custom-oracle-se2

      • custom-oracle-se2-cdb

      • db2-ae

      • db2-se

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

      A filter to include only the available options for the specified engine version.

      Parameters:
      engineVersion - A filter to include only the available options for 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)

      A filter to include only the available options for the specified DB instance class.

      Parameters:
      dbInstanceClass - A filter to include only the available options for 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)

      A filter to include only the available options for the specified license model.

      RDS Custom supports only the BYOL licensing model.

      Parameters:
      licenseModel - A filter to include only the available options for 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 options for the Local Zones in the group.

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

      This setting doesn't apply to RDS Custom DB instances.

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

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

      This setting doesn't apply to RDS Custom DB instances.

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

    • vpc

      DescribeOrderableDbInstanceOptionsRequest.Builder vpc(Boolean vpc)

      Specifies 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 - Specifies 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<Filter>).

      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:

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

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

      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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeOrderableDbInstanceOptionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.