Package software.amazon.awscdk.services.dms

Class CfnEndpoint

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.dms.CfnEndpoint

All Implemented Interfaces:

IInspectable, IEndpointRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:02.457Z")
@Stability(Stable)
public class CfnEndpoint
extends CfnResource
implements IInspectable, IEndpointRef, ITaggable

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.services.dms.*;
 CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
         .endpointType("endpointType")
         .engineName("engineName")
         // the properties below are optional
         .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")
         .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();
 

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	CfnEndpoint.Builder	A fluent builder for CfnEndpoint.
static interface	CfnEndpoint.DocDbSettingsProperty	Provides information that defines a DocumentDB endpoint.
static interface	CfnEndpoint.DynamoDbSettingsProperty	Provides information, including the Amazon Resource Name (ARN) of the IAM role used to define an Amazon DynamoDB target endpoint.
static interface	CfnEndpoint.ElasticsearchSettingsProperty	Provides information that defines an OpenSearch endpoint.
static interface	CfnEndpoint.GcpMySQLSettingsProperty	Provides information that defines a GCP MySQL endpoint.
static interface	CfnEndpoint.IbmDb2SettingsProperty	Provides information that defines an IBMDB2 endpoint.
static interface	CfnEndpoint.KafkaSettingsProperty	Provides information that describes an Apache Kafka endpoint.
static interface	CfnEndpoint.KinesisSettingsProperty	Provides information that describes an Amazon Kinesis Data Stream endpoint.
static interface	CfnEndpoint.MicrosoftSqlServerSettingsProperty	Provides information that defines a Microsoft SQL Server endpoint.
static interface	CfnEndpoint.MongoDbSettingsProperty	Provides information that defines a MongoDB endpoint.
static interface	CfnEndpoint.MySqlSettingsProperty	Provides information that defines a MySQL endpoint.
static interface	CfnEndpoint.NeptuneSettingsProperty	Provides information that defines an Amazon Neptune endpoint.
static interface	CfnEndpoint.OracleSettingsProperty	Provides information that defines an Oracle endpoint.
static interface	CfnEndpoint.PostgreSqlSettingsProperty	Provides information that defines a PostgreSQL endpoint.
static interface	CfnEndpoint.RedisSettingsProperty	Provides information that defines a Redis target endpoint.
static interface	CfnEndpoint.RedshiftSettingsProperty	Provides information that defines an Amazon Redshift endpoint.
static interface	CfnEndpoint.S3SettingsProperty	Provides information that defines an Amazon S3 endpoint.
static interface	CfnEndpoint.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.dms.IEndpointRef

IEndpointRef.Jsii$Default, IEndpointRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEndpoint(software.constructs.Construct scope, String id, CfnEndpointProps props)	Create a new AWS::DMS::Endpoint.

Method Summary

Modifier and Type	Method	Description
static IEndpointRef	fromEndpointId(software.constructs.Construct scope, String id, String endpointId)	Creates a new IEndpointRef from a endpointId.
String	getAttrExternalId()	A value that can be used for cross-account validation.
String	getAttrId()
String	getCertificateArn()	The Amazon Resource Name (ARN) for the certificate.
protected Map<String,Object>	getCfnProperties()
String	getDatabaseName()	The name of the endpoint database.
Object	getDocDbSettings()	Settings in JSON format for the source and target DocumentDB endpoint.
Object	getDynamoDbSettings()	Settings in JSON format for the target Amazon DynamoDB endpoint.
Object	getElasticsearchSettings()	Settings in JSON format for the target OpenSearch endpoint.
String	getEndpointIdentifier()	The database endpoint identifier.
EndpointReference	getEndpointRef()	A reference to a Endpoint resource.
String	getEndpointType()	The type of endpoint.
String	getEngineName()	The type of engine for the endpoint, depending on the EndpointType value.
String	getExtraConnectionAttributes()	Additional attributes associated with the connection.
Object	getGcpMySqlSettings()	Settings in JSON format for the source GCP MySQL endpoint.
Object	getIbmDb2Settings()	Settings in JSON format for the source IBM Db2 LUW endpoint.
Object	getKafkaSettings()	Settings in JSON format for the target Apache Kafka endpoint.
Object	getKinesisSettings()	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
String	getKmsKeyId()	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
Object	getMicrosoftSqlServerSettings()	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
Object	getMongoDbSettings()	Settings in JSON format for the source MongoDB endpoint.
Object	getMySqlSettings()	Settings in JSON format for the source and target MySQL endpoint.
Object	getNeptuneSettings()	Settings in JSON format for the target Amazon Neptune endpoint.
Object	getOracleSettings()	Settings in JSON format for the source and target Oracle endpoint.
String	getPassword()	The password to be used to log in to the endpoint database.
Number	getPort()	The port used by the endpoint database.
Object	getPostgreSqlSettings()	Settings in JSON format for the source and target PostgreSQL endpoint.
Object	getRedisSettings()	Settings in JSON format for the target Redis endpoint.
Object	getRedshiftSettings()	Settings in JSON format for the Amazon Redshift endpoint.
String	getResourceIdentifier()	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
Object	getS3Settings()	Settings in JSON format for the source and target Amazon S3 endpoint.
String	getServerName()	The name of the server where the endpoint database resides.
String	getSslMode()	The Secure Sockets Layer (SSL) mode to use for the SSL connection.
Object	getSybaseSettings()	Settings in JSON format for the source and target SAP ASE endpoint.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	One or more tags to be assigned to the endpoint.
String	getUsername()	The user name to be used to log in to the endpoint database.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateArn(String value)	The Amazon Resource Name (ARN) for the certificate.
void	setDatabaseName(String value)	The name of the endpoint database.
void	setDocDbSettings(IResolvable value)	Settings in JSON format for the source and target DocumentDB endpoint.
void	setDocDbSettings(CfnEndpoint.DocDbSettingsProperty value)	Settings in JSON format for the source and target DocumentDB endpoint.
void	setDynamoDbSettings(IResolvable value)	Settings in JSON format for the target Amazon DynamoDB endpoint.
void	setDynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty value)	Settings in JSON format for the target Amazon DynamoDB endpoint.
void	setElasticsearchSettings(IResolvable value)	Settings in JSON format for the target OpenSearch endpoint.
void	setElasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty value)	Settings in JSON format for the target OpenSearch endpoint.
void	setEndpointIdentifier(String value)	The database endpoint identifier.
void	setEndpointType(String value)	The type of endpoint.
void	setEngineName(String value)	The type of engine for the endpoint, depending on the EndpointType value.
void	setExtraConnectionAttributes(String value)	Additional attributes associated with the connection.
void	setGcpMySqlSettings(IResolvable value)	Settings in JSON format for the source GCP MySQL endpoint.
void	setGcpMySqlSettings(CfnEndpoint.GcpMySQLSettingsProperty value)	Settings in JSON format for the source GCP MySQL endpoint.
void	setIbmDb2Settings(IResolvable value)	Settings in JSON format for the source IBM Db2 LUW endpoint.
void	setIbmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty value)	Settings in JSON format for the source IBM Db2 LUW endpoint.
void	setKafkaSettings(IResolvable value)	Settings in JSON format for the target Apache Kafka endpoint.
void	setKafkaSettings(CfnEndpoint.KafkaSettingsProperty value)	Settings in JSON format for the target Apache Kafka endpoint.
void	setKinesisSettings(IResolvable value)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
void	setKinesisSettings(CfnEndpoint.KinesisSettingsProperty value)	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
void	setKmsKeyId(String value)	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
void	setMicrosoftSqlServerSettings(IResolvable value)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
void	setMicrosoftSqlServerSettings(CfnEndpoint.MicrosoftSqlServerSettingsProperty value)	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
void	setMongoDbSettings(IResolvable value)	Settings in JSON format for the source MongoDB endpoint.
void	setMongoDbSettings(CfnEndpoint.MongoDbSettingsProperty value)	Settings in JSON format for the source MongoDB endpoint.
void	setMySqlSettings(IResolvable value)	Settings in JSON format for the source and target MySQL endpoint.
void	setMySqlSettings(CfnEndpoint.MySqlSettingsProperty value)	Settings in JSON format for the source and target MySQL endpoint.
void	setNeptuneSettings(IResolvable value)	Settings in JSON format for the target Amazon Neptune endpoint.
void	setNeptuneSettings(CfnEndpoint.NeptuneSettingsProperty value)	Settings in JSON format for the target Amazon Neptune endpoint.
void	setOracleSettings(IResolvable value)	Settings in JSON format for the source and target Oracle endpoint.
void	setOracleSettings(CfnEndpoint.OracleSettingsProperty value)	Settings in JSON format for the source and target Oracle endpoint.
void	setPassword(String value)	The password to be used to log in to the endpoint database.
void	setPort(Number value)	The port used by the endpoint database.
void	setPostgreSqlSettings(IResolvable value)	Settings in JSON format for the source and target PostgreSQL endpoint.
void	setPostgreSqlSettings(CfnEndpoint.PostgreSqlSettingsProperty value)	Settings in JSON format for the source and target PostgreSQL endpoint.
void	setRedisSettings(IResolvable value)	Settings in JSON format for the target Redis endpoint.
void	setRedisSettings(CfnEndpoint.RedisSettingsProperty value)	Settings in JSON format for the target Redis endpoint.
void	setRedshiftSettings(IResolvable value)	Settings in JSON format for the Amazon Redshift endpoint.
void	setRedshiftSettings(CfnEndpoint.RedshiftSettingsProperty value)	Settings in JSON format for the Amazon Redshift endpoint.
void	setResourceIdentifier(String value)	A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.
void	setS3Settings(IResolvable value)	Settings in JSON format for the source and target Amazon S3 endpoint.
void	setS3Settings(CfnEndpoint.S3SettingsProperty value)	Settings in JSON format for the source and target Amazon S3 endpoint.
void	setServerName(String value)	The name of the server where the endpoint database resides.
void	setSslMode(String value)	The Secure Sockets Layer (SSL) mode to use for the SSL connection.
void	setSybaseSettings(IResolvable value)	Settings in JSON format for the source and target SAP ASE endpoint.
void	setSybaseSettings(CfnEndpoint.SybaseSettingsProperty value)	Settings in JSON format for the source and target SAP ASE endpoint.
void	setTagsRaw(List<CfnTag> value)	One or more tags to be assigned to the endpoint.
void	setUsername(String value)	The user name to be used to log in to the endpoint database.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnEndpoint

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

