Interface DescribeDbEngineVersionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeDbEngineVersionsRequest.Builder,
,DescribeDbEngineVersionsRequest> RdsRequest.Builder
,SdkBuilder<DescribeDbEngineVersionsRequest.Builder,
,DescribeDbEngineVersionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeDbEngineVersionsRequest
-
Method Summary
Modifier and TypeMethodDescriptiondbParameterGroupFamily
(String dbParameterGroupFamily) The name of a specific DB parameter group family to return details for.defaultOnly
(Boolean defaultOnly) Specifies whether to return only the default version of the specified engine or the engine and major version combination.The database engine to return version details for.engineVersion
(String engineVersion) A specific database engine version to return details for.filters
(Collection<Filter> filters) A filter that specifies one or more DB engine versions to describe.filters
(Consumer<Filter.Builder>... filters) A filter that specifies one or more DB engine versions to describe.A filter that specifies one or more DB engine versions to describe.includeAll
(Boolean includeAll) Specifies whether to also list the engine versions that aren't available.listSupportedCharacterSets
(Boolean listSupportedCharacterSets) Specifies whether to list the supported character sets for each engine version.listSupportedTimezones
(Boolean listSupportedTimezones) Specifies whether to list the supported time zones for each engine version.An optional pagination token provided by a previous request.maxRecords
(Integer maxRecords) The maximum number of records to include in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
engine
The database engine to return version details for.
Valid Values:
-
aurora-mysql
-
aurora-postgresql
-
custom-oracle-ee
-
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 database engine to return version details for.Valid Values:
-
aurora-mysql
-
aurora-postgresql
-
custom-oracle-ee
-
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
A specific database engine version to return details for.
Example:
5.1.49
- Parameters:
engineVersion
- A specific database engine version to return details for.Example:
5.1.49
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbParameterGroupFamily
The name of a specific DB parameter group family to return details for.
Constraints:
-
If supplied, must match an existing DB parameter group family.
- Parameters:
dbParameterGroupFamily
- The name of a specific DB parameter group family to return details for.Constraints:
-
If supplied, must match an existing DB parameter group family.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
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
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
-
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 theMaxRecords
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
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 byMaxRecords
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultOnly
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
- Parameters:
defaultOnly
- Specifies whether to return only the default version of the specified engine or the engine and major version combination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
listSupportedCharacterSets
DescribeDbEngineVersionsRequest.Builder listSupportedCharacterSets(Boolean listSupportedCharacterSets) Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, 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 enable this parameter, RDS Custom returns no results.
- Parameters:
listSupportedCharacterSets
- Specifies whether to list the supported character sets for each engine version.If this parameter is enabled and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, 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 enable this parameter, RDS Custom returns no results.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
listSupportedTimezones
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, 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 enable this parameter, RDS Custom returns no results.
- Parameters:
listSupportedTimezones
- Specifies whether to list the supported time zones for each engine version.If this parameter is enabled and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, 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 enable this parameter, RDS Custom returns no results.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeAll
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
- Parameters:
includeAll
- Specifies whether to also list the engine versions that aren't available. 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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeDbEngineVersionsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-