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

Interface Endpoint.Builder

All Superinterfaces:

CopyableBuilder<Endpoint.Builder,Endpoint>, SdkBuilder<Endpoint.Builder,Endpoint>

Enclosing class:

Endpoint

public static interface Endpoint.Builder
extends CopyableBuilder<Endpoint.Builder,Endpoint>

Method Summary

Modifier and Type	Method	Description
Endpoint.Builder	certificateArn(String certificateArn)	The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
Endpoint.Builder	databaseName(String databaseName)	The name of the database at the endpoint.
Endpoint.Builder	dynamoDbSettings(DynamoDbSettings dynamoDbSettings)	The settings for the target DynamoDB database.
Endpoint.Builder	endpointArn(String endpointArn)	The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Endpoint.Builder	endpointIdentifier(String endpointIdentifier)	The database endpoint identifier.
Endpoint.Builder	endpointType(String endpointType)	The type of endpoint.
Endpoint.Builder	endpointType(ReplicationEndpointTypeValue endpointType)	The type of endpoint.
Endpoint.Builder	engineName(String engineName)	The database engine name.
Endpoint.Builder	externalId(String externalId)	Value returned by a call to CreateEndpoint that can be used for cross-account validation.
Endpoint.Builder	extraConnectionAttributes(String extraConnectionAttributes)	Additional connection attributes used to connect to the endpoint.
Endpoint.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier that will be used to encrypt the connection parameters.
Endpoint.Builder	mongoDbSettings(MongoDbSettings mongoDbSettings)	The settings for the MongoDB source endpoint.
Endpoint.Builder	port(Integer port)	The port value used to access the endpoint.
Endpoint.Builder	s3Settings(S3Settings s3Settings)	The settings for the S3 target endpoint.
Endpoint.Builder	serverName(String serverName)	The name of the server at the endpoint.
Endpoint.Builder	sslMode(String sslMode)	The SSL mode used to connect to the endpoint.
Endpoint.Builder	sslMode(DmsSslModeValue sslMode)	The SSL mode used to connect to the endpoint.
Endpoint.Builder	status(String status)	The status of the endpoint.
Endpoint.Builder	username(String username)	The user name used to connect to the endpoint.

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

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

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

endpointType

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

engineName

Endpoint.Builder engineName(String engineName)

The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.

Parameters:

engineName - The database engine name. 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

Endpoint.Builder username(String username)

The user name used to connect to the endpoint.

Parameters:

username - The user name used to connect to the endpoint.

Returns:

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

serverName

Endpoint.Builder serverName(String serverName)

The name of the server at the endpoint.

Parameters:

serverName - The name of the server at the endpoint.

Returns:

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

port

Endpoint.Builder port(Integer port)

The port value used to access the endpoint.

Parameters:

port - The port value used to access the endpoint.

Returns:

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

databaseName

Endpoint.Builder databaseName(String databaseName)

The name of the database at the endpoint.

Parameters:

databaseName - The name of the database at the endpoint.

Returns:

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

extraConnectionAttributes

Endpoint.Builder extraConnectionAttributes(String extraConnectionAttributes)

Additional connection attributes used to connect to the endpoint.

Parameters:

extraConnectionAttributes - Additional connection attributes used to connect to the endpoint.

Returns:

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

status

Endpoint.Builder status(String status)

The status of the endpoint.

Parameters:

status - The status of the endpoint.

Returns:

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

kmsKeyId

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

endpointArn

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

certificateArn

Endpoint.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Parameters:

certificateArn - The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

Returns:

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

sslMode

Endpoint.Builder sslMode(String sslMode)

The SSL mode used to connect to the endpoint.

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

The default value is none.

Parameters:

sslMode - The SSL mode used to connect to the endpoint.

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

sslMode

Endpoint.Builder sslMode(DmsSslModeValue sslMode)

The SSL mode used to connect to the endpoint.

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

The default value is none.

Parameters:

sslMode - The SSL mode used to connect to the endpoint.

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

externalId

Endpoint.Builder externalId(String externalId)

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Parameters:

externalId - Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

Returns:

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

dynamoDbSettings

Endpoint.Builder dynamoDbSettings(DynamoDbSettings dynamoDbSettings)

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

Parameters:

dynamoDbSettings - The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

Returns:

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

s3Settings

Endpoint.Builder s3Settings(S3Settings s3Settings)

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Parameters:

s3Settings - The settings for the S3 target endpoint. For more information, see the S3Settings structure.

Returns:

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

mongoDbSettings

Endpoint.Builder mongoDbSettings(MongoDbSettings mongoDbSettings)

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Parameters:

mongoDbSettings - The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

Returns:

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