CfnEndpoint

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

CfnEndpoint

@Stability(Stable)
public CfnEndpoint(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEndpointProps props)

Create a new AWS::DMS::Endpoint.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

fromEndpointId

@Stability(Stable)
@NotNull
public static IEndpointRef fromEndpointId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String endpointId)

Creates a new IEndpointRef from a endpointId.

Parameters:

scope - This parameter is required.

id - This parameter is required.

endpointId - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrExternalId

@Stability(Stable)
@NotNull
public String getAttrExternalId()

A value that can be used for cross-account validation.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getEndpointRef

@Stability(Stable)
@NotNull
public EndpointReference getEndpointRef()

A reference to a Endpoint resource.

Specified by:

getEndpointRef in interface IEndpointRef

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getEndpointType

@Stability(Stable)
@NotNull
public String getEndpointType()

The type of endpoint.

setEndpointType

@Stability(Stable)
public void setEndpointType(@NotNull
 String value)

The type of endpoint.

getEngineName

@Stability(Stable)
@NotNull
public String getEngineName()

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

setEngineName

@Stability(Stable)
public void setEngineName(@NotNull
 String value)

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

getCertificateArn

@Stability(Stable)
@Nullable
public String getCertificateArn()

The Amazon Resource Name (ARN) for the certificate.

setCertificateArn

@Stability(Stable)
public void setCertificateArn(@Nullable
 String value)

The Amazon Resource Name (ARN) for the certificate.

getDatabaseName

@Stability(Stable)
@Nullable
public String getDatabaseName()

The name of the endpoint database.

setDatabaseName

@Stability(Stable)
public void setDatabaseName(@Nullable
 String value)

The name of the endpoint database.

getDocDbSettings

@Stability(Stable)
@Nullable
public Object getDocDbSettings()

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

Returns union: either IResolvable or CfnEndpoint.DocDbSettingsProperty

setDocDbSettings

@Stability(Stable)
public void setDocDbSettings(@Nullable
 IResolvable value)

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

setDocDbSettings

@Stability(Stable)
public void setDocDbSettings(@Nullable
 CfnEndpoint.DocDbSettingsProperty value)

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

getDynamoDbSettings

@Stability(Stable)
@Nullable
public Object getDynamoDbSettings()

Settings in JSON format for the target Amazon DynamoDB endpoint.

Returns union: either IResolvable or CfnEndpoint.DynamoDbSettingsProperty

setDynamoDbSettings

@Stability(Stable)
public void setDynamoDbSettings(@Nullable
 IResolvable value)

Settings in JSON format for the target Amazon DynamoDB endpoint.

setDynamoDbSettings

@Stability(Stable)
public void setDynamoDbSettings(@Nullable
 CfnEndpoint.DynamoDbSettingsProperty value)

Settings in JSON format for the target Amazon DynamoDB endpoint.

getElasticsearchSettings

@Stability(Stable)
@Nullable
public Object getElasticsearchSettings()

Settings in JSON format for the target OpenSearch endpoint.

Returns union: either IResolvable or CfnEndpoint.ElasticsearchSettingsProperty

setElasticsearchSettings

@Stability(Stable)
public void setElasticsearchSettings(@Nullable
 IResolvable value)

Settings in JSON format for the target OpenSearch endpoint.

setElasticsearchSettings

@Stability(Stable)
public void setElasticsearchSettings(@Nullable
 CfnEndpoint.ElasticsearchSettingsProperty value)

Settings in JSON format for the target OpenSearch endpoint.

getEndpointIdentifier

@Stability(Stable)
@Nullable
public String getEndpointIdentifier()

The database endpoint identifier.

setEndpointIdentifier

@Stability(Stable)
public void setEndpointIdentifier(@Nullable
 String value)

The database endpoint identifier.

getExtraConnectionAttributes

@Stability(Stable)
@Nullable
public String getExtraConnectionAttributes()

Additional attributes associated with the connection.

setExtraConnectionAttributes

@Stability(Stable)
public void setExtraConnectionAttributes(@Nullable
 String value)

Additional attributes associated with the connection.

getGcpMySqlSettings

@Stability(Stable)
@Nullable
public Object getGcpMySqlSettings()

Settings in JSON format for the source GCP MySQL endpoint.

Returns union: either IResolvable or CfnEndpoint.GcpMySQLSettingsProperty

setGcpMySqlSettings

@Stability(Stable)
public void setGcpMySqlSettings(@Nullable
 IResolvable value)

Settings in JSON format for the source GCP MySQL endpoint.

setGcpMySqlSettings

@Stability(Stable)
public void setGcpMySqlSettings(@Nullable
 CfnEndpoint.GcpMySQLSettingsProperty value)

Settings in JSON format for the source GCP MySQL endpoint.

getIbmDb2Settings

@Stability(Stable)
@Nullable
public Object getIbmDb2Settings()

Settings in JSON format for the source IBM Db2 LUW endpoint.

Returns union: either IResolvable or CfnEndpoint.IbmDb2SettingsProperty

setIbmDb2Settings

@Stability(Stable)
public void setIbmDb2Settings(@Nullable
 IResolvable value)

Settings in JSON format for the source IBM Db2 LUW endpoint.

setIbmDb2Settings

@Stability(Stable)
public void setIbmDb2Settings(@Nullable
 CfnEndpoint.IbmDb2SettingsProperty value)

Settings in JSON format for the source IBM Db2 LUW endpoint.

getKafkaSettings

@Stability(Stable)
@Nullable
public Object getKafkaSettings()

Settings in JSON format for the target Apache Kafka endpoint.

Returns union: either IResolvable or CfnEndpoint.KafkaSettingsProperty

setKafkaSettings

@Stability(Stable)
public void setKafkaSettings(@Nullable
 IResolvable value)

Settings in JSON format for the target Apache Kafka endpoint.

setKafkaSettings

@Stability(Stable)
public void setKafkaSettings(@Nullable
 CfnEndpoint.KafkaSettingsProperty value)

Settings in JSON format for the target Apache Kafka endpoint.

getKinesisSettings

@Stability(Stable)
@Nullable
public Object getKinesisSettings()

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

Returns union: either IResolvable or CfnEndpoint.KinesisSettingsProperty

setKinesisSettings

@Stability(Stable)
public void setKinesisSettings(@Nullable
 IResolvable value)

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

setKinesisSettings

@Stability(Stable)
public void setKinesisSettings(@Nullable
 CfnEndpoint.KinesisSettingsProperty value)

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

getKmsKeyId

@Stability(Stable)
@Nullable
public String getKmsKeyId()

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

setKmsKeyId

@Stability(Stable)
public void setKmsKeyId(@Nullable
 String value)

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

getMicrosoftSqlServerSettings

@Stability(Stable)
@Nullable
public Object getMicrosoftSqlServerSettings()

Settings in JSON format for the source and target Microsoft SQL Server endpoint.

Returns union: either IResolvable or CfnEndpoint.MicrosoftSqlServerSettingsProperty

setMicrosoftSqlServerSettings

@Stability(Stable)
public void setMicrosoftSqlServerSettings(@Nullable
 IResolvable value)

Settings in JSON format for the source and target Microsoft SQL Server endpoint.

setMicrosoftSqlServerSettings

@Stability(Stable)
public void setMicrosoftSqlServerSettings(@Nullable
 CfnEndpoint.MicrosoftSqlServerSettingsProperty value)

Settings in JSON format for the source and target Microsoft SQL Server endpoint.

getMongoDbSettings

@Stability(Stable)
@Nullable
public Object getMongoDbSettings()

Settings in JSON format for the source MongoDB endpoint.

Returns union: either IResolvable or CfnEndpoint.MongoDbSettingsProperty

setMongoDbSettings

@Stability(Stable)
public void setMongoDbSettings(@Nullable
 IResolvable value)

Settings in JSON format for the source MongoDB endpoint.

setMongoDbSettings

@Stability(Stable)
public void setMongoDbSettings(@Nullable
 CfnEndpoint.MongoDbSettingsProperty value)

Settings in JSON format for the source MongoDB endpoint.

getMySqlSettings

@Stability(Stable)
@Nullable
public Object getMySqlSettings()

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

Returns union: either IResolvable or CfnEndpoint.MySqlSettingsProperty

setMySqlSettings

@Stability(Stable)
public void setMySqlSettings(@Nullable
 IResolvable value)

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

setMySqlSettings

@Stability(Stable)
public void setMySqlSettings(@Nullable
 CfnEndpoint.MySqlSettingsProperty value)

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

getNeptuneSettings

@Stability(Stable)
@Nullable
public Object getNeptuneSettings()

Settings in JSON format for the target Amazon Neptune endpoint.

Returns union: either IResolvable or CfnEndpoint.NeptuneSettingsProperty

setNeptuneSettings

@Stability(Stable)
public void setNeptuneSettings(@Nullable
 IResolvable value)

Settings in JSON format for the target Amazon Neptune endpoint.

setNeptuneSettings

@Stability(Stable)
public void setNeptuneSettings(@Nullable
 CfnEndpoint.NeptuneSettingsProperty value)

Settings in JSON format for the target Amazon Neptune endpoint.

getOracleSettings

@Stability(Stable)
@Nullable
public Object getOracleSettings()

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

Returns union: either IResolvable or CfnEndpoint.OracleSettingsProperty

setOracleSettings

@Stability(Stable)
public void setOracleSettings(@Nullable
 IResolvable value)

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

setOracleSettings

@Stability(Stable)
public void setOracleSettings(@Nullable
 CfnEndpoint.OracleSettingsProperty value)

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

getPassword

@Stability(Stable)
@Nullable
public String getPassword()

The password to be used to log in to the endpoint database.

setPassword

