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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.807Z")
 @Stability(value=Stable)
public interface CfnEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::DMS::Endpoint`.

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() `AWS::DMS::Endpoint.CertificateArn`.
default String	getDatabaseName() `AWS::DMS::Endpoint.DatabaseName`.
default Object	getDocDbSettings() `AWS::DMS::Endpoint.DocDbSettings`.
default Object	getDynamoDbSettings() `AWS::DMS::Endpoint.DynamoDbSettings`.
default Object	getElasticsearchSettings() `AWS::DMS::Endpoint.ElasticsearchSettings`.
default String	getEndpointIdentifier() `AWS::DMS::Endpoint.EndpointIdentifier`.
String	getEndpointType() `AWS::DMS::Endpoint.EndpointType`.
String	getEngineName() `AWS::DMS::Endpoint.EngineName`.
default String	getExtraConnectionAttributes() `AWS::DMS::Endpoint.ExtraConnectionAttributes`.
default Object	getIbmDb2Settings() `AWS::DMS::Endpoint.IbmDb2Settings`.
default Object	getKafkaSettings() `AWS::DMS::Endpoint.KafkaSettings`.
default Object	getKinesisSettings() `AWS::DMS::Endpoint.KinesisSettings`.
default String	getKmsKeyId() `AWS::DMS::Endpoint.KmsKeyId`.
default Object	getMicrosoftSqlServerSettings() `AWS::DMS::Endpoint.MicrosoftSqlServerSettings`.
default Object	getMongoDbSettings() `AWS::DMS::Endpoint.MongoDbSettings`.
default Object	getMySqlSettings() `AWS::DMS::Endpoint.MySqlSettings`.
default Object	getNeptuneSettings() `AWS::DMS::Endpoint.NeptuneSettings`.
default Object	getOracleSettings() `AWS::DMS::Endpoint.OracleSettings`.
default String	getPassword() `AWS::DMS::Endpoint.Password`.
default Number	getPort() `AWS::DMS::Endpoint.Port`.
default Object	getPostgreSqlSettings() `AWS::DMS::Endpoint.PostgreSqlSettings`.
default Object	getRedisSettings() `AWS::DMS::Endpoint.RedisSettings`.
default Object	getRedshiftSettings() `AWS::DMS::Endpoint.RedshiftSettings`.
default String	getResourceIdentifier() `AWS::DMS::Endpoint.ResourceIdentifier`.
default Object	getS3Settings() `AWS::DMS::Endpoint.S3Settings`.
default String	getServerName() `AWS::DMS::Endpoint.ServerName`.
default String	getSslMode() `AWS::DMS::Endpoint.SslMode`.
default Object	getSybaseSettings() `AWS::DMS::Endpoint.SybaseSettings`.
default List<CfnTag>	getTags() `AWS::DMS::Endpoint.Tags`.
default String	getUsername() `AWS::DMS::Endpoint.Username`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateArn

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

`AWS::DMS::Endpoint.CertificateArn`.

getDatabaseName

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

`AWS::DMS::Endpoint.DatabaseName`.

getDocDbSettings

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

`AWS::DMS::Endpoint.DocDbSettings`.

getDynamoDbSettings

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

`AWS::DMS::Endpoint.DynamoDbSettings`.

getElasticsearchSettings

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

`AWS::DMS::Endpoint.ElasticsearchSettings`.

getEndpointIdentifier

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

`AWS::DMS::Endpoint.EndpointIdentifier`.

getEndpointType

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

`AWS::DMS::Endpoint.EndpointType`.

getEngineName

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

`AWS::DMS::Endpoint.EngineName`.

getExtraConnectionAttributes

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

`AWS::DMS::Endpoint.ExtraConnectionAttributes`.

getIbmDb2Settings

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

`AWS::DMS::Endpoint.IbmDb2Settings`.

getKafkaSettings

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

`AWS::DMS::Endpoint.KafkaSettings`.

getKinesisSettings

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

`AWS::DMS::Endpoint.KinesisSettings`.

getKmsKeyId

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

`AWS::DMS::Endpoint.KmsKeyId`.

getMicrosoftSqlServerSettings

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

`AWS::DMS::Endpoint.MicrosoftSqlServerSettings`.

getMongoDbSettings

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

`AWS::DMS::Endpoint.MongoDbSettings`.

getMySqlSettings

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

`AWS::DMS::Endpoint.MySqlSettings`.

getNeptuneSettings

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

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

getOracleSettings

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

`AWS::DMS::Endpoint.OracleSettings`.

getPassword

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

`AWS::DMS::Endpoint.Password`.

getPort

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

`AWS::DMS::Endpoint.Port`.

getPostgreSqlSettings

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

`AWS::DMS::Endpoint.PostgreSqlSettings`.

getRedisSettings

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

`AWS::DMS::Endpoint.RedisSettings`.

getRedshiftSettings

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

`AWS::DMS::Endpoint.RedshiftSettings`.

getResourceIdentifier

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

`AWS::DMS::Endpoint.ResourceIdentifier`.

getS3Settings

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

`AWS::DMS::Endpoint.S3Settings`.

getServerName

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

`AWS::DMS::Endpoint.ServerName`.

getSslMode

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

`AWS::DMS::Endpoint.SslMode`.

getSybaseSettings

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

`AWS::DMS::Endpoint.SybaseSettings`.

getTags

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

`AWS::DMS::Endpoint.Tags`.

getUsername

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

`AWS::DMS::Endpoint.Username`.

builder

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

Returns:

a CfnEndpointProps.Builder of CfnEndpointProps