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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:05.632Z")
 @Stability(value=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()
                 .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")
         .ibmDb2Settings(IbmDb2SettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .kafkaSettings(KafkaSettingsProperty.builder()
                 .broker("broker")
                 .includeControlDetails(false)
                 .includeNullAndEmpty(false)
                 .includeTableAlterOperations(false)
                 .includeTransactionDetails(false)
                 .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)
                 .includeTableAlterOperations(false)
                 .includeTransactionDetails(false)
                 .messageFormat("messageFormat")
                 .noHexPrefix(false)
                 .partitionIncludeSchemaTable(false)
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .streamArn("streamArn")
                 .build())
         .kmsKeyId("kmsKeyId")
         .microsoftSqlServerSettings(MicrosoftSqlServerSettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .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()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .neptuneSettings(NeptuneSettingsProperty.builder()
                 .errorRetryDuration(123)
                 .iamAuthEnabled(false)
                 .maxFileSize(123)
                 .maxRetryCount(123)
                 .s3BucketFolder("s3BucketFolder")
                 .s3BucketName("s3BucketName")
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .build())
         .oracleSettings(OracleSettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerOracleAsmAccessRoleArn("secretsManagerOracleAsmAccessRoleArn")
                 .secretsManagerOracleAsmSecretId("secretsManagerOracleAsmSecretId")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .password("password")
         .port(123)
         .postgreSqlSettings(PostgreSqlSettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .redisSettings(RedisSettingsProperty.builder()
                 .authPassword("authPassword")
                 .authType("authType")
                 .authUserName("authUserName")
                 .port(123)
                 .serverName("serverName")
                 .sslCaCertificateArn("sslCaCertificateArn")
                 .sslSecurityProtocol("sslSecurityProtocol")
                 .build())
         .redshiftSettings(RedshiftSettingsProperty.builder()
                 .secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
                 .secretsManagerSecretId("secretsManagerSecretId")
                 .build())
         .resourceIdentifier("resourceIdentifier")
         .s3Settings(S3SettingsProperty.builder()
                 .bucketFolder("bucketFolder")
                 .bucketName("bucketName")
                 .compressionType("compressionType")
                 .csvDelimiter("csvDelimiter")
                 .csvRowDelimiter("csvRowDelimiter")
                 .externalTableDefinition("externalTableDefinition")
                 .serviceAccessRoleArn("serviceAccessRoleArn")
                 .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEndpointProps.Builder A builder for CfnEndpointProps
static class	CfnEndpointProps.Jsii$Proxy An implementation for CfnEndpointProps

Method Summary

Modifier and Type	Method and 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 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.
default String	getExtraConnectionAttributes() Additional attributes associated with the connection.
default Object	getIbmDb2Settings() Not currently supported by AWS CloudFormation .
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() Not currently supported by AWS CloudFormation .
default Object	getMongoDbSettings() Not currently supported by AWS CloudFormation .
default Object	getMySqlSettings() Settings in JSON format for the source and target MySQL endpoint.
default Object	getNeptuneSettings() `AWS::DMS::Endpoint.NeptuneSettings`.
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() Not currently supported by AWS CloudFormation .
default Object	getRedisSettings() Settings in JSON format for the target Redis endpoint.
default Object	getRedshiftSettings() Not currently supported by AWS CloudFormation .
default String	getResourceIdentifier() A friendly 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 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 Detail

getEndpointType

@Stability(value=Stable)
 @NotNull
String getEndpointType()

The type of endpoint.

Valid values are source and target .

getEngineName

@Stability(value=Stable)
 @NotNull
String getEngineName()

The type of engine for the endpoint.

Valid values, depending on the EndpointType value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "opensearch" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "docdb" , "sqlserver" , and "neptune" .

getCertificateArn

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

The Amazon Resource Name (ARN) for the certificate.

getDatabaseName

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

The name of the endpoint database.

For a MySQL source or target endpoint, do not specify DatabaseName.

getDocDbSettings

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

Settings in JSON format for the source DocumentDB endpoint.

For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

getDynamoDbSettings

@Stability(value=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.

getElasticsearchSettings

@Stability(value=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 .

getEndpointIdentifier

@Stability(value=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.

getExtraConnectionAttributes

@Stability(value=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.

getIbmDb2Settings

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

Not currently supported by AWS CloudFormation .

getKafkaSettings

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

Settings in JSON format for the target Apache Kafka endpoint.

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

getKinesisSettings

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

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

For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

getKmsKeyId

@Stability(value=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, then 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 .

getMicrosoftSqlServerSettings

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

Not currently supported by AWS CloudFormation .

getMongoDbSettings

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

Not currently supported by AWS CloudFormation .

getMySqlSettings

@Stability(value=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.

getNeptuneSettings

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

`AWS::DMS::Endpoint.NeptuneSettings`.

getOracleSettings

@Stability(value=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.

getPassword

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

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

getPort

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

The port used by the endpoint database.

getPostgreSqlSettings

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

Not currently supported by AWS CloudFormation .

getRedisSettings

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

Settings in JSON format for the target Redis endpoint.

getRedshiftSettings

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

Not currently supported by AWS CloudFormation .

getResourceIdentifier

@Stability(value=Stable)
 @Nullable
default String getResourceIdentifier()

A friendly 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 .

getS3Settings

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

Settings in JSON format for the target Amazon S3 endpoint.

For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

getServerName

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

The name of the server where the endpoint database resides.

getSslMode

@Stability(value=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, then the only allowed value is none .

getSybaseSettings

@Stability(value=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.

getTags

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

One or more tags to be assigned to the endpoint.

getUsername

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

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

builder

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

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps