Package software.amazon.awscdk.services.dms

Interface CfnEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.873Z")
@Stability(Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEndpoint.

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.*;
 CfnEndpointProps cfnEndpointProps = CfnEndpointProps.builder()
         .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	Interface	Description
static final class	CfnEndpointProps.Builder	A builder for CfnEndpointProps
static final class	CfnEndpointProps.Jsii$Proxy	An implementation for CfnEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnEndpointProps.Builder	builder()
default String	getCertificateArn()	The Amazon Resource Name (ARN) for the certificate.
default String	getDatabaseName()	The name of the endpoint database.
default Object	getDocDbSettings()	Settings in JSON format for the source and target DocumentDB endpoint.
default Object	getDynamoDbSettings()	Settings in JSON format for the target Amazon DynamoDB endpoint.
default Object	getElasticsearchSettings()	Settings in JSON format for the target OpenSearch endpoint.
default String	getEndpointIdentifier()	The database endpoint identifier.
String	getEndpointType()	The type of endpoint.
String	getEngineName()	The type of engine for the endpoint, depending on the EndpointType value.
default String	getExtraConnectionAttributes()	Additional attributes associated with the connection.
default Object	getGcpMySqlSettings()	Settings in JSON format for the source GCP MySQL endpoint.
default Object	getIbmDb2Settings()	Settings in JSON format for the source IBM Db2 LUW endpoint.
default Object	getKafkaSettings()	Settings in JSON format for the target Apache Kafka endpoint.
default Object	getKinesisSettings()	Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
default String	getKmsKeyId()	An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
default Object	getMicrosoftSqlServerSettings()	Settings in JSON format for the source and target Microsoft SQL Server endpoint.
default Object	getMongoDbSettings()	Settings in JSON format for the source MongoDB endpoint.
default Object	getMySqlSettings()	Settings in JSON format for the source and target MySQL endpoint.
default Object	getNeptuneSettings()	Settings in JSON format for the target Amazon Neptune endpoint.
default Object	getOracleSettings()	Settings in JSON format for the source and target Oracle endpoint.
default String	getPassword()	The password to be used to log in to the endpoint database.
default Number	getPort()	The port used by the endpoint database.
default Object	getPostgreSqlSettings()	Settings in JSON format for the source and target PostgreSQL endpoint.
default Object	getRedisSettings()	Settings in JSON format for the target Redis endpoint.
default Object	getRedshiftSettings()	Settings in JSON format for the Amazon Redshift endpoint.
default 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.
default Object	getS3Settings()	Settings in JSON format for the source and target Amazon S3 endpoint.
default String	getServerName()	The name of the server where the endpoint database resides.
default String	getSslMode()	The Secure Sockets Layer (SSL) mode to use for the SSL connection.
default Object	getSybaseSettings()	Settings in JSON format for the source and target SAP ASE endpoint.
default List<CfnTag>	getTags()	One or more tags to be assigned to the endpoint.
default String	getUsername()	The user name to be used to log in to the endpoint database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndpointType

@Stability(Stable)
@NotNull
String getEndpointType()

The type of endpoint.

Valid values are source and target .

See Also:

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

getEngineName

@Stability(Stable)
@NotNull
String getEngineName()

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

See Also:

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

getCertificateArn

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

The Amazon Resource Name (ARN) for the certificate.

See Also:

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

getDatabaseName

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

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 .

See Also:

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

getDocDbSettings

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

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 .

See Also:

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

getDynamoDbSettings

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

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 .

See Also:

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

getElasticsearchSettings

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

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 .

See Also:

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

getEndpointIdentifier

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

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.

See Also:

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

getExtraConnectionAttributes

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

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 .

See Also:

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

getGcpMySqlSettings

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

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 .

See Also:

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

getIbmDb2Settings

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

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 .

See Also:

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

getKafkaSettings

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

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 .

See Also:

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

getKinesisSettings

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

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 .

See Also:

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

getKmsKeyId

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

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

If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .

See Also:

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

getMicrosoftSqlServerSettings

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

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 .

See Also:

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

getMongoDbSettings

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

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 .

See Also:

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

getMySqlSettings

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

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 .

See Also:

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

getNeptuneSettings

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

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 .

See Also:

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

getOracleSettings

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

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 .

See Also:

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

getPassword

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

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

See Also:

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

getPort

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

The port used by the endpoint database.

See Also:

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

getPostgreSqlSettings

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

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 .

See Also:

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

getRedisSettings

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

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 .

See Also:

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

getRedshiftSettings

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

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 .

See Also:

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

getResourceIdentifier

@Stability(Stable)
@Nullable
default 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.

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 .

See Also:

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

getS3Settings

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

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 .

See Also:

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

getServerName

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

The name of the server where the endpoint database resides.

See Also:

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

getSslMode

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

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 .

See Also:

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

getSybaseSettings

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

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 .

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

One or more tags to be assigned to the endpoint.

See Also:

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

getUsername

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

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

See Also:

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

builder

@Stability(Stable)
static CfnEndpointProps.Builder builder()

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps