CfnEndpoint L1 construct
The AWS::DMS::Endpoint resource specifies an AWS DMS endpoint.
Currently, AWS CloudFormation supports all AWS DMS endpoint types.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const cfnEndpoint = new dms.CfnEndpoint(this, 'MyCfnEndpoint', {
endpointType: 'endpointType',
engineName: 'engineName',
// the properties below are optional
certificateArn: 'certificateArn',
databaseName: 'databaseName',
docDbSettings: {
docsToInvestigate: 123,
extractDocId: false,
nestingLevel: 'nestingLevel',
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
},
dynamoDbSettings: {
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
elasticsearchSettings: {
endpointUri: 'endpointUri',
errorRetryDuration: 123,
fullLoadErrorPercentage: 123,
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
endpointIdentifier: 'endpointIdentifier',
extraConnectionAttributes: 'extraConnectionAttributes',
gcpMySqlSettings: {
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',
},
ibmDb2Settings: {
currentLsn: 'currentLsn',
keepCsvFiles: false,
loadTimeout: 123,
maxFileSize: 123,
maxKBytesPerRead: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
setDataCaptureChanges: false,
writeBufferSize: 123,
},
kafkaSettings: {
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',
},
kinesisSettings: {
includeControlDetails: false,
includeNullAndEmpty: false,
includePartitionValue: false,
includeTableAlterOperations: false,
includeTransactionDetails: false,
messageFormat: 'messageFormat',
noHexPrefix: false,
partitionIncludeSchemaTable: false,
serviceAccessRoleArn: 'serviceAccessRoleArn',
streamArn: 'streamArn',
},
kmsKeyId: 'kmsKeyId',
microsoftSqlServerSettings: {
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,
},
mongoDbSettings: {
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',
},
mySqlSettings: {
afterConnectScript: 'afterConnectScript',
cleanSourceMetadataOnMismatch: false,
eventsPollInterval: 123,
maxFileSize: 123,
parallelLoadThreads: 123,
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
serverTimezone: 'serverTimezone',
targetDbType: 'targetDbType',
},
neptuneSettings: {
errorRetryDuration: 123,
iamAuthEnabled: false,
maxFileSize: 123,
maxRetryCount: 123,
s3BucketFolder: 's3BucketFolder',
s3BucketName: 's3BucketName',
serviceAccessRoleArn: 'serviceAccessRoleArn',
},
oracleSettings: {
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: [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',
},
password: 'password',
port: 123,
postgreSqlSettings: {
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',
},
redisSettings: {
authPassword: 'authPassword',
authType: 'authType',
authUserName: 'authUserName',
port: 123,
serverName: 'serverName',
sslCaCertificateArn: 'sslCaCertificateArn',
sslSecurityProtocol: 'sslSecurityProtocol',
},
redshiftSettings: {
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,
},
resourceIdentifier: 'resourceIdentifier',
s3Settings: {
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,
},
serverName: 'serverName',
sslMode: 'sslMode',
sybaseSettings: {
secretsManagerAccessRoleArn: 'secretsManagerAccessRoleArn',
secretsManagerSecretId: 'secretsManagerSecretId',
},
tags: [{
key: 'key',
value: 'value',
}],
username: 'username',
});
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_dms as dms
cfn_endpoint = dms.CfnEndpoint(self, "MyCfnEndpoint",
endpoint_type="endpointType",
engine_name="engineName",
# the properties below are optional
certificate_arn="certificateArn",
database_name="databaseName",
doc_db_settings=dms.CfnEndpoint.DocDbSettingsProperty(
docs_to_investigate=123,
extract_doc_id=False,
nesting_level="nestingLevel",
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId"
),
dynamo_db_settings=dms.CfnEndpoint.DynamoDbSettingsProperty(
service_access_role_arn="serviceAccessRoleArn"
),
elasticsearch_settings=dms.CfnEndpoint.ElasticsearchSettingsProperty(
endpoint_uri="endpointUri",
error_retry_duration=123,
full_load_error_percentage=123,
service_access_role_arn="serviceAccessRoleArn"
),
endpoint_identifier="endpointIdentifier",
extra_connection_attributes="extraConnectionAttributes",
gcp_my_sql_settings=dms.CfnEndpoint.GcpMySQLSettingsProperty(
after_connect_script="afterConnectScript",
clean_source_metadata_on_mismatch=False,
database_name="databaseName",
events_poll_interval=123,
max_file_size=123,
parallel_load_threads=123,
password="password",
port=123,
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
server_name="serverName",
server_timezone="serverTimezone",
username="username"
),
ibm_db2_settings=dms.CfnEndpoint.IbmDb2SettingsProperty(
current_lsn="currentLsn",
keep_csv_files=False,
load_timeout=123,
max_file_size=123,
max_k_bytes_per_read=123,
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
set_data_capture_changes=False,
write_buffer_size=123
),
kafka_settings=dms.CfnEndpoint.KafkaSettingsProperty(
broker="broker",
include_control_details=False,
include_null_and_empty=False,
include_partition_value=False,
include_table_alter_operations=False,
include_transaction_details=False,
message_format="messageFormat",
message_max_bytes=123,
no_hex_prefix=False,
partition_include_schema_table=False,
sasl_password="saslPassword",
sasl_user_name="saslUserName",
security_protocol="securityProtocol",
ssl_ca_certificate_arn="sslCaCertificateArn",
ssl_client_certificate_arn="sslClientCertificateArn",
ssl_client_key_arn="sslClientKeyArn",
ssl_client_key_password="sslClientKeyPassword",
topic="topic"
),
kinesis_settings=dms.CfnEndpoint.KinesisSettingsProperty(
include_control_details=False,
include_null_and_empty=False,
include_partition_value=False,
include_table_alter_operations=False,
include_transaction_details=False,
message_format="messageFormat",
no_hex_prefix=False,
partition_include_schema_table=False,
service_access_role_arn="serviceAccessRoleArn",
stream_arn="streamArn"
),
kms_key_id="kmsKeyId",
microsoft_sql_server_settings=dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty(
bcp_packet_size=123,
control_tables_file_group="controlTablesFileGroup",
database_name="databaseName",
force_lob_lookup=False,
password="password",
port=123,
query_single_always_on_node=False,
read_backup_only=False,
safeguard_policy="safeguardPolicy",
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
server_name="serverName",
tlog_access_mode="tlogAccessMode",
trim_space_in_char=False,
use_bcp_full_load=False,
username="username",
use_third_party_backup_device=False
),
mongo_db_settings=dms.CfnEndpoint.MongoDbSettingsProperty(
auth_mechanism="authMechanism",
auth_source="authSource",
auth_type="authType",
database_name="databaseName",
docs_to_investigate="docsToInvestigate",
extract_doc_id="extractDocId",
nesting_level="nestingLevel",
password="password",
port=123,
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
server_name="serverName",
username="username"
),
my_sql_settings=dms.CfnEndpoint.MySqlSettingsProperty(
after_connect_script="afterConnectScript",
clean_source_metadata_on_mismatch=False,
events_poll_interval=123,
max_file_size=123,
parallel_load_threads=123,
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
server_timezone="serverTimezone",
target_db_type="targetDbType"
),
neptune_settings=dms.CfnEndpoint.NeptuneSettingsProperty(
error_retry_duration=123,
iam_auth_enabled=False,
max_file_size=123,
max_retry_count=123,
s3_bucket_folder="s3BucketFolder",
s3_bucket_name="s3BucketName",
service_access_role_arn="serviceAccessRoleArn"
),
oracle_settings=dms.CfnEndpoint.OracleSettingsProperty(
access_alternate_directly=False,
additional_archived_log_dest_id=123,
add_supplemental_logging=False,
allow_select_nested_tables=False,
archived_log_dest_id=123,
archived_logs_only=False,
asm_password="asmPassword",
asm_server="asmServer",
asm_user="asmUser",
char_length_semantics="charLengthSemantics",
direct_path_no_log=False,
direct_path_parallel_load=False,
enable_homogenous_tablespace=False,
extra_archived_log_dest_ids=[123],
fail_tasks_on_lob_truncation=False,
number_datatype_scale=123,
oracle_path_prefix="oraclePathPrefix",
parallel_asm_read_threads=123,
read_ahead_blocks=123,
read_table_space_name=False,
replace_path_prefix=False,
retry_interval=123,
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_oracle_asm_access_role_arn="secretsManagerOracleAsmAccessRoleArn",
secrets_manager_oracle_asm_secret_id="secretsManagerOracleAsmSecretId",
secrets_manager_secret_id="secretsManagerSecretId",
security_db_encryption="securityDbEncryption",
security_db_encryption_name="securityDbEncryptionName",
spatial_data_option_to_geo_json_function_name="spatialDataOptionToGeoJsonFunctionName",
standby_delay_time=123,
use_alternate_folder_for_online=False,
use_b_file=False,
use_direct_path_full_load=False,
use_logminer_reader=False,
use_path_prefix="usePathPrefix"
),
password="password",
port=123,
postgre_sql_settings=dms.CfnEndpoint.PostgreSqlSettingsProperty(
after_connect_script="afterConnectScript",
babelfish_database_name="babelfishDatabaseName",
capture_ddls=False,
database_mode="databaseMode",
ddl_artifacts_schema="ddlArtifactsSchema",
execute_timeout=123,
fail_tasks_on_lob_truncation=False,
heartbeat_enable=False,
heartbeat_frequency=123,
heartbeat_schema="heartbeatSchema",
map_boolean_as_boolean=False,
max_file_size=123,
plugin_name="pluginName",
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
slot_name="slotName"
),
redis_settings=dms.CfnEndpoint.RedisSettingsProperty(
auth_password="authPassword",
auth_type="authType",
auth_user_name="authUserName",
port=123,
server_name="serverName",
ssl_ca_certificate_arn="sslCaCertificateArn",
ssl_security_protocol="sslSecurityProtocol"
),
redshift_settings=dms.CfnEndpoint.RedshiftSettingsProperty(
accept_any_date=False,
after_connect_script="afterConnectScript",
bucket_folder="bucketFolder",
bucket_name="bucketName",
case_sensitive_names=False,
comp_update=False,
connection_timeout=123,
date_format="dateFormat",
empty_as_null=False,
encryption_mode="encryptionMode",
explicit_ids=False,
file_transfer_upload_streams=123,
load_timeout=123,
map_boolean_as_boolean=False,
max_file_size=123,
remove_quotes=False,
replace_chars="replaceChars",
replace_invalid_chars="replaceInvalidChars",
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId",
server_side_encryption_kms_key_id="serverSideEncryptionKmsKeyId",
service_access_role_arn="serviceAccessRoleArn",
time_format="timeFormat",
trim_blanks=False,
truncate_columns=False,
write_buffer_size=123
),
resource_identifier="resourceIdentifier",
s3_settings=dms.CfnEndpoint.S3SettingsProperty(
add_column_name=False,
add_trailing_padding_character=False,
bucket_folder="bucketFolder",
bucket_name="bucketName",
canned_acl_for_objects="cannedAclForObjects",
cdc_inserts_and_updates=False,
cdc_inserts_only=False,
cdc_max_batch_interval=123,
cdc_min_file_size=123,
cdc_path="cdcPath",
compression_type="compressionType",
csv_delimiter="csvDelimiter",
csv_no_sup_value="csvNoSupValue",
csv_null_value="csvNullValue",
csv_row_delimiter="csvRowDelimiter",
data_format="dataFormat",
data_page_size=123,
date_partition_delimiter="datePartitionDelimiter",
date_partition_enabled=False,
date_partition_sequence="datePartitionSequence",
date_partition_timezone="datePartitionTimezone",
dict_page_size_limit=123,
enable_statistics=False,
encoding_type="encodingType",
encryption_mode="encryptionMode",
expected_bucket_owner="expectedBucketOwner",
external_table_definition="externalTableDefinition",
glue_catalog_generation=False,
ignore_header_rows=123,
include_op_for_full_load=False,
max_file_size=123,
parquet_timestamp_in_millisecond=False,
parquet_version="parquetVersion",
preserve_transactions=False,
rfc4180=False,
row_group_length=123,
server_side_encryption_kms_key_id="serverSideEncryptionKmsKeyId",
service_access_role_arn="serviceAccessRoleArn",
timestamp_column_name="timestampColumnName",
use_csv_no_sup_value=False,
use_task_start_time_for_full_load_timestamp=False
),
server_name="serverName",
ssl_mode="sslMode",
sybase_settings=dms.CfnEndpoint.SybaseSettingsProperty(
secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
secrets_manager_secret_id="secretsManagerSecretId"
),
tags=[CfnTag(
key="key",
value="value"
)],
username="username"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.dms.*;
CfnEndpoint cfnEndpoint = CfnEndpoint.Builder.create(this, "MyCfnEndpoint")
.endpointType("endpointType")
.engineName("engineName")
// the properties below are optional
.certificateArn("certificateArn")
.databaseName("databaseName")
.docDbSettings(DocDbSettingsProperty.builder()
.docsToInvestigate(123)
.extractDocId(false)
.nestingLevel("nestingLevel")
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.build())
.dynamoDbSettings(DynamoDbSettingsProperty.builder()
.serviceAccessRoleArn("serviceAccessRoleArn")
.build())
.elasticsearchSettings(ElasticsearchSettingsProperty.builder()
.endpointUri("endpointUri")
.errorRetryDuration(123)
.fullLoadErrorPercentage(123)
.serviceAccessRoleArn("serviceAccessRoleArn")
.build())
.endpointIdentifier("endpointIdentifier")
.extraConnectionAttributes("extraConnectionAttributes")
.gcpMySqlSettings(GcpMySQLSettingsProperty.builder()
.afterConnectScript("afterConnectScript")
.cleanSourceMetadataOnMismatch(false)
.databaseName("databaseName")
.eventsPollInterval(123)
.maxFileSize(123)
.parallelLoadThreads(123)
.password("password")
.port(123)
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.serverName("serverName")
.serverTimezone("serverTimezone")
.username("username")
.build())
.ibmDb2Settings(IbmDb2SettingsProperty.builder()
.currentLsn("currentLsn")
.keepCsvFiles(false)
.loadTimeout(123)
.maxFileSize(123)
.maxKBytesPerRead(123)
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.setDataCaptureChanges(false)
.writeBufferSize(123)
.build())
.kafkaSettings(KafkaSettingsProperty.builder()
.broker("broker")
.includeControlDetails(false)
.includeNullAndEmpty(false)
.includePartitionValue(false)
.includeTableAlterOperations(false)
.includeTransactionDetails(false)
.messageFormat("messageFormat")
.messageMaxBytes(123)
.noHexPrefix(false)
.partitionIncludeSchemaTable(false)
.saslPassword("saslPassword")
.saslUserName("saslUserName")
.securityProtocol("securityProtocol")
.sslCaCertificateArn("sslCaCertificateArn")
.sslClientCertificateArn("sslClientCertificateArn")
.sslClientKeyArn("sslClientKeyArn")
.sslClientKeyPassword("sslClientKeyPassword")
.topic("topic")
.build())
.kinesisSettings(KinesisSettingsProperty.builder()
.includeControlDetails(false)
.includeNullAndEmpty(false)
.includePartitionValue(false)
.includeTableAlterOperations(false)
.includeTransactionDetails(false)
.messageFormat("messageFormat")
.noHexPrefix(false)
.partitionIncludeSchemaTable(false)
.serviceAccessRoleArn("serviceAccessRoleArn")
.streamArn("streamArn")
.build())
.kmsKeyId("kmsKeyId")
.microsoftSqlServerSettings(MicrosoftSqlServerSettingsProperty.builder()
.bcpPacketSize(123)
.controlTablesFileGroup("controlTablesFileGroup")
.databaseName("databaseName")
.forceLobLookup(false)
.password("password")
.port(123)
.querySingleAlwaysOnNode(false)
.readBackupOnly(false)
.safeguardPolicy("safeguardPolicy")
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.serverName("serverName")
.tlogAccessMode("tlogAccessMode")
.trimSpaceInChar(false)
.useBcpFullLoad(false)
.username("username")
.useThirdPartyBackupDevice(false)
.build())
.mongoDbSettings(MongoDbSettingsProperty.builder()
.authMechanism("authMechanism")
.authSource("authSource")
.authType("authType")
.databaseName("databaseName")
.docsToInvestigate("docsToInvestigate")
.extractDocId("extractDocId")
.nestingLevel("nestingLevel")
.password("password")
.port(123)
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.serverName("serverName")
.username("username")
.build())
.mySqlSettings(MySqlSettingsProperty.builder()
.afterConnectScript("afterConnectScript")
.cleanSourceMetadataOnMismatch(false)
.eventsPollInterval(123)
.maxFileSize(123)
.parallelLoadThreads(123)
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.serverTimezone("serverTimezone")
.targetDbType("targetDbType")
.build())
.neptuneSettings(NeptuneSettingsProperty.builder()
.errorRetryDuration(123)
.iamAuthEnabled(false)
.maxFileSize(123)
.maxRetryCount(123)
.s3BucketFolder("s3BucketFolder")
.s3BucketName("s3BucketName")
.serviceAccessRoleArn("serviceAccessRoleArn")
.build())
.oracleSettings(OracleSettingsProperty.builder()
.accessAlternateDirectly(false)
.additionalArchivedLogDestId(123)
.addSupplementalLogging(false)
.allowSelectNestedTables(false)
.archivedLogDestId(123)
.archivedLogsOnly(false)
.asmPassword("asmPassword")
.asmServer("asmServer")
.asmUser("asmUser")
.charLengthSemantics("charLengthSemantics")
.directPathNoLog(false)
.directPathParallelLoad(false)
.enableHomogenousTablespace(false)
.extraArchivedLogDestIds(List.of(123))
.failTasksOnLobTruncation(false)
.numberDatatypeScale(123)
.oraclePathPrefix("oraclePathPrefix")
.parallelAsmReadThreads(123)
.readAheadBlocks(123)
.readTableSpaceName(false)
.replacePathPrefix(false)
.retryInterval(123)
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerOracleAsmAccessRoleArn("secretsManagerOracleAsmAccessRoleArn")
.secretsManagerOracleAsmSecretId("secretsManagerOracleAsmSecretId")
.secretsManagerSecretId("secretsManagerSecretId")
.securityDbEncryption("securityDbEncryption")
.securityDbEncryptionName("securityDbEncryptionName")
.spatialDataOptionToGeoJsonFunctionName("spatialDataOptionToGeoJsonFunctionName")
.standbyDelayTime(123)
.useAlternateFolderForOnline(false)
.useBFile(false)
.useDirectPathFullLoad(false)
.useLogminerReader(false)
.usePathPrefix("usePathPrefix")
.build())
.password("password")
.port(123)
.postgreSqlSettings(PostgreSqlSettingsProperty.builder()
.afterConnectScript("afterConnectScript")
.babelfishDatabaseName("babelfishDatabaseName")
.captureDdls(false)
.databaseMode("databaseMode")
.ddlArtifactsSchema("ddlArtifactsSchema")
.executeTimeout(123)
.failTasksOnLobTruncation(false)
.heartbeatEnable(false)
.heartbeatFrequency(123)
.heartbeatSchema("heartbeatSchema")
.mapBooleanAsBoolean(false)
.maxFileSize(123)
.pluginName("pluginName")
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.slotName("slotName")
.build())
.redisSettings(RedisSettingsProperty.builder()
.authPassword("authPassword")
.authType("authType")
.authUserName("authUserName")
.port(123)
.serverName("serverName")
.sslCaCertificateArn("sslCaCertificateArn")
.sslSecurityProtocol("sslSecurityProtocol")
.build())
.redshiftSettings(RedshiftSettingsProperty.builder()
.acceptAnyDate(false)
.afterConnectScript("afterConnectScript")
.bucketFolder("bucketFolder")
.bucketName("bucketName")
.caseSensitiveNames(false)
.compUpdate(false)
.connectionTimeout(123)
.dateFormat("dateFormat")
.emptyAsNull(false)
.encryptionMode("encryptionMode")
.explicitIds(false)
.fileTransferUploadStreams(123)
.loadTimeout(123)
.mapBooleanAsBoolean(false)
.maxFileSize(123)
.removeQuotes(false)
.replaceChars("replaceChars")
.replaceInvalidChars("replaceInvalidChars")
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.serverSideEncryptionKmsKeyId("serverSideEncryptionKmsKeyId")
.serviceAccessRoleArn("serviceAccessRoleArn")
.timeFormat("timeFormat")
.trimBlanks(false)
.truncateColumns(false)
.writeBufferSize(123)
.build())
.resourceIdentifier("resourceIdentifier")
.s3Settings(S3SettingsProperty.builder()
.addColumnName(false)
.addTrailingPaddingCharacter(false)
.bucketFolder("bucketFolder")
.bucketName("bucketName")
.cannedAclForObjects("cannedAclForObjects")
.cdcInsertsAndUpdates(false)
.cdcInsertsOnly(false)
.cdcMaxBatchInterval(123)
.cdcMinFileSize(123)
.cdcPath("cdcPath")
.compressionType("compressionType")
.csvDelimiter("csvDelimiter")
.csvNoSupValue("csvNoSupValue")
.csvNullValue("csvNullValue")
.csvRowDelimiter("csvRowDelimiter")
.dataFormat("dataFormat")
.dataPageSize(123)
.datePartitionDelimiter("datePartitionDelimiter")
.datePartitionEnabled(false)
.datePartitionSequence("datePartitionSequence")
.datePartitionTimezone("datePartitionTimezone")
.dictPageSizeLimit(123)
.enableStatistics(false)
.encodingType("encodingType")
.encryptionMode("encryptionMode")
.expectedBucketOwner("expectedBucketOwner")
.externalTableDefinition("externalTableDefinition")
.glueCatalogGeneration(false)
.ignoreHeaderRows(123)
.includeOpForFullLoad(false)
.maxFileSize(123)
.parquetTimestampInMillisecond(false)
.parquetVersion("parquetVersion")
.preserveTransactions(false)
.rfc4180(false)
.rowGroupLength(123)
.serverSideEncryptionKmsKeyId("serverSideEncryptionKmsKeyId")
.serviceAccessRoleArn("serviceAccessRoleArn")
.timestampColumnName("timestampColumnName")
.useCsvNoSupValue(false)
.useTaskStartTimeForFullLoadTimestamp(false)
.build())
.serverName("serverName")
.sslMode("sslMode")
.sybaseSettings(SybaseSettingsProperty.builder()
.secretsManagerAccessRoleArn("secretsManagerAccessRoleArn")
.secretsManagerSecretId("secretsManagerSecretId")
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.username("username")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var cfnEndpoint = new CfnEndpoint(this, "MyCfnEndpoint", new CfnEndpointProps {
EndpointType = "endpointType",
EngineName = "engineName",
// the properties below are optional
CertificateArn = "certificateArn",
DatabaseName = "databaseName",
DocDbSettings = new DocDbSettingsProperty {
DocsToInvestigate = 123,
ExtractDocId = false,
NestingLevel = "nestingLevel",
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId"
},
DynamoDbSettings = new DynamoDbSettingsProperty {
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
ElasticsearchSettings = new ElasticsearchSettingsProperty {
EndpointUri = "endpointUri",
ErrorRetryDuration = 123,
FullLoadErrorPercentage = 123,
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
EndpointIdentifier = "endpointIdentifier",
ExtraConnectionAttributes = "extraConnectionAttributes",
GcpMySqlSettings = new GcpMySQLSettingsProperty {
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"
},
IbmDb2Settings = new IbmDb2SettingsProperty {
CurrentLsn = "currentLsn",
KeepCsvFiles = false,
LoadTimeout = 123,
MaxFileSize = 123,
MaxKBytesPerRead = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
SetDataCaptureChanges = false,
WriteBufferSize = 123
},
KafkaSettings = new KafkaSettingsProperty {
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"
},
KinesisSettings = new KinesisSettingsProperty {
IncludeControlDetails = false,
IncludeNullAndEmpty = false,
IncludePartitionValue = false,
IncludeTableAlterOperations = false,
IncludeTransactionDetails = false,
MessageFormat = "messageFormat",
NoHexPrefix = false,
PartitionIncludeSchemaTable = false,
ServiceAccessRoleArn = "serviceAccessRoleArn",
StreamArn = "streamArn"
},
KmsKeyId = "kmsKeyId",
MicrosoftSqlServerSettings = new MicrosoftSqlServerSettingsProperty {
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
},
MongoDbSettings = new MongoDbSettingsProperty {
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"
},
MySqlSettings = new MySqlSettingsProperty {
AfterConnectScript = "afterConnectScript",
CleanSourceMetadataOnMismatch = false,
EventsPollInterval = 123,
MaxFileSize = 123,
ParallelLoadThreads = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId",
ServerTimezone = "serverTimezone",
TargetDbType = "targetDbType"
},
NeptuneSettings = new NeptuneSettingsProperty {
ErrorRetryDuration = 123,
IamAuthEnabled = false,
MaxFileSize = 123,
MaxRetryCount = 123,
S3BucketFolder = "s3BucketFolder",
S3BucketName = "s3BucketName",
ServiceAccessRoleArn = "serviceAccessRoleArn"
},
OracleSettings = new OracleSettingsProperty {
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 = new [] { 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"
},
Password = "password",
Port = 123,
PostgreSqlSettings = new PostgreSqlSettingsProperty {
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"
},
RedisSettings = new RedisSettingsProperty {
AuthPassword = "authPassword",
AuthType = "authType",
AuthUserName = "authUserName",
Port = 123,
ServerName = "serverName",
SslCaCertificateArn = "sslCaCertificateArn",
SslSecurityProtocol = "sslSecurityProtocol"
},
RedshiftSettings = new RedshiftSettingsProperty {
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
},
ResourceIdentifier = "resourceIdentifier",
S3Settings = new S3SettingsProperty {
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
},
ServerName = "serverName",
SslMode = "sslMode",
SybaseSettings = new SybaseSettingsProperty {
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerSecretId = "secretsManagerSecretId"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Username = "username"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEndpoint := awscdk.Aws_dms.NewCfnEndpoint(this, jsii.String("MyCfnEndpoint"), &CfnEndpointProps{
EndpointType: jsii.String("endpointType"),
EngineName: jsii.String("engineName"),
// the properties below are optional
CertificateArn: jsii.String("certificateArn"),
DatabaseName: jsii.String("databaseName"),
DocDbSettings: &DocDbSettingsProperty{
DocsToInvestigate: jsii.Number(123),
ExtractDocId: jsii.Boolean(false),
NestingLevel: jsii.String("nestingLevel"),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
},
DynamoDbSettings: &DynamoDbSettingsProperty{
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
},
ElasticsearchSettings: &ElasticsearchSettingsProperty{
EndpointUri: jsii.String("endpointUri"),
ErrorRetryDuration: jsii.Number(123),
FullLoadErrorPercentage: jsii.Number(123),
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
},
EndpointIdentifier: jsii.String("endpointIdentifier"),
ExtraConnectionAttributes: jsii.String("extraConnectionAttributes"),
GcpMySqlSettings: &GcpMySQLSettingsProperty{
AfterConnectScript: jsii.String("afterConnectScript"),
CleanSourceMetadataOnMismatch: jsii.Boolean(false),
DatabaseName: jsii.String("databaseName"),
EventsPollInterval: jsii.Number(123),
MaxFileSize: jsii.Number(123),
ParallelLoadThreads: jsii.Number(123),
Password: jsii.String("password"),
Port: jsii.Number(123),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
ServerName: jsii.String("serverName"),
ServerTimezone: jsii.String("serverTimezone"),
Username: jsii.String("username"),
},
IbmDb2Settings: &IbmDb2SettingsProperty{
CurrentLsn: jsii.String("currentLsn"),
KeepCsvFiles: jsii.Boolean(false),
LoadTimeout: jsii.Number(123),
MaxFileSize: jsii.Number(123),
MaxKBytesPerRead: jsii.Number(123),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
SetDataCaptureChanges: jsii.Boolean(false),
WriteBufferSize: jsii.Number(123),
},
KafkaSettings: &KafkaSettingsProperty{
Broker: jsii.String("broker"),
IncludeControlDetails: jsii.Boolean(false),
IncludeNullAndEmpty: jsii.Boolean(false),
IncludePartitionValue: jsii.Boolean(false),
IncludeTableAlterOperations: jsii.Boolean(false),
IncludeTransactionDetails: jsii.Boolean(false),
MessageFormat: jsii.String("messageFormat"),
MessageMaxBytes: jsii.Number(123),
NoHexPrefix: jsii.Boolean(false),
PartitionIncludeSchemaTable: jsii.Boolean(false),
SaslPassword: jsii.String("saslPassword"),
SaslUserName: jsii.String("saslUserName"),
SecurityProtocol: jsii.String("securityProtocol"),
SslCaCertificateArn: jsii.String("sslCaCertificateArn"),
SslClientCertificateArn: jsii.String("sslClientCertificateArn"),
SslClientKeyArn: jsii.String("sslClientKeyArn"),
SslClientKeyPassword: jsii.String("sslClientKeyPassword"),
Topic: jsii.String("topic"),
},
KinesisSettings: &KinesisSettingsProperty{
IncludeControlDetails: jsii.Boolean(false),
IncludeNullAndEmpty: jsii.Boolean(false),
IncludePartitionValue: jsii.Boolean(false),
IncludeTableAlterOperations: jsii.Boolean(false),
IncludeTransactionDetails: jsii.Boolean(false),
MessageFormat: jsii.String("messageFormat"),
NoHexPrefix: jsii.Boolean(false),
PartitionIncludeSchemaTable: jsii.Boolean(false),
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
StreamArn: jsii.String("streamArn"),
},
KmsKeyId: jsii.String("kmsKeyId"),
MicrosoftSqlServerSettings: &MicrosoftSqlServerSettingsProperty{
BcpPacketSize: jsii.Number(123),
ControlTablesFileGroup: jsii.String("controlTablesFileGroup"),
DatabaseName: jsii.String("databaseName"),
ForceLobLookup: jsii.Boolean(false),
Password: jsii.String("password"),
Port: jsii.Number(123),
QuerySingleAlwaysOnNode: jsii.Boolean(false),
ReadBackupOnly: jsii.Boolean(false),
SafeguardPolicy: jsii.String("safeguardPolicy"),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
ServerName: jsii.String("serverName"),
TlogAccessMode: jsii.String("tlogAccessMode"),
TrimSpaceInChar: jsii.Boolean(false),
UseBcpFullLoad: jsii.Boolean(false),
Username: jsii.String("username"),
UseThirdPartyBackupDevice: jsii.Boolean(false),
},
MongoDbSettings: &MongoDbSettingsProperty{
AuthMechanism: jsii.String("authMechanism"),
AuthSource: jsii.String("authSource"),
AuthType: jsii.String("authType"),
DatabaseName: jsii.String("databaseName"),
DocsToInvestigate: jsii.String("docsToInvestigate"),
ExtractDocId: jsii.String("extractDocId"),
NestingLevel: jsii.String("nestingLevel"),
Password: jsii.String("password"),
Port: jsii.Number(123),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
ServerName: jsii.String("serverName"),
Username: jsii.String("username"),
},
MySqlSettings: &MySqlSettingsProperty{
AfterConnectScript: jsii.String("afterConnectScript"),
CleanSourceMetadataOnMismatch: jsii.Boolean(false),
EventsPollInterval: jsii.Number(123),
MaxFileSize: jsii.Number(123),
ParallelLoadThreads: jsii.Number(123),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
ServerTimezone: jsii.String("serverTimezone"),
TargetDbType: jsii.String("targetDbType"),
},
NeptuneSettings: &NeptuneSettingsProperty{
ErrorRetryDuration: jsii.Number(123),
IamAuthEnabled: jsii.Boolean(false),
MaxFileSize: jsii.Number(123),
MaxRetryCount: jsii.Number(123),
S3BucketFolder: jsii.String("s3BucketFolder"),
S3BucketName: jsii.String("s3BucketName"),
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
},
OracleSettings: &OracleSettingsProperty{
AccessAlternateDirectly: jsii.Boolean(false),
AdditionalArchivedLogDestId: jsii.Number(123),
AddSupplementalLogging: jsii.Boolean(false),
AllowSelectNestedTables: jsii.Boolean(false),
ArchivedLogDestId: jsii.Number(123),
ArchivedLogsOnly: jsii.Boolean(false),
AsmPassword: jsii.String("asmPassword"),
AsmServer: jsii.String("asmServer"),
AsmUser: jsii.String("asmUser"),
CharLengthSemantics: jsii.String("charLengthSemantics"),
DirectPathNoLog: jsii.Boolean(false),
DirectPathParallelLoad: jsii.Boolean(false),
EnableHomogenousTablespace: jsii.Boolean(false),
ExtraArchivedLogDestIds: []interface{}{
jsii.Number(123),
},
FailTasksOnLobTruncation: jsii.Boolean(false),
NumberDatatypeScale: jsii.Number(123),
OraclePathPrefix: jsii.String("oraclePathPrefix"),
ParallelAsmReadThreads: jsii.Number(123),
ReadAheadBlocks: jsii.Number(123),
ReadTableSpaceName: jsii.Boolean(false),
ReplacePathPrefix: jsii.Boolean(false),
RetryInterval: jsii.Number(123),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerOracleAsmAccessRoleArn: jsii.String("secretsManagerOracleAsmAccessRoleArn"),
SecretsManagerOracleAsmSecretId: jsii.String("secretsManagerOracleAsmSecretId"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
SecurityDbEncryption: jsii.String("securityDbEncryption"),
SecurityDbEncryptionName: jsii.String("securityDbEncryptionName"),
SpatialDataOptionToGeoJsonFunctionName: jsii.String("spatialDataOptionToGeoJsonFunctionName"),
StandbyDelayTime: jsii.Number(123),
UseAlternateFolderForOnline: jsii.Boolean(false),
UseBFile: jsii.Boolean(false),
UseDirectPathFullLoad: jsii.Boolean(false),
UseLogminerReader: jsii.Boolean(false),
UsePathPrefix: jsii.String("usePathPrefix"),
},
Password: jsii.String("password"),
Port: jsii.Number(123),
PostgreSqlSettings: &PostgreSqlSettingsProperty{
AfterConnectScript: jsii.String("afterConnectScript"),
BabelfishDatabaseName: jsii.String("babelfishDatabaseName"),
CaptureDdls: jsii.Boolean(false),
DatabaseMode: jsii.String("databaseMode"),
DdlArtifactsSchema: jsii.String("ddlArtifactsSchema"),
ExecuteTimeout: jsii.Number(123),
FailTasksOnLobTruncation: jsii.Boolean(false),
HeartbeatEnable: jsii.Boolean(false),
HeartbeatFrequency: jsii.Number(123),
HeartbeatSchema: jsii.String("heartbeatSchema"),
MapBooleanAsBoolean: jsii.Boolean(false),
MaxFileSize: jsii.Number(123),
PluginName: jsii.String("pluginName"),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
SlotName: jsii.String("slotName"),
},
RedisSettings: &RedisSettingsProperty{
AuthPassword: jsii.String("authPassword"),
AuthType: jsii.String("authType"),
AuthUserName: jsii.String("authUserName"),
Port: jsii.Number(123),
ServerName: jsii.String("serverName"),
SslCaCertificateArn: jsii.String("sslCaCertificateArn"),
SslSecurityProtocol: jsii.String("sslSecurityProtocol"),
},
RedshiftSettings: &RedshiftSettingsProperty{
AcceptAnyDate: jsii.Boolean(false),
AfterConnectScript: jsii.String("afterConnectScript"),
BucketFolder: jsii.String("bucketFolder"),
BucketName: jsii.String("bucketName"),
CaseSensitiveNames: jsii.Boolean(false),
CompUpdate: jsii.Boolean(false),
ConnectionTimeout: jsii.Number(123),
DateFormat: jsii.String("dateFormat"),
EmptyAsNull: jsii.Boolean(false),
EncryptionMode: jsii.String("encryptionMode"),
ExplicitIds: jsii.Boolean(false),
FileTransferUploadStreams: jsii.Number(123),
LoadTimeout: jsii.Number(123),
MapBooleanAsBoolean: jsii.Boolean(false),
MaxFileSize: jsii.Number(123),
RemoveQuotes: jsii.Boolean(false),
ReplaceChars: jsii.String("replaceChars"),
ReplaceInvalidChars: jsii.String("replaceInvalidChars"),
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"),
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
TimeFormat: jsii.String("timeFormat"),
TrimBlanks: jsii.Boolean(false),
TruncateColumns: jsii.Boolean(false),
WriteBufferSize: jsii.Number(123),
},
ResourceIdentifier: jsii.String("resourceIdentifier"),
S3Settings: &S3SettingsProperty{
AddColumnName: jsii.Boolean(false),
AddTrailingPaddingCharacter: jsii.Boolean(false),
BucketFolder: jsii.String("bucketFolder"),
BucketName: jsii.String("bucketName"),
CannedAclForObjects: jsii.String("cannedAclForObjects"),
CdcInsertsAndUpdates: jsii.Boolean(false),
CdcInsertsOnly: jsii.Boolean(false),
CdcMaxBatchInterval: jsii.Number(123),
CdcMinFileSize: jsii.Number(123),
CdcPath: jsii.String("cdcPath"),
CompressionType: jsii.String("compressionType"),
CsvDelimiter: jsii.String("csvDelimiter"),
CsvNoSupValue: jsii.String("csvNoSupValue"),
CsvNullValue: jsii.String("csvNullValue"),
CsvRowDelimiter: jsii.String("csvRowDelimiter"),
DataFormat: jsii.String("dataFormat"),
DataPageSize: jsii.Number(123),
DatePartitionDelimiter: jsii.String("datePartitionDelimiter"),
DatePartitionEnabled: jsii.Boolean(false),
DatePartitionSequence: jsii.String("datePartitionSequence"),
DatePartitionTimezone: jsii.String("datePartitionTimezone"),
DictPageSizeLimit: jsii.Number(123),
EnableStatistics: jsii.Boolean(false),
EncodingType: jsii.String("encodingType"),
EncryptionMode: jsii.String("encryptionMode"),
ExpectedBucketOwner: jsii.String("expectedBucketOwner"),
ExternalTableDefinition: jsii.String("externalTableDefinition"),
GlueCatalogGeneration: jsii.Boolean(false),
IgnoreHeaderRows: jsii.Number(123),
IncludeOpForFullLoad: jsii.Boolean(false),
MaxFileSize: jsii.Number(123),
ParquetTimestampInMillisecond: jsii.Boolean(false),
ParquetVersion: jsii.String("parquetVersion"),
PreserveTransactions: jsii.Boolean(false),
Rfc4180: jsii.Boolean(false),
RowGroupLength: jsii.Number(123),
ServerSideEncryptionKmsKeyId: jsii.String("serverSideEncryptionKmsKeyId"),
ServiceAccessRoleArn: jsii.String("serviceAccessRoleArn"),
TimestampColumnName: jsii.String("timestampColumnName"),
UseCsvNoSupValue: jsii.Boolean(false),
UseTaskStartTimeForFullLoadTimestamp: jsii.Boolean(false),
},
ServerName: jsii.String("serverName"),
SslMode: jsii.String("sslMode"),
SybaseSettings: &SybaseSettingsProperty{
SecretsManagerAccessRoleArn: jsii.String("secretsManagerAccessRoleArn"),
SecretsManagerSecretId: jsii.String("secretsManagerSecretId"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Username: jsii.String("username"),
})
Initializer
ts
new CfnEndpoint(scope: Construct, id: string, props: CfnEndpointProps)
python
CfnEndpoint(scope: Construct, id: str, props: CfnEndpointProps)
java
new CfnEndpoint(Construct scope, String id, CfnEndpointProps props)
csharp
new CfnEndpoint(Construct scope, string id, CfnEndpointProps props)
go
NewCfnEndpoint(Scope Construct, Id *string, Props CfnEndpointProps)
Construct Props
certificateArnoptionalstringcertificate_arnoptionalstrcertificateArnoptionalStringCertificateArnoptionalstringCertificateArnoptional*string#The Amazon Resource Name (ARN) for the certificate.
databaseNameoptionalstringdatabase_nameoptionalstrdatabaseNameoptionalStringDatabaseNameoptionalstringDatabaseNameoptional*string#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 .
docDbSettingsoptionalIResolvable | CfnEndpoint.DocDbSettingsPropertydoc_db_settingsoptionaltyping.Union[IResolvable, DocDbSettingsProperty]docDbSettingsoptionalIResolvableDocDbSettingsoptionalIResolvableDocDbSettingsoptionalinterface{}#Settings in JSON format for the source and target DocumentDB endpoint.
notes
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 .
dynamoDbSettingsoptionalIResolvable | CfnEndpoint.DynamoDbSettingsPropertydynamo_db_settingsoptionaltyping.Union[IResolvable, DynamoDbSettingsProperty]dynamoDbSettingsoptionalIResolvableDynamoDbSettingsoptionalIResolvableDynamoDbSettingsoptionalinterface{}#Settings in JSON format for the target Amazon DynamoDB endpoint.
notes
For information about other available settings, see Using object mapping to migrate data to DynamoDB in the AWS Database Migration Service User Guide .
elasticsearchSettingsoptionalIResolvable | CfnEndpoint.ElasticsearchSettingsPropertyelasticsearch_settingsoptionaltyping.Union[IResolvable, ElasticsearchSettingsProperty]elasticsearchSettingsoptionalIResolvableElasticsearchSettingsoptionalIResolvableElasticsearchSettingsoptionalinterface{}#Settings in JSON format for the target OpenSearch endpoint.
notes
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 .
endpointIdentifieroptionalstringendpoint_identifieroptionalstrendpointIdentifieroptionalStringEndpointIdentifieroptionalstringEndpointIdentifieroptional*string#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.
The type of endpoint.
Valid values are source and target .
The type of engine for the endpoint, depending on the `EndpointType` value.
notes
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
extraConnectionAttributesoptionalstringextra_connection_attributesoptionalstrextraConnectionAttributesoptionalStringExtraConnectionAttributesoptionalstringExtraConnectionAttributesoptional*string#Additional attributes associated with the connection.
notes
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 .
gcpMySqlSettingsoptionalIResolvable | CfnEndpoint.GcpMySQLSettingsPropertygcp_my_sql_settingsoptionaltyping.Union[IResolvable, GcpMySQLSettingsProperty]gcpMySqlSettingsoptionalIResolvableGcpMySqlSettingsoptionalIResolvableGcpMySqlSettingsoptionalinterface{}#Settings in JSON format for the source GCP MySQL endpoint.
notes
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 .
ibmDb2SettingsoptionalIResolvable | CfnEndpoint.IbmDb2SettingsPropertyibm_db2_settingsoptionaltyping.Union[IResolvable, IbmDb2SettingsProperty]ibmDb2SettingsoptionalIResolvableIbmDb2SettingsoptionalIResolvableIbmDb2Settingsoptionalinterface{}#Settings in JSON format for the source IBM Db2 LUW endpoint.
notes
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 .
kafkaSettingsoptionalIResolvable | CfnEndpoint.KafkaSettingsPropertykafka_settingsoptionaltyping.Union[IResolvable, KafkaSettingsProperty]kafkaSettingsoptionalIResolvableKafkaSettingsoptionalIResolvableKafkaSettingsoptionalinterface{}#Settings in JSON format for the target Apache Kafka endpoint.
notes
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 .
kinesisSettingsoptionalIResolvable | CfnEndpoint.KinesisSettingsPropertykinesis_settingsoptionaltyping.Union[IResolvable, KinesisSettingsProperty]kinesisSettingsoptionalIResolvableKinesisSettingsoptionalIResolvableKinesisSettingsoptionalinterface{}#Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
notes
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 .
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#An AWS key identifier that is used to encrypt the connection parameters for the endpoint.
notes
If you don't specify a value for the KmsKeyId parameter, AWS DMS uses your default encryption key.
AWS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .
microsoftSqlServerSettingsoptionalIResolvable | CfnEndpoint.MicrosoftSqlServerSettingsPropertymicrosoft_sql_server_settingsoptionaltyping.Union[IResolvable, MicrosoftSqlServerSettingsProperty]microsoftSqlServerSettingsoptionalIResolvableMicrosoftSqlServerSettingsoptionalIResolvableMicrosoftSqlServerSettingsoptionalinterface{}#Settings in JSON format for the source and target Microsoft SQL Server endpoint.
notes
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 .
mongoDbSettingsoptionalIResolvable | CfnEndpoint.MongoDbSettingsPropertymongo_db_settingsoptionaltyping.Union[IResolvable, MongoDbSettingsProperty]mongoDbSettingsoptionalIResolvableMongoDbSettingsoptionalIResolvableMongoDbSettingsoptionalinterface{}#Settings in JSON format for the source MongoDB endpoint.
notes
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 .
mySqlSettingsoptionalIResolvable | CfnEndpoint.MySqlSettingsPropertymy_sql_settingsoptionaltyping.Union[IResolvable, MySqlSettingsProperty]mySqlSettingsoptionalIResolvableMySqlSettingsoptionalIResolvableMySqlSettingsoptionalinterface{}#Settings in JSON format for the source and target MySQL endpoint.
notes
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 .
neptuneSettingsoptionalIResolvable | CfnEndpoint.NeptuneSettingsPropertyneptune_settingsoptionaltyping.Union[IResolvable, NeptuneSettingsProperty]neptuneSettingsoptionalIResolvableNeptuneSettingsoptionalIResolvableNeptuneSettingsoptionalinterface{}#Settings in JSON format for the target Amazon Neptune endpoint.
notes
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 .
oracleSettingsoptionalIResolvable | CfnEndpoint.OracleSettingsPropertyoracle_settingsoptionaltyping.Union[IResolvable, OracleSettingsProperty]oracleSettingsoptionalIResolvableOracleSettingsoptionalIResolvableOracleSettingsoptionalinterface{}#Settings in JSON format for the source and target Oracle endpoint.
notes
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 .
passwordoptionalstringpasswordoptionalstrpasswordoptionalStringPasswordoptionalstringPasswordoptional*string#The password to be used to log in to the endpoint database.
The port used by the endpoint database.
postgreSqlSettingsoptionalIResolvable | CfnEndpoint.PostgreSqlSettingsPropertypostgre_sql_settingsoptionaltyping.Union[IResolvable, PostgreSqlSettingsProperty]postgreSqlSettingsoptionalIResolvablePostgreSqlSettingsoptionalIResolvablePostgreSqlSettingsoptionalinterface{}#Settings in JSON format for the source and target PostgreSQL endpoint.
notes
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 .
redisSettingsoptionalIResolvable | CfnEndpoint.RedisSettingsPropertyredis_settingsoptionaltyping.Union[IResolvable, RedisSettingsProperty]redisSettingsoptionalIResolvableRedisSettingsoptionalIResolvableRedisSettingsoptionalinterface{}#Settings in JSON format for the target Redis endpoint.
notes
For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .
redshiftSettingsoptionalIResolvable | CfnEndpoint.RedshiftSettingsPropertyredshift_settingsoptionaltyping.Union[IResolvable, RedshiftSettingsProperty]redshiftSettingsoptionalIResolvableRedshiftSettingsoptionalIResolvableRedshiftSettingsoptionalinterface{}#Settings in JSON format for the Amazon Redshift endpoint.
notes
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 .
resourceIdentifieroptionalstringresource_identifieroptionalstrresourceIdentifieroptionalStringResourceIdentifieroptionalstringResourceIdentifieroptional*string#A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
notes
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 .
s3SettingsoptionalIResolvable | CfnEndpoint.S3SettingsPropertys3_settingsoptionaltyping.Union[IResolvable, S3SettingsProperty]s3SettingsoptionalIResolvableS3SettingsoptionalIResolvableS3Settingsoptionalinterface{}#Settings in JSON format for the source and target Amazon S3 endpoint.
notes
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 .
serverNameoptionalstringserver_nameoptionalstrserverNameoptionalStringServerNameoptionalstringServerNameoptional*string#The name of the server where the endpoint database resides.
sslModeoptionalstringssl_modeoptionalstrsslModeoptionalStringSslModeoptionalstringSslModeoptional*string#The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is `none` .
When
engine_nameis set to S3, the only allowed value isnone.
sybaseSettingsoptionalIResolvable | CfnEndpoint.SybaseSettingsPropertysybase_settingsoptionaltyping.Union[IResolvable, SybaseSettingsProperty]sybaseSettingsoptionalIResolvableSybaseSettingsoptionalIResolvableSybaseSettingsoptionalinterface{}#Settings in JSON format for the source and target SAP ASE endpoint.
notes
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 .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#One or more tags to be assigned to the endpoint.
usernameoptionalstringusernameoptionalstrusernameoptionalStringUsernameoptionalstringUsernameoptional*string#The user name to be used to log in to the endpoint database.
Properties
attrEndpointArnstringattr_endpoint_arnstrattrEndpointArnStringAttrEndpointArnstringAttrEndpointArn*stringrequired#The endpoint ARN.
attrExternalIdstringattr_external_idstrattrExternalIdStringAttrExternalIdstringAttrExternalId*stringrequired#A value that can be used for cross-account validation.
certificateArnmay be undefinedstringcertificate_arnmay be undefinedstrcertificateArnmay be undefinedStringCertificateArnmay be undefinedstringCertificateArnmay be undefined*string#The Amazon Resource Name (ARN) for the certificate.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#databaseNamemay be undefinedstringdatabase_namemay be undefinedstrdatabaseNamemay be undefinedStringDatabaseNamemay be undefinedstringDatabaseNamemay be undefined*string#The name of the endpoint database.
docDbSettingsmay be undefinedIResolvable | CfnEndpoint.DocDbSettingsPropertydoc_db_settingsmay be undefinedtyping.Union[IResolvable, DocDbSettingsProperty]docDbSettingsmay be undefinedIResolvableDocDbSettingsmay be undefinedIResolvableDocDbSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target DocumentDB endpoint.
dynamoDbSettingsmay be undefinedIResolvable | CfnEndpoint.DynamoDbSettingsPropertydynamo_db_settingsmay be undefinedtyping.Union[IResolvable, DynamoDbSettingsProperty]dynamoDbSettingsmay be undefinedIResolvableDynamoDbSettingsmay be undefinedIResolvableDynamoDbSettingsmay be undefinedinterface{}#Settings in JSON format for the target Amazon DynamoDB endpoint.
elasticsearchSettingsmay be undefinedIResolvable | CfnEndpoint.ElasticsearchSettingsPropertyelasticsearch_settingsmay be undefinedtyping.Union[IResolvable, ElasticsearchSettingsProperty]elasticsearchSettingsmay be undefinedIResolvableElasticsearchSettingsmay be undefinedIResolvableElasticsearchSettingsmay be undefinedinterface{}#Settings in JSON format for the target OpenSearch endpoint.
endpointIdentifiermay be undefinedstringendpoint_identifiermay be undefinedstrendpointIdentifiermay be undefinedStringEndpointIdentifiermay be undefinedstringEndpointIdentifiermay be undefined*string#The database endpoint identifier.
endpointRefEndpointReferenceendpoint_refEndpointReferenceendpointRefEndpointReferenceEndpointRefEndpointReferenceEndpointRefEndpointReferencerequired#A reference to a Endpoint resource.
The type of endpoint.
The type of engine for the endpoint, depending on the `EndpointType` value.
extraConnectionAttributesmay be undefinedstringextra_connection_attributesmay be undefinedstrextraConnectionAttributesmay be undefinedStringExtraConnectionAttributesmay be undefinedstringExtraConnectionAttributesmay be undefined*string#Additional attributes associated with the connection.
gcpMySqlSettingsmay be undefinedIResolvable | CfnEndpoint.GcpMySQLSettingsPropertygcp_my_sql_settingsmay be undefinedtyping.Union[IResolvable, GcpMySQLSettingsProperty]gcpMySqlSettingsmay be undefinedIResolvableGcpMySqlSettingsmay be undefinedIResolvableGcpMySqlSettingsmay be undefinedinterface{}#Settings in JSON format for the source GCP MySQL endpoint.
ibmDb2Settingsmay be undefinedIResolvable | CfnEndpoint.IbmDb2SettingsPropertyibm_db2_settingsmay be undefinedtyping.Union[IResolvable, IbmDb2SettingsProperty]ibmDb2Settingsmay be undefinedIResolvableIbmDb2Settingsmay be undefinedIResolvableIbmDb2Settingsmay be undefinedinterface{}#Settings in JSON format for the source IBM Db2 LUW endpoint.
kafkaSettingsmay be undefinedIResolvable | CfnEndpoint.KafkaSettingsPropertykafka_settingsmay be undefinedtyping.Union[IResolvable, KafkaSettingsProperty]kafkaSettingsmay be undefinedIResolvableKafkaSettingsmay be undefinedIResolvableKafkaSettingsmay be undefinedinterface{}#Settings in JSON format for the target Apache Kafka endpoint.
kinesisSettingsmay be undefinedIResolvable | CfnEndpoint.KinesisSettingsPropertykinesis_settingsmay be undefinedtyping.Union[IResolvable, KinesisSettingsProperty]kinesisSettingsmay be undefinedIResolvableKinesisSettingsmay be undefinedIResolvableKinesisSettingsmay be undefinedinterface{}#Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams.
kmsKeyIdmay be undefinedstringkms_key_idmay be undefinedstrkmsKeyIdmay be undefinedStringKmsKeyIdmay be undefinedstringKmsKeyIdmay be undefined*string#An AWS key identifier that is used to encrypt the connection parameters for the endpoint.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
microsoftSqlServerSettingsmay be undefinedIResolvable | CfnEndpoint.MicrosoftSqlServerSettingsPropertymicrosoft_sql_server_settingsmay be undefinedtyping.Union[IResolvable, MicrosoftSqlServerSettingsProperty]microsoftSqlServerSettingsmay be undefinedIResolvableMicrosoftSqlServerSettingsmay be undefinedIResolvableMicrosoftSqlServerSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target Microsoft SQL Server endpoint.
mongoDbSettingsmay be undefinedIResolvable | CfnEndpoint.MongoDbSettingsPropertymongo_db_settingsmay be undefinedtyping.Union[IResolvable, MongoDbSettingsProperty]mongoDbSettingsmay be undefinedIResolvableMongoDbSettingsmay be undefinedIResolvableMongoDbSettingsmay be undefinedinterface{}#Settings in JSON format for the source MongoDB endpoint.
mySqlSettingsmay be undefinedIResolvable | CfnEndpoint.MySqlSettingsPropertymy_sql_settingsmay be undefinedtyping.Union[IResolvable, MySqlSettingsProperty]mySqlSettingsmay be undefinedIResolvableMySqlSettingsmay be undefinedIResolvableMySqlSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target MySQL endpoint.
neptuneSettingsmay be undefinedIResolvable | CfnEndpoint.NeptuneSettingsPropertyneptune_settingsmay be undefinedtyping.Union[IResolvable, NeptuneSettingsProperty]neptuneSettingsmay be undefinedIResolvableNeptuneSettingsmay be undefinedIResolvableNeptuneSettingsmay be undefinedinterface{}#Settings in JSON format for the target Amazon Neptune endpoint.
oracleSettingsmay be undefinedIResolvable | CfnEndpoint.OracleSettingsPropertyoracle_settingsmay be undefinedtyping.Union[IResolvable, OracleSettingsProperty]oracleSettingsmay be undefinedIResolvableOracleSettingsmay be undefinedIResolvableOracleSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target Oracle endpoint.
passwordmay be undefinedstringpasswordmay be undefinedstrpasswordmay be undefinedStringPasswordmay be undefinedstringPasswordmay be undefined*string#The password to be used to log in to the endpoint database.
portmay be undefinednumberportmay be undefinedint | floatportmay be undefinedNumberPortmay be undefineddoublePortmay be undefined*float64#The port used by the endpoint database.
postgreSqlSettingsmay be undefinedIResolvable | CfnEndpoint.PostgreSqlSettingsPropertypostgre_sql_settingsmay be undefinedtyping.Union[IResolvable, PostgreSqlSettingsProperty]postgreSqlSettingsmay be undefinedIResolvablePostgreSqlSettingsmay be undefinedIResolvablePostgreSqlSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target PostgreSQL endpoint.
redisSettingsmay be undefinedIResolvable | CfnEndpoint.RedisSettingsPropertyredis_settingsmay be undefinedtyping.Union[IResolvable, RedisSettingsProperty]redisSettingsmay be undefinedIResolvableRedisSettingsmay be undefinedIResolvableRedisSettingsmay be undefinedinterface{}#Settings in JSON format for the target Redis endpoint.
redshiftSettingsmay be undefinedIResolvable | CfnEndpoint.RedshiftSettingsPropertyredshift_settingsmay be undefinedtyping.Union[IResolvable, RedshiftSettingsProperty]redshiftSettingsmay be undefinedIResolvableRedshiftSettingsmay be undefinedIResolvableRedshiftSettingsmay be undefinedinterface{}#Settings in JSON format for the Amazon Redshift endpoint.
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
resourceIdentifiermay be undefinedstringresource_identifiermay be undefinedstrresourceIdentifiermay be undefinedStringResourceIdentifiermay be undefinedstringResourceIdentifiermay be undefined*string#A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object.
s3Settingsmay be undefinedIResolvable | CfnEndpoint.S3SettingsPropertys3_settingsmay be undefinedtyping.Union[IResolvable, S3SettingsProperty]s3Settingsmay be undefinedIResolvableS3Settingsmay be undefinedIResolvableS3Settingsmay be undefinedinterface{}#Settings in JSON format for the source and target Amazon S3 endpoint.
serverNamemay be undefinedstringserver_namemay be undefinedstrserverNamemay be undefinedStringServerNamemay be undefinedstringServerNamemay be undefined*string#The name of the server where the endpoint database resides.
sslModemay be undefinedstringssl_modemay be undefinedstrsslModemay be undefinedStringSslModemay be undefinedstringSslModemay be undefined*string#The Secure Sockets Layer (SSL) mode to use for the SSL connection.
The default is none .
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
sybaseSettingsmay be undefinedIResolvable | CfnEndpoint.SybaseSettingsPropertysybase_settingsmay be undefinedtyping.Union[IResolvable, SybaseSettingsProperty]sybaseSettingsmay be undefinedIResolvableSybaseSettingsmay be undefinedIResolvableSybaseSettingsmay be undefinedinterface{}#Settings in JSON format for the source and target SAP ASE endpoint.
Tag Manager which manages the tags for this resource.
tagsRawmay be undefinedCfnTag[]tags_rawmay be undefinedtyping.List[CfnTag]tagsRawmay be undefinedList<CfnTag>TagsRawmay be undefinedCfnTag[]TagsRawmay be undefined*[]CfnTag#One or more tags to be assigned to the endpoint.
usernamemay be undefinedstringusernamemay be undefinedstrusernamemay be undefinedStringUsernamemay be undefinedstringUsernamemay be undefined*string#The user name to be used to log in to the endpoint database.
Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#Syntactic sugar for `addOverride(path, undefined)`.
1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#Use `addResourceDependency` instead.
This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#Use `addResourceDependency` instead.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
json
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#Adds an override that deletes the value of a property from the resource definition.
1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#Sets the deletion policy of the resource based on the removal policy specified.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
arnForEndpoint(resource: IEndpointRef): string@staticmethod def arn_for_endpoint(resource: IEndpointRef) -> strpublic static String arnForEndpoint(IEndpointRef resource)public static string ArnForEndpoint(IEndpointRef resource)func ArnForEndpoint(Resource IEndpointRef) *stringstatic#cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#Examines the CloudFormation resource and discloses attributes.
1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnEndpoint(x: any): boolean@staticmethod def is_cfn_endpoint(x: Any) -> boolpublic static Boolean isCfnEndpoint(Object x)public static bool IsCfnEndpoint(object x)func IsCfnEndpoint(X interface{}) *boolstatic#Checks whether the given object is a CfnEndpoint.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#Overrides the auto-generated logical ID with a specific ID.
1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#Use `removeResourceDependency` instead
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#Replaces one dependency with another.
2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.