CfnEndpoint (software.amazon.awscdk:monocdk 1.138.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.core.Construct
    - - software.amazon.awscdk.core.CfnElement
      - software.amazon.awscdk.core.CfnRefElement
        
        software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.dms.CfnEndpoint

All Implemented Interfaces:: IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:05.592Z")
 @Stability(value=Stable)
public class CfnEndpoint
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::Endpoint`.

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

Currently, the only endpoint setting types that AWS CloudFormation supports are DynamoDBSettings , ElasticSearchSettings , and NeptuneSettings .

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()
                 .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	Class and Description
`static class`	`CfnEndpoint.Builder` A fluent builder for `CfnEndpoint`.
`static interface`	`CfnEndpoint.DocDbSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.DynamoDbSettingsProperty` Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.
`static interface`	`CfnEndpoint.ElasticsearchSettingsProperty` Provides information that defines an OpenSearch endpoint.
`static interface`	`CfnEndpoint.IbmDb2SettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.KafkaSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.KinesisSettingsProperty` Not currently supported by AWS CloudFormation ..
`static interface`	`CfnEndpoint.MicrosoftSqlServerSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.MongoDbSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.MySqlSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.NeptuneSettingsProperty` Provides information that defines an Amazon Neptune endpoint.
`static interface`	`CfnEndpoint.OracleSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.PostgreSqlSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.RedisSettingsProperty` Provides information that defines a Redis target endpoint.
`static interface`	`CfnEndpoint.RedshiftSettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.S3SettingsProperty` Not currently supported by AWS CloudFormation .
`static interface`	`CfnEndpoint.SybaseSettingsProperty` Not currently supported by AWS CloudFormation .

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrExternalId()` A value that can be used for cross-account validation.
`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 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.
`String`	`getEndpointType()` The type of endpoint.
`String`	`getEngineName()` The type of engine for the endpoint.
`String`	`getExtraConnectionAttributes()` Additional attributes associated with the connection.
`Object`	`getIbmDb2Settings()` Not currently supported by AWS CloudFormation .
`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()` Not currently supported by AWS CloudFormation .
`Object`	`getMongoDbSettings()` Not currently supported by AWS CloudFormation .
`Object`	`getMySqlSettings()` Settings in JSON format for the source and target MySQL endpoint.
`Object`	`getNeptuneSettings()` `AWS::DMS::Endpoint.NeptuneSettings`.
`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()` Not currently supported by AWS CloudFormation .
`Object`	`getRedisSettings()` Settings in JSON format for the target Redis endpoint.
`Object`	`getRedshiftSettings()` Not currently supported by AWS CloudFormation .
`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.
`Object`	`getS3Settings()` Settings in JSON format for the 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()` 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(CfnEndpoint.DocDbSettingsProperty value)` Settings in JSON format for the source DocumentDB endpoint.
`void`	`setDocDbSettings(IResolvable value)` Settings in JSON format for the source DocumentDB endpoint.
`void`	`setDynamoDbSettings(CfnEndpoint.DynamoDbSettingsProperty value)` Settings in JSON format for the target Amazon DynamoDB endpoint.
`void`	`setDynamoDbSettings(IResolvable value)` Settings in JSON format for the target Amazon DynamoDB endpoint.
`void`	`setElasticsearchSettings(CfnEndpoint.ElasticsearchSettingsProperty value)` Settings in JSON format for the target OpenSearch endpoint.
`void`	`setElasticsearchSettings(IResolvable 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.
`void`	`setExtraConnectionAttributes(String value)` Additional attributes associated with the connection.
`void`	`setIbmDb2Settings(CfnEndpoint.IbmDb2SettingsProperty value)` Not currently supported by AWS CloudFormation .
`void`	`setIbmDb2Settings(IResolvable value)` Not currently supported by AWS CloudFormation .
`void`	`setKafkaSettings(CfnEndpoint.KafkaSettingsProperty value)` Settings in JSON format for the target Apache Kafka endpoint.
`void`	`setKafkaSettings(IResolvable value)` Settings in JSON format for the target Apache Kafka endpoint.
`void`	`setKinesisSettings(CfnEndpoint.KinesisSettingsProperty value)` Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
`void`	`setKinesisSettings(IResolvable 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(CfnEndpoint.MicrosoftSqlServerSettingsProperty value)` Not currently supported by AWS CloudFormation .
`void`	`setMicrosoftSqlServerSettings(IResolvable value)` Not currently supported by AWS CloudFormation .
`void`	`setMongoDbSettings(CfnEndpoint.MongoDbSettingsProperty value)` Not currently supported by AWS CloudFormation .
`void`	`setMongoDbSettings(IResolvable value)` Not currently supported by AWS CloudFormation .
`void`	`setMySqlSettings(CfnEndpoint.MySqlSettingsProperty value)` Settings in JSON format for the source and target MySQL endpoint.
`void`	`setMySqlSettings(IResolvable value)` Settings in JSON format for the source and target MySQL endpoint.
`void`	`setNeptuneSettings(CfnEndpoint.NeptuneSettingsProperty value)` `AWS::DMS::Endpoint.NeptuneSettings`.
`void`	`setNeptuneSettings(IResolvable value)` `AWS::DMS::Endpoint.NeptuneSettings`.
`void`	`setOracleSettings(CfnEndpoint.OracleSettingsProperty value)` Settings in JSON format for the source and target Oracle endpoint.
`void`	`setOracleSettings(IResolvable 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(CfnEndpoint.PostgreSqlSettingsProperty value)` Not currently supported by AWS CloudFormation .
`void`	`setPostgreSqlSettings(IResolvable value)` Not currently supported by AWS CloudFormation .
`void`	`setRedisSettings(CfnEndpoint.RedisSettingsProperty value)` Settings in JSON format for the target Redis endpoint.
`void`	`setRedisSettings(IResolvable value)` Settings in JSON format for the target Redis endpoint.
`void`	`setRedshiftSettings(CfnEndpoint.RedshiftSettingsProperty value)` Not currently supported by AWS CloudFormation .
`void`	`setRedshiftSettings(IResolvable value)` Not currently supported by AWS CloudFormation .
`void`	`setResourceIdentifier(String value)` A friendly name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
`void`	`setS3Settings(CfnEndpoint.S3SettingsProperty value)` Settings in JSON format for the target Amazon S3 endpoint.
`void`	`setS3Settings(IResolvable value)` Settings in JSON format for the 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(CfnEndpoint.SybaseSettingsProperty value)` Settings in JSON format for the source and target SAP ASE endpoint.
`void`	`setSybaseSettings(IResolvable value)` Settings in JSON format for the source and target SAP ASE 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.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnEndpoint
```
protected CfnEndpoint(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnEndpoint
```
protected CfnEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnEndpoint
```
@Stability(value=Stable)
public CfnEndpoint(@NotNull
                                            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 - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrExternalId()
```
    A value that can be used for cross-account validation.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    One or more tags to be assigned to the endpoint.
  - getEndpointType
```
@Stability(value=Stable)
 @NotNull
public String getEndpointType()
```
    The type of endpoint.
    Valid values are source and target .
  - setEndpointType
```
@Stability(value=Stable)
public void setEndpointType(@NotNull
                                                     String value)
```
    The type of endpoint.
    Valid values are source and target .
  - getEngineName
```
@Stability(value=Stable)
 @NotNull
public 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" .
  - setEngineName
```
@Stability(value=Stable)
public void setEngineName(@NotNull
                                                   String value)
```
    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
public String getCertificateArn()
```
    The Amazon Resource Name (ARN) for the certificate.
  - setCertificateArn
```
@Stability(value=Stable)
public void setCertificateArn(@Nullable
                                                       String value)
```
    The Amazon Resource Name (ARN) for the certificate.
  - getDatabaseName
```
@Stability(value=Stable)
 @Nullable
public String getDatabaseName()
```
    The name of the endpoint database.
    For a MySQL source or target endpoint, do not specify DatabaseName.
  - setDatabaseName
```
@Stability(value=Stable)
public void setDatabaseName(@Nullable
                                                     String value)
```
    The name of the endpoint database.
    For a MySQL source or target endpoint, do not specify DatabaseName.
  - getDocDbSettings
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setDocDbSettings
```
@Stability(value=Stable)
public void setDocDbSettings(@Nullable
                                                      CfnEndpoint.DocDbSettingsProperty value)
```
    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.
  - setDocDbSettings
```
@Stability(value=Stable)
public void setDocDbSettings(@Nullable
                                                      IResolvable value)
```
    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
public 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.
  - setDynamoDbSettings
```
@Stability(value=Stable)
public void setDynamoDbSettings(@Nullable
                                                         CfnEndpoint.DynamoDbSettingsProperty value)
```
    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.
  - setDynamoDbSettings
```
@Stability(value=Stable)
public void setDynamoDbSettings(@Nullable
                                                         IResolvable value)
```
    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
public 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 .
  - setElasticsearchSettings
```
@Stability(value=Stable)
public void setElasticsearchSettings(@Nullable
                                                              CfnEndpoint.ElasticsearchSettingsProperty value)
```
    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 .
  - setElasticsearchSettings
```
@Stability(value=Stable)
public void setElasticsearchSettings(@Nullable
                                                              IResolvable value)
```
    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
public 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.
  - setEndpointIdentifier
```
@Stability(value=Stable)
public void setEndpointIdentifier(@Nullable
                                                           String value)
```
    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
public 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.
  - setExtraConnectionAttributes
```
@Stability(value=Stable)
public void setExtraConnectionAttributes(@Nullable
                                                                  String value)
```
    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
public Object getIbmDb2Settings()
```
    Not currently supported by AWS CloudFormation .
  - setIbmDb2Settings
```
@Stability(value=Stable)
public void setIbmDb2Settings(@Nullable
                                                       CfnEndpoint.IbmDb2SettingsProperty value)
```
    Not currently supported by AWS CloudFormation .
  - setIbmDb2Settings
```
@Stability(value=Stable)
public void setIbmDb2Settings(@Nullable
                                                       IResolvable value)
```
    Not currently supported by AWS CloudFormation .
  - getKafkaSettings
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setKafkaSettings
```
@Stability(value=Stable)
public void setKafkaSettings(@Nullable
                                                      CfnEndpoint.KafkaSettingsProperty value)
```
    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.
  - setKafkaSettings
```
@Stability(value=Stable)
public void setKafkaSettings(@Nullable
                                                      IResolvable value)
```
    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
public 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.
  - setKinesisSettings
```
@Stability(value=Stable)
public void setKinesisSettings(@Nullable
                                                        CfnEndpoint.KinesisSettingsProperty value)
```
    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.
  - setKinesisSettings
```
@Stability(value=Stable)
public void setKinesisSettings(@Nullable
                                                        IResolvable value)
```
    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
public 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 .
  - setKmsKeyId
```
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)
```
    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
public Object getMicrosoftSqlServerSettings()
```
    Not currently supported by AWS CloudFormation .
  - setMicrosoftSqlServerSettings
```
@Stability(value=Stable)
public void setMicrosoftSqlServerSettings(@Nullable
                                                                   CfnEndpoint.MicrosoftSqlServerSettingsProperty value)
```
    Not currently supported by AWS CloudFormation .
  - setMicrosoftSqlServerSettings
```
@Stability(value=Stable)
public void setMicrosoftSqlServerSettings(@Nullable
                                                                   IResolvable value)
```
    Not currently supported by AWS CloudFormation .
  - getMongoDbSettings
```
@Stability(value=Stable)
 @Nullable
public Object getMongoDbSettings()
```
    Not currently supported by AWS CloudFormation .
  - setMongoDbSettings
```
@Stability(value=Stable)
public void setMongoDbSettings(@Nullable
                                                        CfnEndpoint.MongoDbSettingsProperty value)
```
    Not currently supported by AWS CloudFormation .
  - setMongoDbSettings
```
@Stability(value=Stable)
public void setMongoDbSettings(@Nullable
                                                        IResolvable value)
```
    Not currently supported by AWS CloudFormation .
  - getMySqlSettings
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setMySqlSettings
```
@Stability(value=Stable)
public void setMySqlSettings(@Nullable
                                                      CfnEndpoint.MySqlSettingsProperty value)
```
    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.
  - setMySqlSettings
```
@Stability(value=Stable)
public void setMySqlSettings(@Nullable
                                                      IResolvable value)
```
    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
public Object getNeptuneSettings()
```
    `AWS::DMS::Endpoint.NeptuneSettings`.
  - setNeptuneSettings
```
@Stability(value=Stable)
public void setNeptuneSettings(@Nullable
                                                        CfnEndpoint.NeptuneSettingsProperty value)
```
    `AWS::DMS::Endpoint.NeptuneSettings`.
  - setNeptuneSettings
```
@Stability(value=Stable)
public void setNeptuneSettings(@Nullable
                                                        IResolvable value)
```
    `AWS::DMS::Endpoint.NeptuneSettings`.
  - getOracleSettings
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setOracleSettings
```
@Stability(value=Stable)
public void setOracleSettings(@Nullable
                                                       CfnEndpoint.OracleSettingsProperty value)
```
    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.
  - setOracleSettings
```
@Stability(value=Stable)
public void setOracleSettings(@Nullable
                                                       IResolvable value)
```
    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
public String getPassword()
```
    The password to be used to log in to the endpoint database.
  - setPassword
```
@Stability(value=Stable)
public void setPassword(@Nullable
                                                 String value)
```
    The password to be used to log in to the endpoint database.
  - getPort
```
@Stability(value=Stable)
 @Nullable
public Number getPort()
```
    The port used by the endpoint database.
  - setPort
```
@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)
```
    The port used by the endpoint database.
  - getPostgreSqlSettings
```
@Stability(value=Stable)
 @Nullable
public Object getPostgreSqlSettings()
```
    Not currently supported by AWS CloudFormation .
  - setPostgreSqlSettings
```
@Stability(value=Stable)
public void setPostgreSqlSettings(@Nullable
                                                           CfnEndpoint.PostgreSqlSettingsProperty value)
```
    Not currently supported by AWS CloudFormation .
  - setPostgreSqlSettings
```
@Stability(value=Stable)
public void setPostgreSqlSettings(@Nullable
                                                           IResolvable value)
```
    Not currently supported by AWS CloudFormation .
  - getRedisSettings
```
@Stability(value=Stable)
 @Nullable
public Object getRedisSettings()
```
    Settings in JSON format for the target Redis endpoint.
  - setRedisSettings
```
@Stability(value=Stable)
public void setRedisSettings(@Nullable
                                                      CfnEndpoint.RedisSettingsProperty value)
```
    Settings in JSON format for the target Redis endpoint.
  - setRedisSettings
```
@Stability(value=Stable)
public void setRedisSettings(@Nullable
                                                      IResolvable value)
```
    Settings in JSON format for the target Redis endpoint.
  - getRedshiftSettings
```
@Stability(value=Stable)
 @Nullable
public Object getRedshiftSettings()
```
    Not currently supported by AWS CloudFormation .
  - setRedshiftSettings
```
@Stability(value=Stable)
public void setRedshiftSettings(@Nullable
                                                         CfnEndpoint.RedshiftSettingsProperty value)
```
    Not currently supported by AWS CloudFormation .
  - setRedshiftSettings
```
@Stability(value=Stable)
public void setRedshiftSettings(@Nullable
                                                         IResolvable value)
```
    Not currently supported by AWS CloudFormation .
  - getResourceIdentifier
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setResourceIdentifier
```
@Stability(value=Stable)
public void setResourceIdentifier(@Nullable
                                                           String value)
```
    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
public 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.
  - setS3Settings
```
@Stability(value=Stable)
public void setS3Settings(@Nullable
                                                   CfnEndpoint.S3SettingsProperty value)
```
    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.
  - setS3Settings
```
@Stability(value=Stable)
public void setS3Settings(@Nullable
                                                   IResolvable value)
```
    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
public String getServerName()
```
    The name of the server where the endpoint database resides.
  - setServerName
```
@Stability(value=Stable)
public void setServerName(@Nullable
                                                   String value)
```
    The name of the server where the endpoint database resides.
  - getSslMode
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setSslMode
```
@Stability(value=Stable)
public void setSslMode(@Nullable
                                                String value)
```
    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
public 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.
  - setSybaseSettings
```
@Stability(value=Stable)
public void setSybaseSettings(@Nullable
                                                       CfnEndpoint.SybaseSettingsProperty value)
```
    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.
  - setSybaseSettings
```
@Stability(value=Stable)
public void setSybaseSettings(@Nullable
                                                       IResolvable value)
```
    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.
  - getUsername
```
@Stability(value=Stable)
 @Nullable
public String getUsername()
```
    The user name to be used to log in to the endpoint database.
  - setUsername
```
@Stability(value=Stable)
public void setUsername(@Nullable
                                                 String value)
```
    The user name to be used to log in to the endpoint database.

Class CfnEndpoint

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnEndpoint

CfnEndpoint

CfnEndpoint

Method Detail

inspect

renderProperties

getAttrExternalId

getCfnProperties

getTags

getEndpointType

setEndpointType

getEngineName

setEngineName

getCertificateArn

setCertificateArn

getDatabaseName

setDatabaseName

getDocDbSettings

setDocDbSettings

setDocDbSettings

getDynamoDbSettings

setDynamoDbSettings

setDynamoDbSettings

getElasticsearchSettings

setElasticsearchSettings

setElasticsearchSettings

getEndpointIdentifier

setEndpointIdentifier

getExtraConnectionAttributes

setExtraConnectionAttributes

getIbmDb2Settings

setIbmDb2Settings

setIbmDb2Settings

getKafkaSettings

setKafkaSettings

setKafkaSettings

getKinesisSettings

setKinesisSettings

setKinesisSettings

getKmsKeyId

setKmsKeyId

getMicrosoftSqlServerSettings

setMicrosoftSqlServerSettings

setMicrosoftSqlServerSettings

getMongoDbSettings

setMongoDbSettings

setMongoDbSettings

getMySqlSettings

setMySqlSettings

setMySqlSettings

getNeptuneSettings

setNeptuneSettings

setNeptuneSettings

getOracleSettings

setOracleSettings

setOracleSettings

getPassword

setPassword

getPort

setPort

getPostgreSqlSettings

setPostgreSqlSettings