Package software.amazon.awscdk.cfnpropertymixins.services.dms

Class CfnEndpointPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpointPropsMixin>

Enclosing class:

CfnEndpointPropsMixin

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

A fluent builder for CfnEndpointPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnEndpointPropsMixin.Builder.

create

@Stability(Stable)
public static CfnEndpointPropsMixin.Builder create()

Returns:

a new instance of CfnEndpointPropsMixin.Builder.

certificateArn

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-certificatearn

databaseName

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-databasename

docDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings

docDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder docDbSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-docdbsettings

dynamoDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings

dynamoDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder dynamoDbSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-dynamodbsettings

elasticsearchSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings

elasticsearchSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder elasticsearchSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-elasticsearchsettings

endpointIdentifier

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointidentifier

endpointType

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-endpointtype

engineName

@Stability(Stable)
public CfnEndpointPropsMixin.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 | redshift-serverless | 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-enginename

extraConnectionAttributes

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-extraconnectionattributes

gcpMySqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-gcpmysqlsettings

gcpMySqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder gcpMySqlSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-gcpmysqlsettings

ibmDb2Settings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings

ibmDb2Settings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder ibmDb2Settings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-ibmdb2settings

kafkaSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings

kafkaSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder kafkaSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kafkasettings

kinesisSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings

kinesisSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder kinesisSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kinesissettings

kmsKeyId

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

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-kmskeyid

microsoftSqlServerSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings

microsoftSqlServerSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder microsoftSqlServerSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-microsoftsqlserversettings

mongoDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings

mongoDbSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder mongoDbSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mongodbsettings

mySqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings

mySqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder mySqlSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-mysqlsettings

neptuneSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings

neptuneSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder neptuneSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-neptunesettings

oracleSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings

oracleSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder oracleSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-oraclesettings

password

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-password

port

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-port

postgreSqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings

postgreSqlSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder postgreSqlSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-postgresqlsettings

redisSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redissettings

redisSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder redisSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redissettings

redshiftSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings

redshiftSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder redshiftSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-redshiftsettings

resourceIdentifier

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-resourceidentifier

s3Settings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings

s3Settings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder s3Settings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-s3settings

serverName

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-servername

sslMode

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sslmode

sybaseSettings

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings

sybaseSettings

@Stability(Stable)
public CfnEndpointPropsMixin.Builder sybaseSettings(CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-sybasesettings

tags

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-tags

username

@Stability(Stable)
public CfnEndpointPropsMixin.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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-endpoint.html#cfn-dms-endpoint-username

build

@Stability(Stable)
public CfnEndpointPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnEndpointPropsMixin.