software.amazon.awssdk.services.databasemigration.model

Interface CreateEndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateEndpointRequest

public static interface CreateEndpointRequest.Builder
extends DatabaseMigrationRequest.Builder, 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	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.
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	extraConnectionAttributes(String extraConnectionAttributes) Additional attributes associated with the connection.
CreateEndpointRequest.Builder	kmsKeyId(String kmsKeyId) The KMS key identifier that will be used to encrypt the connection parameters.
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.
CreateEndpointRequest.Builder	password(String password) The password to be used to login to the endpoint database.
CreateEndpointRequest.Builder	port(Integer port) The port used by the endpoint database.
CreateEndpointRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
CreateEndpointRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
default CreateEndpointRequest.Builder	s3Settings(Consumer<S3Settings.Builder> s3Settings) Settings in JSON format for the target S3 endpoint.
CreateEndpointRequest.Builder	s3Settings(S3Settings s3Settings) Settings in JSON format for the target S3 endpoint.
CreateEndpointRequest.Builder	serverName(String serverName) The name of the server where the endpoint database resides.
CreateEndpointRequest.Builder	sslMode(DmsSslModeValue sslMode) The SSL mode to use for the SSL connection.
CreateEndpointRequest.Builder	sslMode(String sslMode) The SSL mode to use for the SSL connection.
CreateEndpointRequest.Builder	tags(Collection<Tag> tags) Tags to be added to the endpoint.
CreateEndpointRequest.Builder	tags(Consumer<Tag.Builder>... tags) Tags to be added to the endpoint.
CreateEndpointRequest.Builder	tags(Tag... tags) Tags to be added to the endpoint.
CreateEndpointRequest.Builder	username(String username) The user name to be used to login 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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

endpointIdentifier

CreateEndpointRequest.Builder endpointIdentifier(String endpointIdentifier)

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

Parameters:

endpointIdentifier - The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not 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.

Parameters:

endpointType - The type of endpoint.

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.

Parameters:

endpointType - The type of endpoint.

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, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Parameters:

engineName - The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

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

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

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.

Parameters:

databaseName - The name of the endpoint database.

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.

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection.

Returns:

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

kmsKeyId

CreateEndpointRequest.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

Parameters:

kmsKeyId - The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

Returns:

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

tags

CreateEndpointRequest.Builder tags(Collection<Tag> tags)

Tags to be added to the endpoint.

Parameters:

tags - Tags to be added to the endpoint.

Returns:

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

tags

CreateEndpointRequest.Builder tags(Tag... tags)

Tags to be added to the endpoint.

Parameters:

tags - Tags to be added 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)

Tags to be added to the endpoint.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

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 SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

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

CreateEndpointRequest.Builder sslMode(DmsSslModeValue sslMode)

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Parameters:

sslMode - The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

Returns:

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

See Also:

DmsSslModeValue, DmsSslModeValue

dynamoDbSettings

CreateEndpointRequest.Builder dynamoDbSettings(DynamoDbSettings dynamoDbSettings)

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

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 more information about the available settings, see the Using Object Mapping to Migrate Data to DynamoDB section at Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service.

This is a convenience 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 S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

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

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 S3 endpoint. For more information about the available settings, see the Extra Connection Attributes section at Using Amazon S3 as a Target for AWS Database Migration Service.

This is a convenience 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)

mongoDbSettings

CreateEndpointRequest.Builder mongoDbSettings(MongoDbSettings mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

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 the Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service section at Using Amazon S3 as a Target for AWS Database Migration Service.

This is a convenience 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)

requestOverrideConfig

CreateEndpointRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

CreateEndpointRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.