Package software.amazon.awssdk.services.databasemigration.model

Interface ModifyEndpointRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>, DatabaseMigrationRequest.Builder, SdkBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ModifyEndpointRequest

public static interface ModifyEndpointRequest.Builder
extends DatabaseMigrationRequest.Builder, SdkPojo, CopyableBuilder<ModifyEndpointRequest.Builder,ModifyEndpointRequest>

Method Summary

Modifier and Type	Method	Description
ModifyEndpointRequest.Builder	certificateArn(String certificateArn)	The Amazon Resource Name (ARN) of the certificate used for SSL connection.
ModifyEndpointRequest.Builder	databaseName(String databaseName)	The name of the endpoint database.
default ModifyEndpointRequest.Builder	dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)	The settings in JSON format for the DMS transfer type of source endpoint.
ModifyEndpointRequest.Builder	dmsTransferSettings(DmsTransferSettings dmsTransferSettings)	The settings in JSON format for the DMS transfer type of source endpoint.
default ModifyEndpointRequest.Builder	docDbSettings(Consumer<DocDbSettings.Builder> docDbSettings)	Settings in JSON format for the source DocumentDB endpoint.
ModifyEndpointRequest.Builder	docDbSettings(DocDbSettings docDbSettings)	Settings in JSON format for the source DocumentDB endpoint.
default ModifyEndpointRequest.Builder	dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)	Settings in JSON format for the target Amazon DynamoDB endpoint.
ModifyEndpointRequest.Builder	dynamoDbSettings(DynamoDbSettings dynamoDbSettings)	Settings in JSON format for the target Amazon DynamoDB endpoint.
default ModifyEndpointRequest.Builder	elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings)	Settings in JSON format for the target OpenSearch endpoint.
ModifyEndpointRequest.Builder	elasticsearchSettings(ElasticsearchSettings elasticsearchSettings)	Settings in JSON format for the target OpenSearch endpoint.
ModifyEndpointRequest.Builder	endpointArn(String endpointArn)	The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ModifyEndpointRequest.Builder	endpointIdentifier(String endpointIdentifier)	The database endpoint identifier.
ModifyEndpointRequest.Builder	endpointType(String endpointType)	The type of endpoint.
ModifyEndpointRequest.Builder	endpointType(ReplicationEndpointTypeValue endpointType)	The type of endpoint.
ModifyEndpointRequest.Builder	engineName(String engineName)	The database engine name.
ModifyEndpointRequest.Builder	exactSettings(Boolean exactSettings)	If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call.
ModifyEndpointRequest.Builder	externalTableDefinition(String externalTableDefinition)	The external table definition.
ModifyEndpointRequest.Builder	extraConnectionAttributes(String extraConnectionAttributes)	Additional attributes associated with the connection.
default ModifyEndpointRequest.Builder	gcpMySQLSettings(Consumer<GcpMySQLSettings.Builder> gcpMySQLSettings)	Settings in JSON format for the source GCP MySQL endpoint.
ModifyEndpointRequest.Builder	gcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)	Settings in JSON format for the source GCP MySQL endpoint.
default ModifyEndpointRequest.Builder	ibmDb2Settings(Consumer<IBMDb2Settings.Builder> ibmDb2Settings)	Settings in JSON format for the source IBM Db2 LUW endpoint.
ModifyEndpointRequest.Builder	ibmDb2Settings(IBMDb2Settings ibmDb2Settings)	Settings in JSON format for the source IBM Db2 LUW endpoint.
default ModifyEndpointRequest.Builder	kafkaSettings(Consumer<KafkaSettings.Builder> kafkaSettings)	Settings in JSON format for the target Apache Kafka endpoint.
ModifyEndpointRequest.Builder	kafkaSettings(KafkaSettings kafkaSettings)	Settings in JSON format for the target Apache Kafka endpoint.
default ModifyEndpointRequest.Builder	kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
ModifyEndpointRequest.Builder	kinesisSettings(KinesisSettings kinesisSettings)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
default ModifyEndpointRequest.Builder	microsoftSQLServerSettings(Consumer<MicrosoftSQLServerSettings.Builder> microsoftSQLServerSettings)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
ModifyEndpointRequest.Builder	microsoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
default ModifyEndpointRequest.Builder	mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)	Settings in JSON format for the source MongoDB endpoint.
ModifyEndpointRequest.Builder	mongoDbSettings(MongoDbSettings mongoDbSettings)	Settings in JSON format for the source MongoDB endpoint.
default ModifyEndpointRequest.Builder	mySQLSettings(Consumer<MySQLSettings.Builder> mySQLSettings)	Settings in JSON format for the source and target MySQL endpoint.
ModifyEndpointRequest.Builder	mySQLSettings(MySQLSettings mySQLSettings)	Settings in JSON format for the source and target MySQL endpoint.
default ModifyEndpointRequest.Builder	neptuneSettings(Consumer<NeptuneSettings.Builder> neptuneSettings)	Settings in JSON format for the target Amazon Neptune endpoint.
ModifyEndpointRequest.Builder	neptuneSettings(NeptuneSettings neptuneSettings)	Settings in JSON format for the target Amazon Neptune endpoint.
default ModifyEndpointRequest.Builder	oracleSettings(Consumer<OracleSettings.Builder> oracleSettings)	Settings in JSON format for the source and target Oracle endpoint.
ModifyEndpointRequest.Builder	oracleSettings(OracleSettings oracleSettings)	Settings in JSON format for the source and target Oracle endpoint.
ModifyEndpointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ModifyEndpointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ModifyEndpointRequest.Builder	password(String password)	The password to be used to login to the endpoint database.
ModifyEndpointRequest.Builder	port(Integer port)	The port used by the endpoint database.
default ModifyEndpointRequest.Builder	postgreSQLSettings(Consumer<PostgreSQLSettings.Builder> postgreSQLSettings)	Settings in JSON format for the source and target PostgreSQL endpoint.
ModifyEndpointRequest.Builder	postgreSQLSettings(PostgreSQLSettings postgreSQLSettings)	Settings in JSON format for the source and target PostgreSQL endpoint.
default ModifyEndpointRequest.Builder	redisSettings(Consumer<RedisSettings.Builder> redisSettings)	Settings in JSON format for the Redis target endpoint.
ModifyEndpointRequest.Builder	redisSettings(RedisSettings redisSettings)	Settings in JSON format for the Redis target endpoint.
default ModifyEndpointRequest.Builder	redshiftSettings(Consumer<RedshiftSettings.Builder> redshiftSettings)	Sets the value of the RedshiftSettings property for this object.
ModifyEndpointRequest.Builder	redshiftSettings(RedshiftSettings redshiftSettings)	Sets the value of the RedshiftSettings property for this object.
default ModifyEndpointRequest.Builder	s3Settings(Consumer<S3Settings.Builder> s3Settings)	Settings in JSON format for the target Amazon S3 endpoint.
ModifyEndpointRequest.Builder	s3Settings(S3Settings s3Settings)	Settings in JSON format for the target Amazon S3 endpoint.
ModifyEndpointRequest.Builder	serverName(String serverName)	The name of the server where the endpoint database resides.
ModifyEndpointRequest.Builder	serviceAccessRoleArn(String serviceAccessRoleArn)	The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint.
ModifyEndpointRequest.Builder	sslMode(String sslMode)	The SSL mode used to connect to the endpoint.
ModifyEndpointRequest.Builder	sslMode(DmsSslModeValue sslMode)	The SSL mode used to connect to the endpoint.
default ModifyEndpointRequest.Builder	sybaseSettings(Consumer<SybaseSettings.Builder> sybaseSettings)	Settings in JSON format for the source and target SAP ASE endpoint.
ModifyEndpointRequest.Builder	sybaseSettings(SybaseSettings sybaseSettings)	Settings in JSON format for the source and target SAP ASE endpoint.
default ModifyEndpointRequest.Builder	timestreamSettings(Consumer<TimestreamSettings.Builder> timestreamSettings)	Settings in JSON format for the target Amazon Timestream endpoint.
ModifyEndpointRequest.Builder	timestreamSettings(TimestreamSettings timestreamSettings)	Settings in JSON format for the target Amazon Timestream endpoint.
ModifyEndpointRequest.Builder	username(String username)	The user name to be used to login to the endpoint database.

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.databasemigration.model.DatabaseMigrationRequest.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

endpointArn

ModifyEndpointRequest.Builder endpointArn(String endpointArn)

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Parameters:

endpointArn - The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Returns:

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

endpointIdentifier

ModifyEndpointRequest.Builder endpointIdentifier(String endpointIdentifier)

The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

Parameters:

endpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens.

Returns:

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

endpointType

ModifyEndpointRequest.Builder endpointType(String endpointType)

The type of endpoint. Valid values are source and target.

Parameters:

endpointType - The type of endpoint. Valid values are source and target.

Returns:

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

See Also:

• ReplicationEndpointTypeValue
• ReplicationEndpointTypeValue

endpointType

ModifyEndpointRequest.Builder endpointType(ReplicationEndpointTypeValue endpointType)

The type of endpoint. Valid values are source and target.

Parameters:

endpointType - The type of endpoint. Valid values are source and target.

Returns:

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

See Also:

• ReplicationEndpointTypeValue
• ReplicationEndpointTypeValue

engineName

ModifyEndpointRequest.Builder engineName(String engineName)

The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Parameters:

engineName - The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

Returns:

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

username

ModifyEndpointRequest.Builder username(String username)

The user name to be used to login to the endpoint database.

Parameters:

username - The user name to be used to login to the endpoint database.

Returns:

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

password

ModifyEndpointRequest.Builder password(String password)

The password to be used to login to the endpoint database.

Parameters:

password - The password to be used to login to the endpoint database.

Returns:

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

serverName

ModifyEndpointRequest.Builder serverName(String serverName)

The name of the server where the endpoint database resides.

Parameters:

serverName - The name of the server where the endpoint database resides.

Returns:

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

port

ModifyEndpointRequest.Builder port(Integer port)

The port used by the endpoint database.

Parameters:

port - The port used by the endpoint database.

Returns:

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

databaseName

ModifyEndpointRequest.Builder databaseName(String databaseName)

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

Parameters:

databaseName - The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

Returns:

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

extraConnectionAttributes

ModifyEndpointRequest.Builder extraConnectionAttributes(String extraConnectionAttributes)

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

Returns:

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

certificateArn

ModifyEndpointRequest.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

Parameters:

certificateArn - The Amazon Resource Name (ARN) of the certificate used for SSL connection.

Returns:

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

sslMode

ModifyEndpointRequest.Builder sslMode(String sslMode)

The SSL mode used to connect to the endpoint. The default value is none.

Parameters:

sslMode - The SSL mode used to connect to the endpoint. The default value is none.

Returns:

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

See Also:

• DmsSslModeValue
• DmsSslModeValue

sslMode

ModifyEndpointRequest.Builder sslMode(DmsSslModeValue sslMode)

The SSL mode used to connect to the endpoint. The default value is none.

Parameters:

sslMode - The SSL mode used to connect to the endpoint. The default value is none.

Returns:

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

See Also:

• DmsSslModeValue
• DmsSslModeValue

serviceAccessRoleArn

ModifyEndpointRequest.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

Parameters:

serviceAccessRoleArn - The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the iam:PassRole action.

Returns:

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

externalTableDefinition

ModifyEndpointRequest.Builder externalTableDefinition(String externalTableDefinition)

The external table definition.

Parameters:

externalTableDefinition - The external table definition.

Returns:

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

dynamoDbSettings

ModifyEndpointRequest.Builder dynamoDbSettings(DynamoDbSettings dynamoDbSettings)

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

Returns:

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

dynamoDbSettings

default ModifyEndpointRequest.Builder dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings)

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Database Migration Service User Guide.

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

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

Parameters:

dynamoDbSettings - a consumer that will call methods on DynamoDbSettings.Builder

Returns:

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

See Also:

• dynamoDbSettings(DynamoDbSettings)

s3Settings

ModifyEndpointRequest.Builder s3Settings(S3Settings s3Settings)

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

Parameters:

s3Settings - Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

Returns:

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

s3Settings

default ModifyEndpointRequest.Builder s3Settings(Consumer<S3Settings.Builder> s3Settings)

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

s3Settings - a consumer that will call methods on S3Settings.Builder

Returns:

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

See Also:

• s3Settings(S3Settings)

dmsTransferSettings

ModifyEndpointRequest.Builder dmsTransferSettings(DmsTransferSettings dmsTransferSettings)

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

• BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

Parameters:

dmsTransferSettings - The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

• BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

Returns:

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

dmsTransferSettings

default ModifyEndpointRequest.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

• serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

• BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

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

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

Parameters:

dmsTransferSettings - a consumer that will call methods on DmsTransferSettings.Builder

Returns:

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

See Also:

• dmsTransferSettings(DmsTransferSettings)

mongoDbSettings

ModifyEndpointRequest.Builder mongoDbSettings(MongoDbSettings mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

Returns:

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

mongoDbSettings

default ModifyEndpointRequest.Builder mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Database Migration Service in the Database Migration Service User Guide.

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

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

Parameters:

mongoDbSettings - a consumer that will call methods on MongoDbSettings.Builder

Returns:

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

See Also:

• mongoDbSettings(MongoDbSettings)

kinesisSettings

ModifyEndpointRequest.Builder kinesisSettings(KinesisSettings kinesisSettings)

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

Parameters:

kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

Returns:

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

kinesisSettings

default ModifyEndpointRequest.Builder kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings)

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Database Migration Service User Guide.

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

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