@Stability(Stable)
public void setPassword(@Nullable
 String value)

The password to be used to log in to the endpoint database.

getPort

@Stability(Stable)
@Nullable
public Number getPort()

The port used by the endpoint database.

setPort

@Stability(Stable)
public void setPort(@Nullable
 Number value)

The port used by the endpoint database.

getPostgreSqlSettings

@Stability(Stable)
@Nullable
public Object getPostgreSqlSettings()

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

Returns union: either IResolvable or CfnEndpoint.PostgreSqlSettingsProperty

setPostgreSqlSettings

@Stability(Stable)
public void setPostgreSqlSettings(@Nullable
 IResolvable value)

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

setPostgreSqlSettings

@Stability(Stable)
public void setPostgreSqlSettings(@Nullable
 CfnEndpoint.PostgreSqlSettingsProperty value)

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

getRedisSettings

@Stability(Stable)
@Nullable
public Object getRedisSettings()

Settings in JSON format for the target Redis endpoint.

Returns union: either IResolvable or CfnEndpoint.RedisSettingsProperty

setRedisSettings

@Stability(Stable)
public void setRedisSettings(@Nullable
 IResolvable value)

Settings in JSON format for the target Redis endpoint.

setRedisSettings

@Stability(Stable)
public void setRedisSettings(@Nullable
 CfnEndpoint.RedisSettingsProperty value)

Settings in JSON format for the target Redis endpoint.

getRedshiftSettings

@Stability(Stable)
@Nullable
public Object getRedshiftSettings()

Settings in JSON format for the Amazon Redshift endpoint.

Returns union: either IResolvable or CfnEndpoint.RedshiftSettingsProperty

setRedshiftSettings

@Stability(Stable)
public void setRedshiftSettings(@Nullable
 IResolvable value)

Settings in JSON format for the Amazon Redshift endpoint.

setRedshiftSettings

@Stability(Stable)
public void setRedshiftSettings(@Nullable
 CfnEndpoint.RedshiftSettingsProperty value)

Settings in JSON format for the Amazon Redshift endpoint.

getResourceIdentifier

@Stability(Stable)
@Nullable
public String getResourceIdentifier()

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

setResourceIdentifier

@Stability(Stable)
public void setResourceIdentifier(@Nullable
 String value)

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

getS3Settings

@Stability(Stable)
@Nullable
public Object getS3Settings()

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

Returns union: either IResolvable or CfnEndpoint.S3SettingsProperty

setS3Settings

@Stability(Stable)
public void setS3Settings(@Nullable
 IResolvable value)

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

setS3Settings

@Stability(Stable)
public void setS3Settings(@Nullable
 CfnEndpoint.S3SettingsProperty value)

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

getServerName

@Stability(Stable)
@Nullable
public String getServerName()

The name of the server where the endpoint database resides.

setServerName

@Stability(Stable)
public void setServerName(@Nullable
 String value)

The name of the server where the endpoint database resides.

getSslMode

@Stability(Stable)
@Nullable
public String getSslMode()

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

The default is none .

setSslMode

@Stability(Stable)
public void setSslMode(@Nullable
 String value)

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

The default is none .

getSybaseSettings

@Stability(Stable)
@Nullable
public Object getSybaseSettings()

Settings in JSON format for the source and target SAP ASE endpoint.

Returns union: either IResolvable or CfnEndpoint.SybaseSettingsProperty

setSybaseSettings

@Stability(Stable)
public void setSybaseSettings(@Nullable
 IResolvable value)

Settings in JSON format for the source and target SAP ASE endpoint.

setSybaseSettings

@Stability(Stable)
public void setSybaseSettings(@Nullable
 CfnEndpoint.SybaseSettingsProperty value)

Settings in JSON format for the source and target SAP ASE endpoint.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

One or more tags to be assigned to the endpoint.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

One or more tags to be assigned to the endpoint.

getUsername

@Stability(Stable)
@Nullable
public String getUsername()

The user name to be used to log in to the endpoint database.

setUsername

@Stability(Stable)
public void setUsername(@Nullable
 String value)

The user name to be used to log in to the endpoint database.