CfnEndpointProps

class aws_cdk.aws_dms.CfnEndpointProps(*, certificate_arn=None, database_name=None, doc_db_settings=None, dynamo_db_settings=None, elasticsearch_settings=None, endpoint_identifier=None, endpoint_type, engine_name, extra_connection_attributes=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 AWS::DMS::Endpoint.

Parameters
Link

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

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(
        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",
    ibm_db2_settings=dms.CfnEndpoint.IbmDb2SettingsProperty(
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    ),
    kafka_settings=dms.CfnEndpoint.KafkaSettingsProperty(
        broker="broker",
        include_control_details=False,
        include_null_and_empty=False,
        include_table_alter_operations=False,
        include_transaction_details=False,
        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_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(
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    ),
    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(
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    ),
    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(
        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"
    ),
    password="password",
    port=123,
    postgre_sql_settings=dms.CfnEndpoint.PostgreSqlSettingsProperty(
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    ),
    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(
        secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
        secrets_manager_secret_id="secretsManagerSecretId"
    ),
    resource_identifier="resourceIdentifier",
    s3_settings=dms.CfnEndpoint.S3SettingsProperty(
        bucket_folder="bucketFolder",
        bucket_name="bucketName",
        compression_type="compressionType",
        csv_delimiter="csvDelimiter",
        csv_row_delimiter="csvRowDelimiter",
        external_table_definition="externalTableDefinition",
        service_access_role_arn="serviceAccessRoleArn"
    ),
    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

AWS::DMS::Endpoint.CertificateArn.

Link

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

Return type

Optional[str]

database_name

AWS::DMS::Endpoint.DatabaseName.

Link

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

Return type

Optional[str]

doc_db_settings

AWS::DMS::Endpoint.DocDbSettings.

Link

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

Return type

Union[IResolvable, DocDbSettingsProperty, None]

dynamo_db_settings

AWS::DMS::Endpoint.DynamoDbSettings.

Link

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

Return type

Union[IResolvable, DynamoDbSettingsProperty, None]

elasticsearch_settings

AWS::DMS::Endpoint.ElasticsearchSettings.

Link

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

Return type

Union[IResolvable, ElasticsearchSettingsProperty, None]

endpoint_identifier

AWS::DMS::Endpoint.EndpointIdentifier.

Link

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

Return type

Optional[str]

endpoint_type

AWS::DMS::Endpoint.EndpointType.

Link

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

Return type

str

engine_name

AWS::DMS::Endpoint.EngineName.

Link

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

Return type

str

extra_connection_attributes

AWS::DMS::Endpoint.ExtraConnectionAttributes.

Link

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

Return type

Optional[str]

ibm_db2_settings

AWS::DMS::Endpoint.IbmDb2Settings.

Link

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

Return type

Union[IResolvable, IbmDb2SettingsProperty, None]

kafka_settings

AWS::DMS::Endpoint.KafkaSettings.

Link

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

Return type

Union[IResolvable, KafkaSettingsProperty, None]

kinesis_settings

AWS::DMS::Endpoint.KinesisSettings.

Link

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

Return type

Union[IResolvable, KinesisSettingsProperty, None]

kms_key_id

AWS::DMS::Endpoint.KmsKeyId.

Link

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

Return type

Optional[str]

microsoft_sql_server_settings

AWS::DMS::Endpoint.MicrosoftSqlServerSettings.

Link

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

Return type

Union[IResolvable, MicrosoftSqlServerSettingsProperty, None]

mongo_db_settings

AWS::DMS::Endpoint.MongoDbSettings.

Link

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

Return type

Union[IResolvable, MongoDbSettingsProperty, None]

my_sql_settings

AWS::DMS::Endpoint.MySqlSettings.

Link

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

Return type

Union[IResolvable, MySqlSettingsProperty, None]

neptune_settings

AWS::DMS::Endpoint.NeptuneSettings.

Link

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

Return type

Union[IResolvable, NeptuneSettingsProperty, None]

oracle_settings

AWS::DMS::Endpoint.OracleSettings.

Link

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

Return type

Union[IResolvable, OracleSettingsProperty, None]

password

AWS::DMS::Endpoint.Password.

Link

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

Return type

Optional[str]

port

AWS::DMS::Endpoint.Port.

Link

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

Return type

Union[int, float, None]

postgre_sql_settings

AWS::DMS::Endpoint.PostgreSqlSettings.

Link

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

Return type

Union[IResolvable, PostgreSqlSettingsProperty, None]

redis_settings

AWS::DMS::Endpoint.RedisSettings.

Link

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

Return type

Union[IResolvable, RedisSettingsProperty, None]

redshift_settings

AWS::DMS::Endpoint.RedshiftSettings.

Link

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

Return type

Union[IResolvable, RedshiftSettingsProperty, None]

resource_identifier

AWS::DMS::Endpoint.ResourceIdentifier.

Link

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

Return type

Optional[str]

s3_settings

AWS::DMS::Endpoint.S3Settings.

Link

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

Return type

Union[IResolvable, S3SettingsProperty, None]

server_name

AWS::DMS::Endpoint.ServerName.

Link

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

Return type

Optional[str]

ssl_mode

AWS::DMS::Endpoint.SslMode.

Link

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

Return type

Optional[str]

sybase_settings

AWS::DMS::Endpoint.SybaseSettings.

Link

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

Return type

Union[IResolvable, SybaseSettingsProperty, None]

tags

AWS::DMS::Endpoint.Tags.

Link

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

Return type

Optional[List[CfnTag]]

username

AWS::DMS::Endpoint.Username.

Link

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

Return type

Optional[str]