Package software.amazon.awscdk.services.dms

Class CfnEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint>

Enclosing class:

CfnEndpoint

@Stability(Stable)
public static final class CfnEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint>

A fluent builder for CfnEndpoint.

Method Summary

Modifier and Type	Method	Description
CfnEndpoint	build()
CfnEndpoint.Builder	certificateArn(String certificateArn)	The Amazon Resource Name (ARN) for the certificate.
static CfnEndpoint.Builder	create(Construct scope, String id)
CfnEndpoint.Builder	databaseName(String databaseName)	The name of the endpoint database.
CfnEndpoint.Builder	docDbSettings(IResolvable docDbSettings)	Settings in JSON format for the source and target DocumentDB endpoint.
CfnEndpoint.Builder	docDbSettings(CfnEndpoint.DocDbSettingsProperty docDbSettings)	Settings in JSON format for the source and target DocumentDB endpoint.
CfnEndpoint.Builder	dynamoDbSettings(IResolvable dynamoDbSettings)	Settings in JSON format for the target Amazon DynamoDB endpoint.
CfnEndpoint.Builder	dynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty dynamoDbSettings)	Settings in JSON format for the target Amazon DynamoDB endpoint.
CfnEndpoint.Builder	elasticsearchSettings(IResolvable elasticsearchSettings)	Settings in JSON format for the target OpenSearch endpoint.
CfnEndpoint.Builder	elasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty elasticsearchSettings)	Settings in JSON format for the target OpenSearch endpoint.
CfnEndpoint.Builder	endpointIdentifier(String endpointIdentifier)	The database endpoint identifier.
CfnEndpoint.Builder	endpointType(String endpointType)	The type of endpoint.
CfnEndpoint.Builder	engineName(String engineName)	The type of engine for the endpoint, depending on the EndpointType value.
CfnEndpoint.Builder	extraConnectionAttributes(String extraConnectionAttributes)	Additional attributes associated with the connection.
CfnEndpoint.Builder	gcpMySqlSettings(IResolvable gcpMySqlSettings)	Settings in JSON format for the source GCP MySQL endpoint.
CfnEndpoint.Builder	gcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty gcpMySqlSettings)	Settings in JSON format for the source GCP MySQL endpoint.
CfnEndpoint.Builder	ibmDb2Settings(IResolvable ibmDb2Settings)	Settings in JSON format for the source IBM Db2 LUW endpoint.
CfnEndpoint.Builder	ibmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty ibmDb2Settings)	Settings in JSON format for the source IBM Db2 LUW endpoint.
CfnEndpoint.Builder	kafkaSettings(IResolvable kafkaSettings)	Settings in JSON format for the target Apache Kafka endpoint.
CfnEndpoint.Builder	kafkaSettings(CfnEndpoint.KafkaSettingsProperty kafkaSettings)	Settings in JSON format for the target Apache Kafka endpoint.
CfnEndpoint.Builder	kinesisSettings(IResolvable kinesisSettings)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
CfnEndpoint.Builder	kinesisSettings(CfnEndpoint.KinesisSettingsProperty kinesisSettings)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
CfnEndpoint.Builder	kmsKeyId(String kmsKeyId)	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
CfnEndpoint.Builder	microsoftSqlServerSettings(IResolvable microsoftSqlServerSettings)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
CfnEndpoint.Builder	microsoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty microsoftSqlServerSettings)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
CfnEndpoint.Builder	mongoDbSettings(IResolvable mongoDbSettings)	Settings in JSON format for the source MongoDB endpoint.
CfnEndpoint.Builder	mongoDbSettings(CfnEndpoint.MongoDbSettingsProperty mongoDbSettings)	Settings in JSON format for the source MongoDB endpoint.
CfnEndpoint.Builder	mySqlSettings(IResolvable mySqlSettings)	Settings in JSON format for the source and target MySQL endpoint.
CfnEndpoint.Builder	mySqlSettings(CfnEndpoint.MySqlSettingsProperty mySqlSettings)	Settings in JSON format for the source and target MySQL endpoint.
CfnEndpoint.Builder	neptuneSettings(IResolvable neptuneSettings)	Settings in JSON format for the target Amazon Neptune endpoint.
CfnEndpoint.Builder	neptuneSettings(CfnEndpoint.NeptuneSettingsProperty neptuneSettings)	Settings in JSON format for the target Amazon Neptune endpoint.
CfnEndpoint.Builder	oracleSettings(IResolvable oracleSettings)	Settings in JSON format for the source and target Oracle endpoint.
CfnEndpoint.Builder	oracleSettings(CfnEndpoint.OracleSettingsProperty oracleSettings)	Settings in JSON format for the source and target Oracle endpoint.
CfnEndpoint.Builder	password(String password)	The password to be used to log in to the endpoint database.
CfnEndpoint.Builder	port(Number port)	The port used by the endpoint database.
CfnEndpoint.Builder	postgreSqlSettings(IResolvable postgreSqlSettings)	Settings in JSON format for the source and target PostgreSQL endpoint.
CfnEndpoint.Builder	postgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty postgreSqlSettings)	Settings in JSON format for the source and target PostgreSQL endpoint.
CfnEndpoint.Builder	redisSettings(IResolvable redisSettings)	Settings in JSON format for the target Redis endpoint.
CfnEndpoint.Builder	redisSettings(CfnEndpoint.RedisSettingsProperty redisSettings)	Settings in JSON format for the target Redis endpoint.
CfnEndpoint.Builder	redshiftSettings(IResolvable redshiftSettings)	Settings in JSON format for the Amazon Redshift endpoint.
CfnEndpoint.Builder	redshiftSettings(CfnEndpoint.RedshiftSettingsProperty redshiftSettings)	Settings in JSON format for the Amazon Redshift endpoint.
CfnEndpoint.Builder	resourceIdentifier(String resourceIdentifier)	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
CfnEndpoint.Builder	s3Settings(IResolvable s3Settings)	Settings in JSON format for the source and target Amazon S3 endpoint.
CfnEndpoint.Builder	s3Settings(CfnEndpoint.S3SettingsProperty s3Settings)	Settings in JSON format for the source and target Amazon S3 endpoint.
CfnEndpoint.Builder	serverName(String serverName)	The name of the server where the endpoint database resides.
CfnEndpoint.Builder	sslMode(String sslMode)	The Secure Sockets Layer (SSL) mode to use for the SSL connection.
CfnEndpoint.Builder	sybaseSettings(IResolvable sybaseSettings)	Settings in JSON format for the source and target SAP ASE endpoint.
CfnEndpoint.Builder	sybaseSettings(CfnEndpoint.SybaseSettingsProperty sybaseSettings)	Settings in JSON format for the source and target SAP ASE endpoint.
CfnEndpoint.Builder	tags(List<? extends CfnTag> tags)	One or more tags to be assigned to the endpoint.
CfnEndpoint.Builder	username(String username)	The user name to be used to log in to the endpoint database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEndpoint.Builder create(Construct scope,
 String id)

Parameters:

scope -

• scope in which this resource is defined.

This parameter is required.

id -

• scoped id of the resource.

This parameter is required.

Returns:

a new instance of CfnEndpoint.Builder.

endpointType

@Stability(Stable)
public CfnEndpoint.Builder endpointType(String endpointType)

The type of endpoint.

Valid values are source and target .

Parameters:

endpointType - The type of endpoint. This parameter is required.

Returns:

this

engineName

@Stability(Stable)
public CfnEndpoint.Builder engineName(String engineName)

The type of engine for the endpoint, depending on the EndpointType value.

Valid values : mysql | oracle | postgres | mariadb | aurora | aurora-postgresql | opensearch | redshift | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune

Parameters:

engineName - The type of engine for the endpoint, depending on the EndpointType value. This parameter is required.

Returns:

this

certificateArn

@Stability(Stable)
public CfnEndpoint.Builder certificateArn(String certificateArn)

The Amazon Resource Name (ARN) for the certificate.

Parameters:

certificateArn - The Amazon Resource Name (ARN) for the certificate. This parameter is required.

Returns:

this

databaseName

@Stability(Stable)
public CfnEndpoint.Builder databaseName(String databaseName)

The name of the endpoint database.

For a MySQL source or target endpoint, don't specify DatabaseName . To migrate to a specific database, use this setting and targetDbType .

