software.amazon.awssdk.services.rds.model

Interface DescribeDbEngineVersionsRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeDbEngineVersionsRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeDbEngineVersionsRequest.Builder	dbParameterGroupFamily(String dbParameterGroupFamily) The name of a specific DB parameter group family to return details for.
DescribeDbEngineVersionsRequest.Builder	defaultOnly(Boolean defaultOnly) A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.
DescribeDbEngineVersionsRequest.Builder	engine(String engine) The database engine to return.
DescribeDbEngineVersionsRequest.Builder	engineVersion(String engineVersion) The database engine version to return.
DescribeDbEngineVersionsRequest.Builder	filters(Collection<Filter> filters) A filter that specifies one or more DB engine versions to describe.
DescribeDbEngineVersionsRequest.Builder	filters(Consumer<Filter.Builder>... filters) A filter that specifies one or more DB engine versions to describe.
DescribeDbEngineVersionsRequest.Builder	filters(Filter... filters) A filter that specifies one or more DB engine versions to describe.
DescribeDbEngineVersionsRequest.Builder	includeAll(Boolean includeAll) A value that indicates whether to include engine versions that aren't available in the list.
DescribeDbEngineVersionsRequest.Builder	listSupportedCharacterSets(Boolean listSupportedCharacterSets) A value that indicates whether to list the supported character sets for each engine version.
DescribeDbEngineVersionsRequest.Builder	listSupportedTimezones(Boolean listSupportedTimezones) A value that indicates whether to list the supported time zones for each engine version.
DescribeDbEngineVersionsRequest.Builder	marker(String marker) An optional pagination token provided by a previous request.
DescribeDbEngineVersionsRequest.Builder	maxRecords(Integer maxRecords) The maximum number of records to include in the response.
DescribeDbEngineVersionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeDbEngineVersionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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

DescribeDbEngineVersionsRequest.Builder engine(String engine)

The database engine to return.

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 database engine to return.

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

DescribeDbEngineVersionsRequest.Builder engineVersion(String engineVersion)

The database engine version to return.

Example: 5.1.49

Parameters:

engineVersion - The database engine version to return.

Example: 5.1.49

Returns:

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

dbParameterGroupFamily

DescribeDbEngineVersionsRequest.Builder dbParameterGroupFamily(String dbParameterGroupFamily)

The name of a specific DB parameter group family to return details for.

Constraints:

• If supplied, must match an existing DBParameterGroupFamily.

Parameters:

dbParameterGroupFamily - The name of a specific DB parameter group family to return details for.

Constraints:

• If supplied, must match an existing DBParameterGroupFamily.

Returns:

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

filters

DescribeDbEngineVersionsRequest.Builder filters(Collection<Filter> filters)

A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

Parameters:

filters - A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

Returns:

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

filters

DescribeDbEngineVersionsRequest.Builder filters(Filter... filters)

A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

Parameters:

filters - A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

Returns:

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

filters

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

A filter that specifies one or more DB engine versions to describe.

Supported filters:

• db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.

• engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.

• engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

• engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.

• status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:

  • available

  • deprecated

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

DescribeDbEngineVersionsRequest.Builder maxRecords(Integer maxRecords)

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

Default: 100

Constraints: Minimum 20, maximum 100.

Parameters:

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

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

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

marker

DescribeDbEngineVersionsRequest.Builder marker(String marker)

An optional pagination token provided by a previous 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 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.

defaultOnly

DescribeDbEngineVersionsRequest.Builder defaultOnly(Boolean defaultOnly)

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

Parameters:

defaultOnly - A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

Returns:

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

listSupportedCharacterSets

DescribeDbEngineVersionsRequest.Builder listSupportedCharacterSets(Boolean listSupportedCharacterSets)

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

Parameters:

listSupportedCharacterSets - A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.

Returns:

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

listSupportedTimezones

DescribeDbEngineVersionsRequest.Builder listSupportedTimezones(Boolean listSupportedTimezones)

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

Parameters:

listSupportedTimezones - A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.

Returns:

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

includeAll

DescribeDbEngineVersionsRequest.Builder includeAll(Boolean includeAll)

A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Parameters:

includeAll - A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Returns:

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

overrideConfiguration

DescribeDbEngineVersionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder