CfnEndpointProps

class aws_cdk.aws_dms.CfnEndpointProps(*, endpoint_type, engine_name, certificate_arn=None, database_name=None, doc_db_settings=None, dynamo_db_settings=None, elasticsearch_settings=None, endpoint_identifier=None, extra_connection_attributes=None, gcp_my_sql_settings=None, ibm_db2_settings=None, kafka_settings=None, kinesis_settings=None, kms_key_id=None, microsoft_sql_server_settings=None, mongo_db_settings=None, my_sql_settings=None, neptune_settings=None, oracle_settings=None, password=None, port=None, postgre_sql_settings=None, redis_settings=None, redshift_settings=None, resource_identifier=None, s3_settings=None, server_name=None, ssl_mode=None, sybase_settings=None, tags=None, username=None)

Bases: object

Properties for defining a CfnEndpoint.

Parameters:
Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_dms as dms

cfn_endpoint_props = dms.CfnEndpointProps(
    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",
        max_kBytes_per_read=123,
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId",
        set_data_capture_changes=False
    ),
    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",
        query_single_always_on_node=False,
        read_backup_only=False,
        safeguard_policy="safeguardPolicy",
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId",
        use_bcp_full_load=False,
        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_bFile=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",
        capture_ddls=False,
        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,
        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",
        external_table_definition="externalTableDefinition",
        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"
)

Attributes

certificate_arn

The Amazon Resource Name (ARN) for the certificate.

Link:

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

database_name

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 .

Link:

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

doc_db_settings

Settings in JSON format for the source and target DocumentDB endpoint.

For more information about other available settings, see Using extra connections attributes with Amazon DocumentDB as a source and Using Amazon DocumentDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Link:

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

dynamo_db_settings

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 .

Link:

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

elasticsearch_settings

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 .

Link:

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

endpoint_identifier

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.

Link:

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

endpoint_type

The type of endpoint.

Valid values are source and target .

Link:

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

engine_name

The type of engine for the endpoint, depending on the EndpointType value.

Valid values : mysql | oracle | postgres | mariadb | aurora | aurora-postgresql | opensearch | redshift | s3 | db2 | azuredb | sybase | dynamodb | mongodb | kinesis | kafka | elasticsearch | docdb | sqlserver | neptune

Link:

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

extra_connection_attributes

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 .

Link:

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

gcp_my_sql_settings

Settings in JSON format for the source GCP MySQL endpoint.

These settings are much the same as the settings for any MySQL-compatible endpoint. For more information, see Extra connection attributes when using MySQL as a source for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

ibm_db2_settings

Settings in JSON format for the source IBM Db2 LUW endpoint.

For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

kafka_settings

Settings in JSON format for the target Apache Kafka endpoint.

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

Link:

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

kinesis_settings

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

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

Link:

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

kms_key_id

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

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

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

Link:

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

microsoft_sql_server_settings

Settings in JSON format for the source and target Microsoft SQL Server endpoint.

For information about other available settings, see Extra connection attributes when using SQL Server as a source for AWS DMS and Extra connection attributes when using SQL Server as a target for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

mongo_db_settings

Settings in JSON format for the source MongoDB endpoint.

For more information about the available settings, see Using MongoDB as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

Link:

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

my_sql_settings

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 .

Link:

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

neptune_settings

Settings in JSON format for the target Amazon Neptune endpoint.

For more information about the available settings, see Specifying endpoint settings for Amazon Neptune as a target in the AWS Database Migration Service User Guide .

Link:

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

oracle_settings

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 .

Link:

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

password

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

Link:

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

port

The port used by the endpoint database.

Link:

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

postgre_sql_settings

Settings in JSON format for the source and target PostgreSQL endpoint.

For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for AWS DMS and Extra connection attributes when using PostgreSQL as a target for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

redis_settings

Settings in JSON format for the target Redis endpoint.

For information about other available settings, see Specifying endpoint settings for Redis as a target in the AWS Database Migration Service User Guide .

Link:

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

redshift_settings

Settings in JSON format for the Amazon Redshift endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon Redshift as a target for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

resource_identifier

A display name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 .

For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don’t specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

Link:

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

s3_settings

Settings in JSON format for the source and target Amazon S3 endpoint.

For more information about other available settings, see Extra connection attributes when using Amazon S3 as a source for AWS DMS and Extra connection attributes when using Amazon S3 as a target for AWS DMS in the AWS Database Migration Service User Guide .

Link:

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

server_name

The name of the server where the endpoint database resides.

Link:

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

ssl_mode

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none .

When engine_name is set to S3, the only allowed value is none .

Link:

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

sybase_settings

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 .

Link:

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

tags

One or more tags to be assigned to the endpoint.

Link:

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

username

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

Link:

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