software.amazon.awssdk.services.databasemigration.model

Interface CreateEndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateEndpointRequest

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

Method Summary

Modifier and Type	Method and Description
CreateEndpointRequest.Builder	certificateArn(String certificateArn) The Amazon Resource Name (ARN) for the certificate.
CreateEndpointRequest.Builder	databaseName(String databaseName) The name of the endpoint database.
default CreateEndpointRequest.Builder	dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings) The settings in JSON format for the DMS transfer type of source endpoint.
CreateEndpointRequest.Builder	dmsTransferSettings(DmsTransferSettings dmsTransferSettings) The settings in JSON format for the DMS transfer type of source endpoint.
default CreateEndpointRequest.Builder	docDbSettings(Consumer<DocDbSettings.Builder> docDbSettings) Sets the value of the DocDbSettings property for this object.
CreateEndpointRequest.Builder	docDbSettings(DocDbSettings docDbSettings) Sets the value of the DocDbSettings property for this object.
default CreateEndpointRequest.Builder	dynamoDbSettings(Consumer<DynamoDbSettings.Builder> dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.
CreateEndpointRequest.Builder	dynamoDbSettings(DynamoDbSettings dynamoDbSettings) Settings in JSON format for the target Amazon DynamoDB endpoint.
default CreateEndpointRequest.Builder	elasticsearchSettings(Consumer<ElasticsearchSettings.Builder> elasticsearchSettings) Settings in JSON format for the target OpenSearch endpoint.
CreateEndpointRequest.Builder	elasticsearchSettings(ElasticsearchSettings elasticsearchSettings) Settings in JSON format for the target OpenSearch endpoint.
CreateEndpointRequest.Builder	endpointIdentifier(String endpointIdentifier) The database endpoint identifier.
CreateEndpointRequest.Builder	endpointType(ReplicationEndpointTypeValue endpointType) The type of endpoint.
CreateEndpointRequest.Builder	endpointType(String endpointType) The type of endpoint.
CreateEndpointRequest.Builder	engineName(String engineName) The type of engine for the endpoint.
CreateEndpointRequest.Builder	externalTableDefinition(String externalTableDefinition) The external table definition.
CreateEndpointRequest.Builder	extraConnectionAttributes(String extraConnectionAttributes) Additional attributes associated with the connection.
default CreateEndpointRequest.Builder	gcpMySQLSettings(Consumer<GcpMySQLSettings.Builder> gcpMySQLSettings) Settings in JSON format for the source GCP MySQL endpoint.
CreateEndpointRequest.Builder	gcpMySQLSettings(GcpMySQLSettings gcpMySQLSettings) Settings in JSON format for the source GCP MySQL endpoint.
default CreateEndpointRequest.Builder	ibmDb2Settings(Consumer<IBMDb2Settings.Builder> ibmDb2Settings) Settings in JSON format for the source IBM Db2 LUW endpoint.
CreateEndpointRequest.Builder	ibmDb2Settings(IBMDb2Settings ibmDb2Settings) Settings in JSON format for the source IBM Db2 LUW endpoint.
default CreateEndpointRequest.Builder	kafkaSettings(Consumer<KafkaSettings.Builder> kafkaSettings) Settings in JSON format for the target Apache Kafka endpoint.
CreateEndpointRequest.Builder	kafkaSettings(KafkaSettings kafkaSettings) Settings in JSON format for the target Apache Kafka endpoint.
default CreateEndpointRequest.Builder	kinesisSettings(Consumer<KinesisSettings.Builder> kinesisSettings) Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
CreateEndpointRequest.Builder	kinesisSettings(KinesisSettings kinesisSettings) Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
CreateEndpointRequest.Builder	kmsKeyId(String kmsKeyId) An KMS key identifier that is used to encrypt the connection parameters for the endpoint.
default CreateEndpointRequest.Builder	microsoftSQLServerSettings(Consumer<MicrosoftSQLServerSettings.Builder> microsoftSQLServerSettings) Settings in JSON format for the source and target Microsoft SQL Server endpoint.
CreateEndpointRequest.Builder	microsoftSQLServerSettings(MicrosoftSQLServerSettings microsoftSQLServerSettings) Settings in JSON format for the source and target Microsoft SQL Server endpoint.
default CreateEndpointRequest.Builder	mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.
CreateEndpointRequest.Builder	mongoDbSettings(MongoDbSettings mongoDbSettings) Settings in JSON format for the source MongoDB endpoint.
default CreateEndpointRequest.Builder	mySQLSettings(Consumer<MySQLSettings.Builder> mySQLSettings) Settings in JSON format for the source and target MySQL endpoint.
CreateEndpointRequest.Builder	mySQLSettings(MySQLSettings mySQLSettings) Settings in JSON format for the source and target MySQL endpoint.
default CreateEndpointRequest.Builder	neptuneSettings(Consumer<NeptuneSettings.Builder> neptuneSettings) Settings in JSON format for the target Amazon Neptune endpoint.
CreateEndpointRequest.Builder	neptuneSettings(NeptuneSettings neptuneSettings) Settings in JSON format for the target Amazon Neptune endpoint.
default CreateEndpointRequest.Builder	oracleSettings(Consumer<OracleSettings.Builder> oracleSettings) Settings in JSON format for the source and target Oracle endpoint.
CreateEndpointRequest.Builder	oracleSettings(OracleSettings oracleSettings) Settings in JSON format for the source and target Oracle endpoint.
CreateEndpointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateEndpointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateEndpointRequest.Builder	password(String password) The password to be used to log in to the endpoint database.
CreateEndpointRequest.Builder	port(Integer port) The port used by the endpoint database.
default CreateEndpointRequest.Builder	postgreSQLSettings(Consumer<PostgreSQLSettings.Builder> postgreSQLSettings) Settings in JSON format for the source and target PostgreSQL endpoint.
CreateEndpointRequest.Builder	postgreSQLSettings(PostgreSQLSettings postgreSQLSettings) Settings in JSON format for the source and target PostgreSQL endpoint.
default CreateEndpointRequest.Builder	redisSettings(Consumer<RedisSettings.Builder> redisSettings) Settings in JSON format for the target Redis endpoint.
CreateEndpointRequest.Builder	redisSettings(RedisSettings redisSettings) Settings in JSON format for the target Redis endpoint.
default CreateEndpointRequest.Builder	redshiftSettings(Consumer<RedshiftSettings.Builder> redshiftSettings) Sets the value of the RedshiftSettings property for this object.
CreateEndpointRequest.Builder	redshiftSettings(RedshiftSettings redshiftSettings) Sets the value of the RedshiftSettings property for this object.
CreateEndpointRequest.Builder	resourceIdentifier(String resourceIdentifier) A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
default CreateEndpointRequest.Builder	s3Settings(Consumer<S3Settings.Builder> s3Settings) Settings in JSON format for the target Amazon S3 endpoint.
CreateEndpointRequest.Builder	s3Settings(S3Settings s3Settings) Settings in JSON format for the target Amazon S3 endpoint.
CreateEndpointRequest.Builder	serverName(String serverName) The name of the server where the endpoint database resides.
CreateEndpointRequest.Builder	serviceAccessRoleArn(String serviceAccessRoleArn) The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
CreateEndpointRequest.Builder	sslMode(DmsSslModeValue sslMode) The Secure Sockets Layer (SSL) mode to use for the SSL connection.
CreateEndpointRequest.Builder	sslMode(String sslMode) The Secure Sockets Layer (SSL) mode to use for the SSL connection.
default CreateEndpointRequest.Builder	sybaseSettings(Consumer<SybaseSettings.Builder> sybaseSettings) Settings in JSON format for the source and target SAP ASE endpoint.
CreateEndpointRequest.Builder	sybaseSettings(SybaseSettings sybaseSettings) Settings in JSON format for the source and target SAP ASE endpoint.
CreateEndpointRequest.Builder	tags(Collection<Tag> tags) One or more tags to be assigned to the endpoint.
CreateEndpointRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the endpoint.
CreateEndpointRequest.Builder	tags(Tag... tags) One or more tags to be assigned to the endpoint.
default CreateEndpointRequest.Builder	timestreamSettings(Consumer<TimestreamSettings.Builder> timestreamSettings) Settings in JSON format for the target Amazon Timestream endpoint.
CreateEndpointRequest.Builder	timestreamSettings(TimestreamSettings timestreamSettings) Settings in JSON format for the target Amazon Timestream endpoint.
CreateEndpointRequest.Builder	username(String username) The user name to be used to log in to the endpoint database.

Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.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

endpointIdentifier

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

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

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

CreateEndpointRequest.Builder engineName(String engineName)

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

Parameters:

engineName - The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "opensearch", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "docdb", "sqlserver", "neptune", and "babelfish".

Returns:

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

username

CreateEndpointRequest.Builder username(String username)

The user name to be used to log in to the endpoint database.

Parameters:

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

Returns:

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

password

CreateEndpointRequest.Builder password(String password)

The password to be used to log in to the endpoint database.

Parameters:

password - The password to be used to log in to the endpoint database.

Returns:

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

serverName

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

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

CreateEndpointRequest.Builder databaseName(String databaseName)

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

Parameters:

databaseName - The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType.

Returns:

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

extraConnectionAttributes

CreateEndpointRequest.Builder extraConnectionAttributes(String extraConnectionAttributes)

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with DMS Endpoints in the Database Migration Service User Guide.

Returns:

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

kmsKeyId

CreateEndpointRequest.Builder kmsKeyId(String kmsKeyId)

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Parameters:

kmsKeyId - An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

Returns:

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

tags

CreateEndpointRequest.Builder tags(Collection<Tag> tags)

One or more tags to be assigned to the endpoint.

Parameters:

tags - One or more tags to be assigned to the endpoint.

Returns:

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

tags

CreateEndpointRequest.Builder tags(Tag... tags)

One or more tags to be assigned to the endpoint.

Parameters:

tags - One or more tags to be assigned to the endpoint.

Returns:

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

tags

CreateEndpointRequest.Builder tags(Consumer<Tag.Builder>... tags)

One or more tags to be assigned to the endpoint.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

certificateArn

CreateEndpointRequest.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the certificate.

Returns:

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

sslMode

CreateEndpointRequest.Builder sslMode(String sslMode)

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

Parameters:

sslMode - The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

Returns:

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

See Also:

DmsSslModeValue, DmsSslModeValue

sslMode

CreateEndpointRequest.Builder sslMode(DmsSslModeValue sslMode)

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

Parameters:

sslMode - The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

Returns:

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

See Also:

DmsSslModeValue, DmsSslModeValue

serviceAccessRoleArn

CreateEndpointRequest.Builder serviceAccessRoleArn(String serviceAccessRoleArn)

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint. The role must allow the iam:PassRole action.

Parameters:

serviceAccessRoleArn - The Amazon Resource Name (ARN) for the service access role that you want to use to create 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

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

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

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

CreateEndpointRequest.Builder dmsTransferSettings(DmsTransferSettings dmsTransferSettings)

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

Possible settings 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.

Possible settings 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 CreateEndpointRequest.Builder dmsTransferSettings(Consumer<DmsTransferSettings.Builder> dmsTransferSettings)

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

Possible settings 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

CreateEndpointRequest.Builder mongoDbSettings(MongoDbSettings mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see 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 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 CreateEndpointRequest.Builder mongoDbSettings(Consumer<MongoDbSettings.Builder> mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see 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

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

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

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

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

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

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

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

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

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

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

CreateEndpointRequest.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 CreateEndpointRequest.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)

resourceIdentifier

CreateEndpointRequest.Builder resourceIdentifier(String resourceIdentifier)

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

Parameters:

resourceIdentifier - A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1. For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.

Returns:

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

docDbSettings

CreateEndpointRequest.Builder docDbSettings(DocDbSettings docDbSettings)

Sets the value of the DocDbSettings property for this object.

Parameters:

docDbSettings - The new value for the DocDbSettings property for this object.

Returns:

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

docDbSettings

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

Sets the value of the DocDbSettings property for this object. 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

CreateEndpointRequest.Builder redisSettings(RedisSettings redisSettings)

Settings in JSON format for the target Redis endpoint.

Parameters:

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

Returns:

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

redisSettings

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

Settings in JSON format for the target Redis 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)

gcpMySQLSettings

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

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

CreateEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder