Package software.amazon.awssdk.services.docdb.model

Interface DBEngineVersion.Builder

All Superinterfaces:

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

Enclosing class:

DBEngineVersion

@Mutable
@NotThreadSafe
public static interface DBEngineVersion.Builder
extends SdkPojo, CopyableBuilder<DBEngineVersion.Builder,DBEngineVersion>

Method Summary

Modifier and Type	Method	Description
DBEngineVersion.Builder	dbEngineDescription(String dbEngineDescription)	The description of the database engine.
DBEngineVersion.Builder	dbEngineVersionDescription(String dbEngineVersionDescription)	The description of the database engine version.
DBEngineVersion.Builder	dbParameterGroupFamily(String dbParameterGroupFamily)	The name of the parameter group family for the database engine.
DBEngineVersion.Builder	engine(String engine)	The name of the database engine.
DBEngineVersion.Builder	engineVersion(String engineVersion)	The version number of the database engine.
DBEngineVersion.Builder	exportableLogTypes(String... exportableLogTypes)	The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
DBEngineVersion.Builder	exportableLogTypes(Collection<String> exportableLogTypes)	The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
default DBEngineVersion.Builder	serverlessV2FeaturesSupport(Consumer<ServerlessV2FeaturesSupport.Builder> serverlessV2FeaturesSupport)	Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions.
DBEngineVersion.Builder	serverlessV2FeaturesSupport(ServerlessV2FeaturesSupport serverlessV2FeaturesSupport)	Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions.
DBEngineVersion.Builder	supportedCACertificateIdentifiers(String... supportedCACertificateIdentifiers)	A list of the supported CA certificate identifiers.
DBEngineVersion.Builder	supportedCACertificateIdentifiers(Collection<String> supportedCACertificateIdentifiers)	A list of the supported CA certificate identifiers.
DBEngineVersion.Builder	supportsCertificateRotationWithoutRestart(Boolean supportsCertificateRotationWithoutRestart)	Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
DBEngineVersion.Builder	supportsLogExportsToCloudwatchLogs(Boolean supportsLogExportsToCloudwatchLogs)	A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
DBEngineVersion.Builder	validUpgradeTarget(Collection<UpgradeTarget> validUpgradeTarget)	A list of engine versions that this database engine version can be upgraded to.
DBEngineVersion.Builder	validUpgradeTarget(Consumer<UpgradeTarget.Builder>... validUpgradeTarget)	A list of engine versions that this database engine version can be upgraded to.
DBEngineVersion.Builder	validUpgradeTarget(UpgradeTarget... validUpgradeTarget)	A list of engine versions that this database engine version can be upgraded to.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

engine

DBEngineVersion.Builder engine(String engine)

The name of the database engine.

Parameters:

engine - The name of the database engine.

Returns:

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

engineVersion

DBEngineVersion.Builder engineVersion(String engineVersion)

The version number of the database engine.

Parameters:

engineVersion - The version number of the database engine.

Returns:

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

dbParameterGroupFamily

DBEngineVersion.Builder dbParameterGroupFamily(String dbParameterGroupFamily)

The name of the parameter group family for the database engine.

Parameters:

dbParameterGroupFamily - The name of the parameter group family for the database engine.

Returns:

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

dbEngineDescription

DBEngineVersion.Builder dbEngineDescription(String dbEngineDescription)

The description of the database engine.

Parameters:

dbEngineDescription - The description of the database engine.

Returns:

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

dbEngineVersionDescription

DBEngineVersion.Builder dbEngineVersionDescription(String dbEngineVersionDescription)

The description of the database engine version.

Parameters:

dbEngineVersionDescription - The description of the database engine version.

Returns:

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

validUpgradeTarget

DBEngineVersion.Builder validUpgradeTarget(Collection<UpgradeTarget> validUpgradeTarget)

A list of engine versions that this database engine version can be upgraded to.

Parameters:

validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

Returns:

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

validUpgradeTarget

DBEngineVersion.Builder validUpgradeTarget(UpgradeTarget... validUpgradeTarget)

A list of engine versions that this database engine version can be upgraded to.

Parameters:

validUpgradeTarget - A list of engine versions that this database engine version can be upgraded to.

Returns:

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

validUpgradeTarget

DBEngineVersion.Builder validUpgradeTarget(Consumer<UpgradeTarget.Builder>... validUpgradeTarget)

A list of engine versions that this database engine version can be upgraded to.

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

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

Parameters:

validUpgradeTarget - a consumer that will call methods on UpgradeTarget.Builder

Returns:

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

See Also:

#validUpgradeTarget(java.util.Collection)

exportableLogTypes

DBEngineVersion.Builder exportableLogTypes(Collection<String> exportableLogTypes)

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

Parameters:

exportableLogTypes - The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

Returns:

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

exportableLogTypes

DBEngineVersion.Builder exportableLogTypes(String... exportableLogTypes)

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

Parameters:

exportableLogTypes - The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

Returns:

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

supportsLogExportsToCloudwatchLogs

DBEngineVersion.Builder supportsLogExportsToCloudwatchLogs(Boolean supportsLogExportsToCloudwatchLogs)

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Parameters:

supportsLogExportsToCloudwatchLogs - A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Returns:

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

supportedCACertificateIdentifiers

DBEngineVersion.Builder supportedCACertificateIdentifiers(Collection<String> supportedCACertificateIdentifiers)

A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

Parameters:

supportedCACertificateIdentifiers - A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

Returns:

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

supportedCACertificateIdentifiers

DBEngineVersion.Builder supportedCACertificateIdentifiers(String... supportedCACertificateIdentifiers)

A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

Parameters:

supportedCACertificateIdentifiers - A list of the supported CA certificate identifiers.

For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.

Returns:

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

supportsCertificateRotationWithoutRestart

DBEngineVersion.Builder supportsCertificateRotationWithoutRestart(Boolean supportsCertificateRotationWithoutRestart)

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Parameters:

supportsCertificateRotationWithoutRestart - Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Returns:

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

serverlessV2FeaturesSupport

DBEngineVersion.Builder serverlessV2FeaturesSupport(ServerlessV2FeaturesSupport serverlessV2FeaturesSupport)

Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

Parameters:

serverlessV2FeaturesSupport - Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

Returns:

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

serverlessV2FeaturesSupport

default DBEngineVersion.Builder serverlessV2FeaturesSupport(Consumer<ServerlessV2FeaturesSupport.Builder> serverlessV2FeaturesSupport)

Specifies any Amazon DocumentDB Serverless properties or limits that differ between Amazon DocumentDB engine versions. You can test the values of this attribute when deciding which Amazon DocumentDB version to use in a new or upgraded cluster. You can also retrieve the version of an existing cluster and check whether that version supports certain Amazon DocumentDB Serverless features before you attempt to use those features.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverlessV2FeaturesSupport(ServerlessV2FeaturesSupport).

Parameters:

serverlessV2FeaturesSupport - a consumer that will call methods on ServerlessV2FeaturesSupport.Builder

Returns:

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

See Also:

serverlessV2FeaturesSupport(ServerlessV2FeaturesSupport)