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

Class CfnEndpointPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

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

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:58.172Z")
@Stability(Stable)
public class CfnEndpointPropsMixin
extends Mixin
implements software.constructs.IMixin

The AWS::DMS::Endpoint resource specifies an AWS DMS endpoint.

Currently, AWS CloudFormation supports all AWS DMS endpoint types.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.dms.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnEndpointPropsMixin cfnEndpointPropsMixin = CfnEndpointPropsMixin.Builder.create(CfnEndpointMixinProps.builder()
         .certificateArn("certificateArn")
         .databaseName("databaseName")
         .docDbSettings(DocDbSettingsProperty.builder()
                 .docsToInvestigate(123)
                 .extractDocId(false)
                 .nestingLevel("nestingLevel")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .dynamoDbSettings(DynamoDbSettingsProperty.builder()
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .build())
         .elasticsearchSettings(ElasticsearchSettingsProperty.builder()
                 .endpointUri("endpointUri")
                 .errorRetryDuration(123)
                 .fullLoadErrorPercentage(123)
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .build())
         .endpointIdentifier("endpointIdentifier")
         .endpointType("endpointType")
         .engineName("engineName")
         .extraConnectionAttributes("extraConnectionAttributes")
         .gcpMySqlSettings(GcpMySQLSettingsProperty.builder()
                 .afterConnectScript("afterConnectScript")
                 .cleanSourceMetadataOnMismatch(false)
                 .databaseName("databaseName")
                 .eventsPollInterval(123)
                 .maxFileSize(123)
                 .parallelLoadThreads(123)
                 .password("password")
                 .port(123)
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .serverName("serverName")
                 .serverTimezone("serverTimezone")
                 .username("username")
                 .build())
         .ibmDb2Settings(IbmDb2SettingsProperty.builder()
                 .currentLsn("currentLsn")
                 .keepCsvFiles(false)
                 .loadTimeout(123)
                 .maxFileSize(123)
                 .maxKBytesPerRead(123)
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .setDataCaptureChanges(false)
                 .writeBufferSize(123)
                 .build())
         .kafkaSettings(KafkaSettingsProperty.builder()
                 .broker("broker")
                 .includeControlDetails(false)
                 .includeNullAndEmpty(false)
                 .includePartitionValue(false)
                 .includeTableAlterOperations(false)
                 .includeTransactionDetails(false)
                 .messageFormat("messageFormat")
                 .messageMaxBytes(123)
                 .noHexPrefix(false)
                 .partitionIncludeSchemaTable(false)
                 .saslPassword("saslPassword")
                 .saslUserName("saslUserName")
                 .securityProtocol("securityProtocol")
                 .sslCaCertificateArn("sslCaCertificateArn")
                 .sslClientCertificateArn("sslClientCertificateArn")
                 .sslClientKeyArn("sslClientKeyArn")
                 .sslClientKeyPassword("sslClientKeyPassword")
                 .topic("topic")
                 .build())
         .kinesisSettings(KinesisSettingsProperty.builder()
                 .includeControlDetails(false)
                 .includeNullAndEmpty(false)
                 .includePartitionValue(false)
                 .includeTableAlterOperations(false)
                 .includeTransactionDetails(false)
                 .messageFormat("messageFormat")
                 .noHexPrefix(false)
                 .partitionIncludeSchemaTable(false)
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .streamArn("streamArn")
                 .build())
         .kmsKeyId("kmsKeyId")
         .microsoftSqlServerSettings(MicrosoftSqlServerSettingsProperty.builder()
                 .bcpPacketSize(123)
                 .controlTablesFileGroup("controlTablesFileGroup")
                 .databaseName("databaseName")
                 .forceLobLookup(false)
                 .password("password")
                 .port(123)
                 .querySingleAlwaysOnNode(false)
                 .readBackupOnly(false)
                 .safeguardPolicy("safeguardPolicy")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .serverName("serverName")
                 .tlogAccessMode("tlogAccessMode")
                 .trimSpaceInChar(false)
                 .useBcpFullLoad(false)
                 .username("username")
                 .useThirdPartyBackupDevice(false)
                 .build())
         .mongoDbSettings(MongoDbSettingsProperty.builder()
                 .authMechanism("authMechanism")
                 .authSource("authSource")
                 .authType("authType")
                 .databaseName("databaseName")
                 .docsToInvestigate("docsToInvestigate")
                 .extractDocId("extractDocId")
                 .nestingLevel("nestingLevel")
                 .password("password")
                 .port(123)
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .serverName("serverName")
                 .username("username")
                 .build())
         .mySqlSettings(MySqlSettingsProperty.builder()
                 .afterConnectScript("afterConnectScript")
                 .cleanSourceMetadataOnMismatch(false)
                 .eventsPollInterval(123)
                 .maxFileSize(123)
                 .parallelLoadThreads(123)
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .serverTimezone("serverTimezone")
                 .targetDbType("targetDbType")
                 .build())
         .neptuneSettings(NeptuneSettingsProperty.builder()
                 .errorRetryDuration(123)
                 .iamAuthEnabled(false)
                 .maxFileSize(123)
                 .maxRetryCount(123)
                 .s3BucketFolder("s3BucketFolder")
                 .s3BucketName("s3BucketName")
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .build())
         .oracleSettings(OracleSettingsProperty.builder()
                 .accessAlternateDirectly(false)
                 .additionalArchivedLogDestId(123)
                 .addSupplementalLogging(false)
                 .allowSelectNestedTables(false)
                 .archivedLogDestId(123)
                 .archivedLogsOnly(false)
                 .asmPassword("asmPassword")
                 .asmServer("asmServer")
                 .asmUser("asmUser")
                 .charLengthSemantics("charLengthSemantics")
                 .directPathNoLog(false)
                 .directPathParallelLoad(false)
                 .enableHomogenousTablespace(false)
                 .extraArchivedLogDestIds(List.of(123))
                 .failTasksOnLobTruncation(false)
                 .numberDatatypeScale(123)
                 .oraclePathPrefix("oraclePathPrefix")
                 .parallelAsmReadThreads(123)
                 .readAheadBlocks(123)
                 .readTableSpaceName(false)
                 .replacePathPrefix(false)
                 .retryInterval(123)
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerOracleAsmAccessRoleArn("secretsManagerOracleAsmAccessRoleArn")
                 .secretsManagerOracleAsmSecretId("secretsManagerOracleAsmSecretId")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .securityDbEncryption("securityDbEncryption")
                 .securityDbEncryptionName("securityDbEncryptionName")
                 .spatialDataOptionToGeoJsonFunctionName("spatialDataOptionToGeoJsonFunctionName")
                 .standbyDelayTime(123)
                 .useAlternateFolderForOnline(false)
                 .useBFile(false)
                 .useDirectPathFullLoad(false)
                 .useLogminerReader(false)
                 .usePathPrefix("usePathPrefix")
                 .build())
         .password("password")
         .port(123)
         .postgreSqlSettings(PostgreSqlSettingsProperty.builder()
                 .afterConnectScript("afterConnectScript")
                 .babelfishDatabaseName("babelfishDatabaseName")
                 .captureDdls(false)
                 .databaseMode("databaseMode")
                 .ddlArtifactsSchema("ddlArtifactsSchema")
                 .executeTimeout(123)
                 .failTasksOnLobTruncation(false)
                 .heartbeatEnable(false)
                 .heartbeatFrequency(123)
                 .heartbeatSchema("heartbeatSchema")
                 .mapBooleanAsBoolean(false)
                 .maxFileSize(123)
                 .pluginName("pluginName")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .slotName("slotName")
                 .build())
         .redisSettings(RedisSettingsProperty.builder()
                 .authPassword("authPassword")
                 .authType("authType")
                 .authUserName("authUserName")
                 .port(123)
                 .serverName("serverName")
                 .sslCaCertificateArn("sslCaCertificateArn")
                 .sslSecurityProtocol("sslSecurityProtocol")
                 .build())
         .redshiftSettings(RedshiftSettingsProperty.builder()
                 .acceptAnyDate(false)
                 .afterConnectScript("afterConnectScript")
                 .bucketFolder("bucketFolder")
                 .bucketName("bucketName")
                 .caseSensitiveNames(false)
                 .compUpdate(false)
                 .connectionTimeout(123)
                 .dateFormat("dateFormat")
                 .emptyAsNull(false)
                 .encryptionMode("encryptionMode")
                 .explicitIds(false)
                 .fileTransferUploadStreams(123)
                 .loadTimeout(123)
                 .mapBooleanAsBoolean(false)
                 .maxFileSize(123)
                 .removeQuotes(false)
                 .replaceChars("replaceChars")
                 .replaceInvalidChars("replaceInvalidChars")
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .serverSideEncryptionKmsKeyId("serverSideEncryptionKmsKeyId")
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .timeFormat("timeFormat")
                 .trimBlanks(false)
                 .truncateColumns(false)
                 .writeBufferSize(123)
                 .build())
         .resourceIdentifier("resourceIdentifier")
         .s3Settings(S3SettingsProperty.builder()
                 .addColumnName(false)
                 .addTrailingPaddingCharacter(false)
                 .bucketFolder("bucketFolder")
                 .bucketName("bucketName")
                 .cannedAclForObjects("cannedAclForObjects")
                 .cdcInsertsAndUpdates(false)
                 .cdcInsertsOnly(false)
                 .cdcMaxBatchInterval(123)
                 .cdcMinFileSize(123)
                 .cdcPath("cdcPath")
                 .compressionType("compressionType")
                 .csvDelimiter("csvDelimiter")
                 .csvNoSupValue("csvNoSupValue")
                 .csvNullValue("csvNullValue")
                 .csvRowDelimiter("csvRowDelimiter")
                 .dataFormat("dataFormat")
                 .dataPageSize(123)
                 .datePartitionDelimiter("datePartitionDelimiter")
                 .datePartitionEnabled(false)
                 .datePartitionSequence("datePartitionSequence")
                 .datePartitionTimezone("datePartitionTimezone")
                 .dictPageSizeLimit(123)
                 .enableStatistics(false)
                 .encodingType("encodingType")
                 .encryptionMode("encryptionMode")
                 .expectedBucketOwner("expectedBucketOwner")
                 .externalTableDefinition("externalTableDefinition")
                 .glueCatalogGeneration(false)
                 .ignoreHeaderRows(123)
                 .includeOpForFullLoad(false)
                 .maxFileSize(123)
                 .parquetTimestampInMillisecond(false)
                 .parquetVersion("parquetVersion")
                 .preserveTransactions(false)
                 .rfc4180(false)
                 .rowGroupLength(123)
                 .serverSideEncryptionKmsKeyId("serverSideEncryptionKmsKeyId")
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .timestampColumnName("timestampColumnName")
                 .useCsvNoSupValue(false)
                 .useTaskStartTimeForFullLoadTimestamp(false)
                 .build())
         .serverName("serverName")
         .sslMode("sslMode")
         .sybaseSettings(SybaseSettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .username("username")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEndpointPropsMixin.Builder	A fluent builder for CfnEndpointPropsMixin.
static interface	CfnEndpointPropsMixin.DocDbSettingsProperty	Provides information that defines a DocumentDB endpoint.
static interface	CfnEndpointPropsMixin.DynamoDbSettingsProperty	Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint.
static interface	CfnEndpointPropsMixin.ElasticsearchSettingsProperty	Provides information that defines an OpenSearch endpoint.
static interface	CfnEndpointPropsMixin.GcpMySQLSettingsProperty	Provides information that defines a GCP MySQL endpoint.
static interface	CfnEndpointPropsMixin.IbmDb2SettingsProperty	Provides information that defines an IBMDB2 endpoint.
static interface	CfnEndpointPropsMixin.KafkaSettingsProperty	Provides information that describes an Apache Kafka endpoint.
static interface	CfnEndpointPropsMixin.KinesisSettingsProperty	Provides information that describes an Amazon Kinesis Data Stream endpoint.
static interface	CfnEndpointPropsMixin.MicrosoftSqlServerSettingsProperty	Provides information that defines a Microsoft SQL Server endpoint.
static interface	CfnEndpointPropsMixin.MongoDbSettingsProperty	Provides information that defines a MongoDB endpoint.
static interface	CfnEndpointPropsMixin.MySqlSettingsProperty	Provides information that defines a MySQL endpoint.
static interface	CfnEndpointPropsMixin.NeptuneSettingsProperty	Provides information that defines an Amazon Neptune endpoint.
static interface	CfnEndpointPropsMixin.OracleSettingsProperty	Provides information that defines an Oracle endpoint.
static interface	CfnEndpointPropsMixin.PostgreSqlSettingsProperty	Provides information that defines a PostgreSQL endpoint.
static interface	CfnEndpointPropsMixin.RedisSettingsProperty	Provides information that defines a Redis target endpoint.
static interface	CfnEndpointPropsMixin.RedshiftSettingsProperty	Provides information that defines an Amazon Redshift endpoint.
static interface	CfnEndpointPropsMixin.S3SettingsProperty	Provides information that defines an Amazon S3 endpoint.
static interface	CfnEndpointPropsMixin.SybaseSettingsProperty	Provides information that defines a SAP ASE endpoint.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnEndpointPropsMixin(CfnEndpointMixinProps props)	Create a mixin to apply properties to AWS::DMS::Endpoint.
	CfnEndpointPropsMixin(CfnEndpointMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::DMS::Endpoint.
protected	CfnEndpointPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnEndpointMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnEndpointPropsMixin

protected CfnEndpointPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnEndpointPropsMixin

protected CfnEndpointPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEndpointPropsMixin

@Stability(Stable)
public CfnEndpointPropsMixin(@NotNull
 CfnEndpointMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::DMS::Endpoint.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnEndpointPropsMixin

@Stability(Stable)
public CfnEndpointPropsMixin(@NotNull
 CfnEndpointMixinProps props)

Create a mixin to apply properties to AWS::DMS::Endpoint.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnEndpointMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()