Parameters:

kinesisSettings - a consumer that will call methods on KinesisSettings.Builder

Returns:

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

See Also:

• kinesisSettings(KinesisSettings)

kafkaSettings

ModifyEndpointRequest.Builder kafkaSettings(KafkaSettings kafkaSettings)

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

Parameters:

kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

Returns:

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

kafkaSettings

default ModifyEndpointRequest.Builder kafkaSettings(Consumer<KafkaSettings.Builder> kafkaSettings)

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Database Migration Service User Guide.

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

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

Parameters:

kafkaSettings - a consumer that will call methods on KafkaSettings.Builder

Returns:

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

See Also:

• kafkaSettings(KafkaSettings)

elasticsearchSettings

ModifyEndpointRequest.Builder elasticsearchSettings(ElasticsearchSettings elasticsearchSettings)

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

Parameters:

elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

Returns:

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

elasticsearchSettings

default ModifyEndpointRequest.Builder elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings)

Settings in JSON format for the target OpenSearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

elasticsearchSettings - a consumer that will call methods on ElasticsearchSettings.Builder

Returns:

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

See Also:

• elasticsearchSettings(ElasticsearchSettings)

neptuneSettings

ModifyEndpointRequest.Builder neptuneSettings(NeptuneSettings neptuneSettings)

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

Parameters:

neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

Returns:

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

neptuneSettings

default ModifyEndpointRequest.Builder neptuneSettings(Consumer<NeptuneSettings.Builder> neptuneSettings)

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Database Migration Service User Guide.

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

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

Parameters:

neptuneSettings - a consumer that will call methods on NeptuneSettings.Builder

Returns:

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

See Also:

• neptuneSettings(NeptuneSettings)

redshiftSettings

ModifyEndpointRequest.Builder redshiftSettings(RedshiftSettings redshiftSettings)

Sets the value of the RedshiftSettings property for this object.

Parameters:

redshiftSettings - The new value for the RedshiftSettings property for this object.

Returns:

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

redshiftSettings

default ModifyEndpointRequest.Builder redshiftSettings(Consumer<RedshiftSettings.Builder> redshiftSettings)

Sets the value of the RedshiftSettings property for this object. This is a convenience method that creates an instance of the RedshiftSettings.Builder avoiding the need to create one manually via RedshiftSettings.builder().

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

Parameters:

redshiftSettings - a consumer that will call methods on RedshiftSettings.Builder

Returns:

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

See Also:

• redshiftSettings(RedshiftSettings)

postgreSQLSettings

ModifyEndpointRequest.Builder postgreSQLSettings(PostgreSQLSettings postgreSQLSettings)

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

Parameters:

postgreSQLSettings - Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

Returns:

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

postgreSQLSettings

default ModifyEndpointRequest.Builder postgreSQLSettings(Consumer<PostgreSQLSettings.Builder> postgreSQLSettings)

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for DMS and Extra connection attributes when using PostgreSQL as a target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

postgreSQLSettings - a consumer that will call methods on PostgreSQLSettings.Builder

Returns:

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

See Also:

• postgreSQLSettings(PostgreSQLSettings)

mySQLSettings

ModifyEndpointRequest.Builder mySQLSettings(MySQLSettings mySQLSettings)

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

Parameters:

mySQLSettings - Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

Returns:

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

mySQLSettings

default ModifyEndpointRequest.Builder mySQLSettings(Consumer<MySQLSettings.Builder> mySQLSettings)

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for DMS and Extra connection attributes when using a MySQL-compatible database as a target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

mySQLSettings - a consumer that will call methods on MySQLSettings.Builder

Returns:

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

See Also:

• mySQLSettings(MySQLSettings)

oracleSettings

ModifyEndpointRequest.Builder oracleSettings(OracleSettings oracleSettings)

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

Parameters:

oracleSettings - Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

Returns:

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

oracleSettings

default ModifyEndpointRequest.Builder oracleSettings(Consumer<OracleSettings.Builder> oracleSettings)

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for DMS and Extra connection attributes when using Oracle as a target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

oracleSettings - a consumer that will call methods on OracleSettings.Builder

Returns:

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

See Also:

• oracleSettings(OracleSettings)

sybaseSettings

ModifyEndpointRequest.Builder sybaseSettings(SybaseSettings sybaseSettings)

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

Parameters:

sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

Returns:

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

sybaseSettings

default ModifyEndpointRequest.Builder sybaseSettings(Consumer<SybaseSettings.Builder> sybaseSettings)

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for DMS and Extra connection attributes when using SAP ASE as a target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

sybaseSettings - a consumer that will call methods on SybaseSettings.Builder

Returns:

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

See Also:

• sybaseSettings(SybaseSettings)

microsoftSQLServerSettings

ModifyEndpointRequest.Builder microsoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings)

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

Parameters:

microsoftSQLServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

Returns:

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

microsoftSQLServerSettings

default ModifyEndpointRequest.Builder microsoftSQLServerSettings(Consumer<MicrosoftSQLServerSettings.Builder> microsoftSQLServerSettings)

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for DMS and Extra connection attributes when using SQL Server as a target for DMS in the Database Migration Service User Guide.

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

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

Parameters:

microsoftSQLServerSettings - a consumer that will call methods on MicrosoftSQLServerSettings.Builder

Returns:

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

See Also:

• microsoftSQLServerSettings(MicrosoftSQLServerSettings)

ibmDb2Settings

ModifyEndpointRequest.Builder ibmDb2Settings(IBMDb2Settings ibmDb2Settings)

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

Parameters:

ibmDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

Returns:

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

ibmDb2Settings

default ModifyEndpointRequest.Builder ibmDb2Settings(Consumer<IBMDb2Settings.Builder> ibmDb2Settings)

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for DMS in the Database Migration Service User Guide.

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

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

Parameters:

ibmDb2Settings - a consumer that will call methods on IBMDb2Settings.Builder

Returns:

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

See Also:

• ibmDb2Settings(IBMDb2Settings)

docDbSettings

ModifyEndpointRequest.Builder docDbSettings(DocDbSettings docDbSettings)

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

Parameters:

docDbSettings - Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

Returns:

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

docDbSettings

default ModifyEndpointRequest.Builder docDbSettings(Consumer<DocDbSettings.Builder> docDbSettings)

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service in the Database Migration Service User Guide.

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

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

Parameters:

docDbSettings - a consumer that will call methods on DocDbSettings.Builder

Returns:

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

See Also:

• docDbSettings(DocDbSettings)

redisSettings

ModifyEndpointRequest.Builder redisSettings(RedisSettings redisSettings)

Settings in JSON format for the Redis target endpoint.

Parameters:

redisSettings - Settings in JSON format for the Redis target endpoint.

Returns:

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

redisSettings

default ModifyEndpointRequest.Builder redisSettings(Consumer<RedisSettings.Builder> redisSettings)

Settings in JSON format for the Redis target endpoint.

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

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

Parameters:

redisSettings - a consumer that will call methods on RedisSettings.Builder

Returns:

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

See Also:

• redisSettings(RedisSettings)

exactSettings

ModifyEndpointRequest.Builder exactSettings(Boolean exactSettings)

If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

• It replaces any endpoint settings that already exist with new values, for settings with the same names.

• It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

Parameters:

exactSettings - If this attribute is Y, the current call to ModifyEndpoint replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyEndpoint does two things:

• It replaces any endpoint settings that already exist with new values, for settings with the same names.

• It creates new endpoint settings that you specify in the call, for settings with different names.

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

Returns:

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

gcpMySQLSettings

ModifyEndpointRequest.Builder gcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings)

Settings in JSON format for the source GCP MySQL endpoint.

Parameters:

gcpMySQLSettings - Settings in JSON format for the source GCP MySQL endpoint.

Returns:

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

gcpMySQLSettings

default ModifyEndpointRequest.Builder gcpMySQLSettings(Consumer<GcpMySQLSettings.Builder> gcpMySQLSettings)

Settings in JSON format for the source GCP MySQL endpoint.

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

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

Parameters:

gcpMySQLSettings - a consumer that will call methods on GcpMySQLSettings.Builder

Returns:

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

See Also:

• gcpMySQLSettings(GcpMySQLSettings)

timestreamSettings

ModifyEndpointRequest.Builder timestreamSettings(TimestreamSettings timestreamSettings)

Settings in JSON format for the target Amazon Timestream endpoint.

Parameters:

timestreamSettings - Settings in JSON format for the target Amazon Timestream endpoint.

Returns:

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

timestreamSettings

default ModifyEndpointRequest.Builder timestreamSettings(Consumer<TimestreamSettings.Builder> timestreamSettings)

Settings in JSON format for the target Amazon Timestream endpoint.

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

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

Parameters:

timestreamSettings - a consumer that will call methods on TimestreamSettings.Builder

Returns:

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

See Also:

• timestreamSettings(TimestreamSettings)

overrideConfiguration

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

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