Parameters:

databaseName - The name of the endpoint database. This parameter is required.

Returns:

this

docDbSettings

@Stability(Stable)
public CfnEndpoint.Builder docDbSettings(CfnEndpoint.DocDbSettingsProperty docDbSettings)

Settings in JSON format for the source and target DocumentDB endpoint.

For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Parameters:

docDbSettings - Settings in JSON format for the source and target DocumentDB endpoint. This parameter is required.

Returns:

this

docDbSettings

@Stability(Stable)
public CfnEndpoint.Builder docDbSettings(IResolvable docDbSettings)

Settings in JSON format for the source and target DocumentDB endpoint.

For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Parameters:

docDbSettings - Settings in JSON format for the source and target DocumentDB endpoint. This parameter is required.

Returns:

this

dynamoDbSettings

@Stability(Stable)
public CfnEndpoint.Builder dynamoDbSettings(IResolvable 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 AWS Database Migration Service User Guide .

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. This parameter is required.

Returns:

this

dynamoDbSettings

@Stability(Stable)
public CfnEndpoint.Builder dynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty 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 AWS Database Migration Service User Guide .

Parameters:

dynamoDbSettings - Settings in JSON format for the target Amazon DynamoDB endpoint. This parameter is required.

Returns:

this

elasticsearchSettings

@Stability(Stable)
public CfnEndpoint.Builder elasticsearchSettings(IResolvable 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 AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. This parameter is required.

Returns:

this

elasticsearchSettings

@Stability(Stable)
public CfnEndpoint.Builder elasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty 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 AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

elasticsearchSettings - Settings in JSON format for the target OpenSearch endpoint. This parameter is required.

Returns:

this

endpointIdentifier

@Stability(Stable)
public CfnEndpoint.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. This parameter is required.

Returns:

this

extraConnectionAttributes

@Stability(Stable)
public CfnEndpoint.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 AWS DMS Endpoints in the AWS Database Migration Service User Guide .

Parameters:

extraConnectionAttributes - Additional attributes associated with the connection. This parameter is required.

Returns:

this

gcpMySqlSettings

@Stability(Stable)
public CfnEndpoint.Builder gcpMySqlSettings(IResolvable gcpMySqlSettings)

Settings in JSON format for the source GCP MySQL endpoint.

These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

gcpMySqlSettings - Settings in JSON format for the source GCP MySQL endpoint. This parameter is required.

Returns:

this

gcpMySqlSettings

@Stability(Stable)
public CfnEndpoint.Builder gcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty gcpMySqlSettings)

Settings in JSON format for the source GCP MySQL endpoint.

These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

gcpMySqlSettings - Settings in JSON format for the source GCP MySQL endpoint. This parameter is required.

Returns:

this

ibmDb2Settings

@Stability(Stable)
public CfnEndpoint.Builder ibmDb2Settings(IResolvable 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 AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

ibmDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint. This parameter is required.

Returns:

this

ibmDb2Settings

@Stability(Stable)
public CfnEndpoint.Builder ibmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty 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 AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

ibmDb2Settings - Settings in JSON format for the source IBM Db2 LUW endpoint. This parameter is required.

Returns:

this

kafkaSettings

@Stability(Stable)
public CfnEndpoint.Builder kafkaSettings(IResolvable kafkaSettings)

Settings in JSON format for the target Apache Kafka endpoint.

For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .

Parameters:

kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. This parameter is required.

Returns:

this

kafkaSettings

@Stability(Stable)
public CfnEndpoint.Builder kafkaSettings(CfnEndpoint.KafkaSettingsProperty kafkaSettings)

Settings in JSON format for the target Apache Kafka endpoint.

For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .

Parameters:

kafkaSettings - Settings in JSON format for the target Apache Kafka endpoint. This parameter is required.

Returns:

this

kinesisSettings

@Stability(Stable)
public CfnEndpoint.Builder kinesisSettings(IResolvable kinesisSettings)

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.

For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .

Parameters:

kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. This parameter is required.

Returns:

this

kinesisSettings

@Stability(Stable)
public CfnEndpoint.Builder kinesisSettings(CfnEndpoint.KinesisSettingsProperty kinesisSettings)

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.

For more information about other available settings, see Using object mapping to migrate data to a Kinesis data stream in the AWS Database Migration Service User Guide .

Parameters:

kinesisSettings - Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. This parameter is required.

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnEndpoint.Builder kmsKeyId(String kmsKeyId)

An AWS 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, AWS DMS uses 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 - An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. This parameter is required.

Returns:

this

microsoftSqlServerSettings

@Stability(Stable)
public CfnEndpoint.Builder microsoftSqlServerSettings(IResolvable 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 AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

microsoftSqlServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint. This parameter is required.

Returns:

this

microsoftSqlServerSettings

@Stability(Stable)
public CfnEndpoint.Builder microsoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty 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 AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

microsoftSqlServerSettings - Settings in JSON format for the source and target Microsoft SQL Server endpoint. This parameter is required.

Returns:

this

mongoDbSettings

@Stability(Stable)
public CfnEndpoint.Builder mongoDbSettings(IResolvable mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint.

For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. This parameter is required.

Returns:

this

mongoDbSettings

@Stability(Stable)
public CfnEndpoint.Builder mongoDbSettings(CfnEndpoint.MongoDbSettingsProperty mongoDbSettings)

Settings in JSON format for the source MongoDB endpoint.

For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Parameters:

mongoDbSettings - Settings in JSON format for the source MongoDB endpoint. This parameter is required.

Returns:

this

mySqlSettings

@Stability(Stable)
public CfnEndpoint.Builder mySqlSettings(IResolvable 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 AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

mySqlSettings - Settings in JSON format for the source and target MySQL endpoint. This parameter is required.

Returns:

this

mySqlSettings

@Stability(Stable)
public CfnEndpoint.Builder mySqlSettings(CfnEndpoint.MySqlSettingsProperty 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 AWS DMS and Extra connection attributes when using a MySQL-compatible database as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

mySqlSettings - Settings in JSON format for the source and target MySQL endpoint. This parameter is required.

Returns:

this

neptuneSettings

@Stability(Stable)
public CfnEndpoint.Builder neptuneSettings(IResolvable neptuneSettings)

Settings in JSON format for the target Amazon Neptune endpoint.

For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .

Parameters:

neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint. This parameter is required.

Returns:

this

neptuneSettings

@Stability(Stable)
public CfnEndpoint.Builder neptuneSettings(CfnEndpoint.NeptuneSettingsProperty neptuneSettings)

Settings in JSON format for the target Amazon Neptune endpoint.

For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .

Parameters:

neptuneSettings - Settings in JSON format for the target Amazon Neptune endpoint. This parameter is required.

Returns:

this

oracleSettings

@Stability(Stable)
public CfnEndpoint.Builder oracleSettings(IResolvable 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 AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

oracleSettings - Settings in JSON format for the source and target Oracle endpoint. This parameter is required.

Returns:

this

oracleSettings

@Stability(Stable)
public CfnEndpoint.Builder oracleSettings(CfnEndpoint.OracleSettingsProperty 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 AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

oracleSettings - Settings in JSON format for the source and target Oracle endpoint. This parameter is required.

Returns:

this

password

@Stability(Stable)
public CfnEndpoint.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. This parameter is required.

Returns:

this

port

@Stability(Stable)
public CfnEndpoint.Builder port(Number port)

The port used by the endpoint database.

Parameters:

port - The port used by the endpoint database. This parameter is required.

Returns:

this

postgreSqlSettings

@Stability(Stable)
public CfnEndpoint.Builder postgreSqlSettings(IResolvable 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 AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

postgreSqlSettings - Settings in JSON format for the source and target PostgreSQL endpoint. This parameter is required.

Returns:

this

postgreSqlSettings

@Stability(Stable)
public CfnEndpoint.Builder postgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty 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 AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

postgreSqlSettings - Settings in JSON format for the source and target PostgreSQL endpoint. This parameter is required.

Returns:

this

redisSettings

@Stability(Stable)
public CfnEndpoint.Builder redisSettings(IResolvable redisSettings)

Settings in JSON format for the target Redis endpoint.

For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

Parameters:

redisSettings - Settings in JSON format for the target Redis endpoint. This parameter is required.

Returns:

this

redisSettings

@Stability(Stable)
public CfnEndpoint.Builder redisSettings(CfnEndpoint.RedisSettingsProperty redisSettings)

Settings in JSON format for the target Redis endpoint.

For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

Parameters:

redisSettings - Settings in JSON format for the target Redis endpoint. This parameter is required.

Returns:

this

redshiftSettings

@Stability(Stable)
public CfnEndpoint.Builder redshiftSettings(IResolvable redshiftSettings)

Settings in JSON format for the Amazon Redshift endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

redshiftSettings - Settings in JSON format for the Amazon Redshift endpoint. This parameter is required.

Returns:

this

redshiftSettings

@Stability(Stable)
public CfnEndpoint.Builder redshiftSettings(CfnEndpoint.RedshiftSettingsProperty redshiftSettings)

Settings in JSON format for the Amazon Redshift endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

redshiftSettings - Settings in JSON format for the Amazon Redshift endpoint. This parameter is required.

Returns:

this

resourceIdentifier

@Stability(Stable)
public CfnEndpoint.Builder resourceIdentifier(String resourceIdentifier)

A display 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, AWS DMS generates a default identifier value for the end of EndpointArn .

Parameters:

resourceIdentifier - A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. This parameter is required.

Returns:

this

s3Settings

@Stability(Stable)
public CfnEndpoint.Builder s3Settings(IResolvable s3Settings)

Settings in JSON format for the source and target Amazon S3 endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

s3Settings - Settings in JSON format for the source and target Amazon S3 endpoint. This parameter is required.

Returns:

this

s3Settings

@Stability(Stable)
public CfnEndpoint.Builder s3Settings(CfnEndpoint.S3SettingsProperty s3Settings)

Settings in JSON format for the source and target Amazon S3 endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

s3Settings - Settings in JSON format for the source and target Amazon S3 endpoint. This parameter is required.

Returns:

this

serverName

@Stability(Stable)
public CfnEndpoint.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. This parameter is required.

Returns:

this

sslMode

@Stability(Stable)
public CfnEndpoint.Builder sslMode(String sslMode)

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

When engine_name is set to S3, the only allowed value is none .

Parameters:

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

Returns:

this

sybaseSettings

@Stability(Stable)
public CfnEndpoint.Builder sybaseSettings(IResolvable 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 AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. This parameter is required.

Returns:

this

sybaseSettings

@Stability(Stable)
public CfnEndpoint.Builder sybaseSettings(CfnEndpoint.SybaseSettingsProperty 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 AWS DMS and Extra connection attributes when using SAP ASE as a target for AWS DMS in the AWS Database Migration Service User Guide .

Parameters:

sybaseSettings - Settings in JSON format for the source and target SAP ASE endpoint. This parameter is required.

Returns:

this

tags

@Stability(Stable)
public CfnEndpoint.Builder tags(List<? extends CfnTag> tags)

One or more tags to be assigned to the endpoint.

Parameters:

tags - One or more tags to be assigned to the endpoint. This parameter is required.

Returns:

this

username

@Stability(Stable)
public CfnEndpoint.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. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CfnEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint>

Returns:

a newly built instance of CfnEndpoint.