CfnEndpoint

class aws_cdk.aws_dms.CfnEndpoint(scope, id, *, 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: aws_cdk.core.CfnResource

A CloudFormation AWS::DMS::Endpoint.

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

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

CloudformationResource

AWS::DMS::Endpoint

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 = 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(
        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(
        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"
)

Create a new AWS::DMS::Endpoint.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • endpoint_type (str) – The type of endpoint. Valid values are source and target .

  • engine_name (str) – The type of engine for the endpoint. Valid values, depending on the EndpointType value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "opensearch" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "docdb" , "sqlserver" , and "neptune" .

  • certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) for the certificate.

  • database_name (Optional[str]) – The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName. To migrate to a specific database, use this setting and targetDbType .

  • doc_db_settings (Union[IResolvable, DocDbSettingsProperty, None]) – Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

  • dynamo_db_settings (Union[IResolvable, DynamoDbSettingsProperty, None]) – 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.

  • elasticsearch_settings (Union[IResolvable, ElasticsearchSettingsProperty, None]) – 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 .

  • endpoint_identifier (Optional[str]) – 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.

  • extra_connection_attributes (Optional[str]) – 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.

  • gcp_my_sql_settings (Union[IResolvable, GcpMySQLSettingsProperty, None]) – Settings in JSON format for the source GCP MySQL endpoint.

  • ibm_db2_settings (Union[IResolvable, IbmDb2SettingsProperty, None]) – Not currently supported by AWS CloudFormation .

  • kafka_settings (Union[IResolvable, KafkaSettingsProperty, None]) – Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide.

  • kinesis_settings (Union[IResolvable, KinesisSettingsProperty, None]) – Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

  • kms_key_id (Optional[str]) – An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don’t specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Region .

  • microsoft_sql_server_settings (Union[IResolvable, MicrosoftSqlServerSettingsProperty, None]) – Not currently supported by AWS CloudFormation .

  • mongo_db_settings (Union[IResolvable, MongoDbSettingsProperty, None]) – Not currently supported by AWS CloudFormation .

  • my_sql_settings (Union[IResolvable, MySqlSettingsProperty, None]) – 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.

  • neptune_settings (Union[IResolvable, NeptuneSettingsProperty, None]) – AWS::DMS::Endpoint.NeptuneSettings.

  • oracle_settings (Union[IResolvable, OracleSettingsProperty, None]) – 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.

  • password (Optional[str]) – The password to be used to log in to the endpoint database.

  • port (Union[int, float, None]) – The port used by the endpoint database.

  • postgre_sql_settings (Union[IResolvable, PostgreSqlSettingsProperty, None]) – Not currently supported by AWS CloudFormation .

  • redis_settings (Union[IResolvable, RedisSettingsProperty, None]) – Settings in JSON format for the target Redis endpoint.

  • redshift_settings (Union[IResolvable, RedshiftSettingsProperty, None]) – Not currently supported by AWS CloudFormation .

  • resource_identifier (Optional[str]) – A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 . For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don’t specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

  • s3_settings (Union[IResolvable, S3SettingsProperty, None]) – Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

  • server_name (Optional[str]) – The name of the server where the endpoint database resides.

  • ssl_mode (Optional[str]) – The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none . .. epigraph:: When engine_name is set to S3, then the only allowed value is none .

  • sybase_settings (Union[IResolvable, SybaseSettingsProperty, None]) – 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.

  • tags (Optional[Sequence[CfnTag]]) – One or more tags to be assigned to the endpoint.

  • username (Optional[str]) – The user name to be used to log in to the endpoint database.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DMS::Endpoint'
attr_external_id

A value that can be used for cross-account validation.

CloudformationAttribute

ExternalId

Return type

str

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

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

database_name

The name of the endpoint database.

For a MySQL source or target endpoint, do not 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

Return type

Optional[str]

doc_db_settings

Settings in JSON format for the source DocumentDB endpoint.

For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

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

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

Return type

Union[IResolvable, DynamoDbSettingsProperty, None]

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

Return type

Union[IResolvable, ElasticsearchSettingsProperty, None]

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

Return type

Optional[str]

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

Return type

str

engine_name

The type of engine for the endpoint.

Valid values, depending on the EndpointType value, include "mysql" , "oracle" , "postgres" , "mariadb" , "aurora" , "aurora-postgresql" , "opensearch" , "redshift" , "s3" , "db2" , "azuredb" , "sybase" , "dynamodb" , "mongodb" , "kinesis" , "kafka" , "elasticsearch" , "docdb" , "sqlserver" , and "neptune" .

Link

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

Return type

str

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

Return type

Optional[str]

gcp_my_sql_settings

Settings in JSON format for the source GCP MySQL endpoint.

Link

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

Return type

Union[IResolvable, GcpMySQLSettingsProperty, None]

ibm_db2_settings

Not currently supported by AWS CloudFormation .

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

Settings in JSON format for the target Apache Kafka endpoint.

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

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

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

For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

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

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

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

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

Link

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

Return type

Optional[str]

logical_id

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).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

microsoft_sql_server_settings

Not currently supported by AWS CloudFormation .

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

Not currently supported by AWS CloudFormation .

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

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

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]

node

The construct tree node associated with this construct.

Return type

ConstructNode

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

Return type

Union[IResolvable, OracleSettingsProperty, None]

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

Return type

Optional[str]

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

Return type

Union[int, float, None]

postgre_sql_settings

Not currently supported by AWS CloudFormation .

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

Settings in JSON format for the target Redis endpoint.

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

Not currently supported by AWS CloudFormation .

Link

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

Return type

Union[IResolvable, RedshiftSettingsProperty, None]

ref

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 }).

Return type

str

resource_identifier

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

The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1 . For example, this value might result in the EndpointArn value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1 . If you don’t specify a ResourceIdentifier value, AWS DMS generates a default identifier value for the end of EndpointArn .

Link

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

Return type

Optional[str]

s3_settings

Settings in JSON format for the target Amazon S3 endpoint.

For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

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

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

Return type

Optional[str]

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, then the only allowed value is none .

Link

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

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

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

Return type

Union[IResolvable, SybaseSettingsProperty, None]

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

Return type

TagManager

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

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

DocDbSettingsProperty

class CfnEndpoint.DocDbSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-docdbsettings.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

doc_db_settings_property = dms.CfnEndpoint.DocDbSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

DynamoDbSettingsProperty

class CfnEndpoint.DynamoDbSettingsProperty(*, service_access_role_arn=None)

Bases: object

Provides the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role used to define an Amazon DynamoDB target endpoint.

Parameters

service_access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-dynamodbsettings.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

dynamo_db_settings_property = dms.CfnEndpoint.DynamoDbSettingsProperty(
    service_access_role_arn="serviceAccessRoleArn"
)

Attributes

service_access_role_arn

The Amazon Resource Name (ARN) used by the service to access the IAM role.

The role must allow the iam:PassRole action.

Link

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

Return type

Optional[str]

ElasticsearchSettingsProperty

class CfnEndpoint.ElasticsearchSettingsProperty(*, endpoint_uri=None, error_retry_duration=None, full_load_error_percentage=None, service_access_role_arn=None)

Bases: object

Provides information that defines an OpenSearch endpoint.

Parameters
  • endpoint_uri (Optional[str]) – The endpoint for the OpenSearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.

  • error_retry_duration (Union[int, float, None]) – The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

  • full_load_error_percentage (Union[int, float, None]) – The maximum percentage of records that can fail to be written before a full load operation stops. To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

  • service_access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-elasticsearchsettings.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

elasticsearch_settings_property = dms.CfnEndpoint.ElasticsearchSettingsProperty(
    endpoint_uri="endpointUri",
    error_retry_duration=123,
    full_load_error_percentage=123,
    service_access_role_arn="serviceAccessRoleArn"
)

Attributes

endpoint_uri

The endpoint for the OpenSearch cluster.

AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.

Link

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

Return type

Optional[str]

error_retry_duration

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

Link

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

Return type

Union[int, float, None]

full_load_error_percentage

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

Link

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

Return type

Union[int, float, None]

service_access_role_arn

The Amazon Resource Name (ARN) used by the service to access the IAM role.

The role must allow the iam:PassRole action.

Link

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

Return type

Optional[str]

GcpMySQLSettingsProperty

class CfnEndpoint.GcpMySQLSettingsProperty(*, after_connect_script=None, clean_source_metadata_on_mismatch=None, database_name=None, events_poll_interval=None, max_file_size=None, parallel_load_threads=None, password=None, port=None, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None, server_name=None, server_timezone=None, username=None)

Bases: object

Settings in JSON format for the source GCP MySQL endpoint.

Parameters
  • after_connect_script (Optional[str]) – Specifies a script to run immediately after AWS DMS connects to the endpoint. The migration task continues running regardless if the SQL statement succeeds or fails. For this parameter, provide the code of the script itself, not the name of a file containing the script.

  • clean_source_metadata_on_mismatch (Union[bool, IResolvable, None]) – Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster. If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .

  • database_name (Optional[str]) – Database name for the endpoint. For a MySQL source or target endpoint, don’t explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.

  • events_poll_interval (Union[int, float, None]) – Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds. Example: eventsPollInterval=5; In the example, AWS DMS checks for changes in the binary logs every five seconds.

  • max_file_size (Union[int, float, None]) – Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database. Example: maxFileSize=512

  • parallel_load_threads (Union[int, float, None]) – Improves performance when loading data into the MySQL-compatible target database. Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one. Example: parallelLoadThreads=1

  • password (Optional[str]) – Endpoint connection password.

  • port (Union[int, float, None]) – CfnEndpoint.GcpMySQLSettingsProperty.Port.

  • secrets_manager_access_role_arn (Optional[str]) – The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint. .. epigraph:: You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId . Or you can specify clear-text values for UserName , Password , ServerName , and Port . You can’t specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

  • secrets_manager_secret_id (Optional[str]) – The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

  • server_name (Optional[str]) – Endpoint TCP port.

  • server_timezone (Optional[str]) – Specifies the time zone for the source MySQL database. Example: serverTimezone=US/Pacific; Note: Do not enclose time zones in single quotes.

  • username (Optional[str]) – Endpoint connection user name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-gcpmysqlsettings.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

gcp_my_sQLSettings_property = 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"
)

Attributes

after_connect_script

Specifies a script to run immediately after AWS DMS connects to the endpoint.

The migration task continues running regardless if the SQL statement succeeds or fails.

For this parameter, provide the code of the script itself, not the name of a file containing the script.

Link

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

Return type

Optional[str]

clean_source_metadata_on_mismatch

Adjusts the behavior of AWS DMS when migrating from an SQL Server source database that is hosted as part of an Always On availability group cluster.

If you need AWS DMS to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false .

Link

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

Return type

Union[bool, IResolvable, None]

database_name

Database name for the endpoint.

For a MySQL source or target endpoint, don’t explicitly specify the database using the DatabaseName request parameter on either the CreateEndpoint or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the AWS DMS task.

Link

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

Return type

Optional[str]

events_poll_interval

Specifies how often to check the binary log for new changes/events when the database is idle.

The default is five seconds.

Example: eventsPollInterval=5;

In the example, AWS DMS checks for changes in the binary logs every five seconds.

Link

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

Return type

Union[int, float, None]

max_file_size

Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

Example: maxFileSize=512

Link

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

Return type

Union[int, float, None]

parallel_load_threads

Improves performance when loading data into the MySQL-compatible target database.

Specifies how many threads to use to load the data into the MySQL-compatible target database. Setting a large number of threads can have an adverse effect on database performance, because a separate connection is required for each thread. The default is one.

Example: parallelLoadThreads=1

Link

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

Return type

Union[int, float, None]

password

Endpoint connection password.

Link

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

Return type

Optional[str]

port

CfnEndpoint.GcpMySQLSettingsProperty.Port.

Link

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

Return type

Union[int, float, None]

secrets_manager_access_role_arn

The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS Secrets Manager secret that allows access to the MySQL endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId . Or you can specify clear-text values for UserName , Password , ServerName , and Port . You can’t specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide.

Link

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

Return type

Optional[str]

secrets_manager_secret_id

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the MySQL endpoint connection details.

Link

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

Return type

Optional[str]

server_name

Endpoint TCP port.

Link

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

Return type

Optional[str]

server_timezone

Specifies the time zone for the source MySQL database.

Example: serverTimezone=US/Pacific;

Note: Do not enclose time zones in single quotes.

Link

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

Return type

Optional[str]

username

Endpoint connection user name.

Link

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

Return type

Optional[str]

IbmDb2SettingsProperty

class CfnEndpoint.IbmDb2SettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-ibmdb2settings.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

ibm_db2_settings_property = dms.CfnEndpoint.IbmDb2SettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

KafkaSettingsProperty

class CfnEndpoint.KafkaSettingsProperty(*, broker=None, include_control_details=None, include_null_and_empty=None, include_table_alter_operations=None, include_transaction_details=None, no_hex_prefix=None, partition_include_schema_table=None, sasl_password=None, sasl_user_name=None, security_protocol=None, ssl_ca_certificate_arn=None, ssl_client_certificate_arn=None, ssl_client_key_arn=None, ssl_client_key_password=None, topic=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • broker (Optional[str]) – Not currently supported by AWS CloudFormation .

  • include_control_details (Union[bool, IResolvable, None]) – Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false .

  • include_null_and_empty (Union[bool, IResolvable, None]) – Include NULL and empty columns for records migrated to the endpoint. The default is false .

  • include_table_alter_operations (Union[bool, IResolvable, None]) – Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table , drop-table , add-column , drop-column , and rename-column . The default is false .

  • include_transaction_details (Union[bool, IResolvable, None]) – Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id , previous transaction_id , and transaction_record_id (the record offset within a transaction). The default is false .

  • no_hex_prefix (Union[bool, IResolvable, None]) – Set this optional parameter to true to avoid adding a ‘0x’ prefix to raw data in hexadecimal format. For example, by default, AWS DMS adds a ‘0x’ prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the ‘0x’ prefix.

  • partition_include_schema_table (Union[bool, IResolvable, None]) – Prefixes schema and table names to partition values, when the partition type is primary-key-type . Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false .

  • sasl_password (Optional[str]) – The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

  • sasl_user_name (Optional[str]) – The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

  • security_protocol (Optional[str]) – Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption , ssl-authentication , and sasl-ssl . sasl-ssl requires SaslUsername and SaslPassword .

  • ssl_ca_certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.

  • ssl_client_certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

  • ssl_client_key_arn (Optional[str]) – The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

  • ssl_client_key_password (Optional[str]) – The password for the client private key used to securely connect to a Kafka target endpoint.

  • topic (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.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

kafka_settings_property = 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"
)

Attributes

broker

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

include_control_details

Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_null_and_empty

Include NULL and empty columns for records migrated to the endpoint.

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_table_alter_operations

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table , drop-table , add-column , drop-column , and rename-column .

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_transaction_details

Provides detailed transaction information from the source database.

This information includes a commit timestamp, a log position, and values for transaction_id , previous transaction_id , and transaction_record_id (the record offset within a transaction). The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

no_hex_prefix

Set this optional parameter to true to avoid adding a ‘0x’ prefix to raw data in hexadecimal format.

For example, by default, AWS DMS adds a ‘0x’ prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the ‘0x’ prefix.

Link

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

Return type

Union[bool, IResolvable, None]

partition_include_schema_table

Prefixes schema and table names to partition values, when the partition type is primary-key-type .

Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

sasl_password

The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

Link

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

Return type

Optional[str]

sasl_user_name

The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

Link

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

Return type

Optional[str]

security_protocol

Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).

Options include ssl-encryption , ssl-authentication , and sasl-ssl . sasl-ssl requires SaslUsername and SaslPassword .

Link

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

Return type

Optional[str]

ssl_ca_certificate_arn

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.

Link

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

Return type

Optional[str]

ssl_client_certificate_arn

The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

Link

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

Return type

Optional[str]

ssl_client_key_arn

The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

Link

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

Return type

Optional[str]

ssl_client_key_password

The password for the client private key used to securely connect to a Kafka target endpoint.

Link

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

Return type

Optional[str]

topic

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

KinesisSettingsProperty

class CfnEndpoint.KinesisSettingsProperty(*, include_control_details=None, include_null_and_empty=None, include_table_alter_operations=None, include_transaction_details=None, message_format=None, no_hex_prefix=None, partition_include_schema_table=None, service_access_role_arn=None, stream_arn=None)

Bases: object

Not currently supported by AWS CloudFormation ..

Parameters
  • include_control_details (Union[bool, IResolvable, None]) – Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false .

  • include_null_and_empty (Union[bool, IResolvable, None]) – Include NULL and empty columns for records migrated to the endpoint. The default is false .

  • include_table_alter_operations (Union[bool, IResolvable, None]) – Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table , drop-table , add-column , drop-column , and rename-column . The default is false .

  • include_transaction_details (Union[bool, IResolvable, None]) – Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id , previous transaction_id , and transaction_record_id (the record offset within a transaction). The default is false .

  • message_format (Optional[str]) – Not currently supported by AWS CloudFormation .

  • no_hex_prefix (Union[bool, IResolvable, None]) – Set this optional parameter to true to avoid adding a ‘0x’ prefix to raw data in hexadecimal format. For example, by default, AWS DMS adds a ‘0x’ prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the ‘0x’ prefix.

  • partition_include_schema_table (Union[bool, IResolvable, None]) – Prefixes schema and table names to partition values, when the partition type is primary-key-type . Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false .

  • service_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • stream_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kinesissettings.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

kinesis_settings_property = 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"
)

Attributes

include_control_details

Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output.

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_null_and_empty

Include NULL and empty columns for records migrated to the endpoint.

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_table_alter_operations

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table , drop-table , add-column , drop-column , and rename-column .

The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

include_transaction_details

Provides detailed transaction information from the source database.

This information includes a commit timestamp, a log position, and values for transaction_id , previous transaction_id , and transaction_record_id (the record offset within a transaction). The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

message_format

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

no_hex_prefix

Set this optional parameter to true to avoid adding a ‘0x’ prefix to raw data in hexadecimal format.

For example, by default, AWS DMS adds a ‘0x’ prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the ‘0x’ prefix.

Link

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

Return type

Union[bool, IResolvable, None]

partition_include_schema_table

Prefixes schema and table names to partition values, when the partition type is primary-key-type .

Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

service_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

stream_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

MicrosoftSqlServerSettingsProperty

class CfnEndpoint.MicrosoftSqlServerSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-microsoftsqlserversettings.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

microsoft_sql_server_settings_property = dms.CfnEndpoint.MicrosoftSqlServerSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

MongoDbSettingsProperty

class CfnEndpoint.MongoDbSettingsProperty(*, auth_mechanism=None, auth_source=None, auth_type=None, database_name=None, docs_to_investigate=None, extract_doc_id=None, nesting_level=None, password=None, port=None, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None, server_name=None, username=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • auth_mechanism (Optional[str]) – Not currently supported by AWS CloudFormation .

  • auth_source (Optional[str]) – Not currently supported by AWS CloudFormation .

  • auth_type (Optional[str]) – Not currently supported by AWS CloudFormation .

  • database_name (Optional[str]) – Not currently supported by AWS CloudFormation .

  • docs_to_investigate (Optional[str]) – Not currently supported by AWS CloudFormation .

  • extract_doc_id (Optional[str]) – Not currently supported by AWS CloudFormation .

  • nesting_level (Optional[str]) – Not currently supported by AWS CloudFormation .

  • password (Optional[str]) – Not currently supported by AWS CloudFormation .

  • port (Union[int, float, None]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

  • server_name (Optional[str]) – Not currently supported by AWS CloudFormation .

  • username (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mongodbsettings.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

mongo_db_settings_property = 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"
)

Attributes

auth_mechanism

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

auth_source

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

auth_type

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

database_name

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

docs_to_investigate

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

extract_doc_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

nesting_level

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

password

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

port

Not currently supported by AWS CloudFormation .

Link

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

Return type

Union[int, float, None]

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

server_name

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

username

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

MySqlSettingsProperty

class CfnEndpoint.MySqlSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-mysqlsettings.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

my_sql_settings_property = dms.CfnEndpoint.MySqlSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

NeptuneSettingsProperty

class CfnEndpoint.NeptuneSettingsProperty(*, error_retry_duration=None, iam_auth_enabled=None, max_file_size=None, max_retry_count=None, s3_bucket_folder=None, s3_bucket_name=None, service_access_role_arn=None)

Bases: object

Provides information that defines an Amazon Neptune endpoint.

Parameters
  • error_retry_duration (Union[int, float, None]) – The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 250.

  • iam_auth_enabled (Union[bool, IResolvable, None]) – If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true . Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn . The default is false .

  • max_file_size (Union[int, float, None]) – The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.

  • max_retry_count (Union[int, float, None]) – The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.

  • s3_bucket_folder (Optional[str]) – A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName.

  • s3_bucket_name (Optional[str]) – The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.

  • service_access_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-neptunesettings.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

neptune_settings_property = 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"
)

Attributes

error_retry_duration

The number of milliseconds for AWS DMS to wait to retry a bulk-load of migrated graph data to the Neptune target database before raising an error.

The default is 250.

Link

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

Return type

Union[int, float, None]

iam_auth_enabled

If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true .

Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn . The default is false .

Link

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

Return type

Union[bool, IResolvable, None]

max_file_size

The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.

Link

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

Return type

Union[int, float, None]

max_retry_count

The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error.

The default is 5.

Link

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

Return type

Union[int, float, None]

s3_bucket_folder

A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName.

Link

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

Return type

Optional[str]

s3_bucket_name

The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.

Link

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

Return type

Optional[str]

service_access_role_arn

The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint.

The role must allow the iam:PassRole action. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

Link

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

Return type

Optional[str]

OracleSettingsProperty

class CfnEndpoint.OracleSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_oracle_asm_access_role_arn=None, secrets_manager_oracle_asm_secret_id=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_oracle_asm_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_oracle_asm_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-oraclesettings.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

oracle_settings_property = 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"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_oracle_asm_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_oracle_asm_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

PostgreSqlSettingsProperty

class CfnEndpoint.PostgreSqlSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-postgresqlsettings.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

postgre_sql_settings_property = dms.CfnEndpoint.PostgreSqlSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

RedisSettingsProperty

class CfnEndpoint.RedisSettingsProperty(*, auth_password=None, auth_type=None, auth_user_name=None, port=None, server_name=None, ssl_ca_certificate_arn=None, ssl_security_protocol=None)

Bases: object

Provides information that defines a Redis target endpoint.

Parameters
  • auth_password (Optional[str]) – The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

  • auth_type (Optional[str]) – The type of authentication to perform when connecting to a Redis target. Options include none , auth-token , and auth-role . The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

  • auth_user_name (Optional[str]) – The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

  • port (Union[int, float, None]) – Transmission Control Protocol (TCP) port for the endpoint.

  • server_name (Optional[str]) – Fully qualified domain name of the endpoint.

  • ssl_ca_certificate_arn (Optional[str]) – The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

  • ssl_security_protocol (Optional[str]) – The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid values include plaintext and ssl-encryption . The default is ssl-encryption . The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn’t given for a CA, DMS uses the Amazon root CA. The plaintext option doesn’t provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redissettings.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

redis_settings_property = 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"
)

Attributes

auth_password

The password provided with the auth-role and auth-token options of the AuthType setting for a Redis target endpoint.

Link

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

Return type

Optional[str]

auth_type

The type of authentication to perform when connecting to a Redis target.

Options include none , auth-token , and auth-role . The auth-token option requires an AuthPassword value to be provided. The auth-role option requires AuthUserName and AuthPassword values to be provided.

Link

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

Return type

Optional[str]

auth_user_name

The user name provided with the auth-role option of the AuthType setting for a Redis target endpoint.

Link

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

Return type

Optional[str]

port

Transmission Control Protocol (TCP) port for the endpoint.

Link

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

Return type

Union[int, float, None]

server_name

Fully qualified domain name of the endpoint.

Link

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

Return type

Optional[str]

ssl_ca_certificate_arn

The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to connect to your Redis target endpoint.

Link

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

Return type

Optional[str]

ssl_security_protocol

The connection to a Redis target endpoint using Transport Layer Security (TLS).

Valid values include plaintext and ssl-encryption . The default is ssl-encryption . The ssl-encryption option makes an encrypted connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) using the SslCaCertificateArn setting. If an ARN isn’t given for a CA, DMS uses the Amazon root CA.

The plaintext option doesn’t provide Transport Layer Security (TLS) encryption for traffic between endpoint and database.

Link

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

Return type

Optional[str]

RedshiftSettingsProperty

class CfnEndpoint.RedshiftSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-redshiftsettings.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

redshift_settings_property = dms.CfnEndpoint.RedshiftSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

S3SettingsProperty

class CfnEndpoint.S3SettingsProperty(*, bucket_folder=None, bucket_name=None, compression_type=None, csv_delimiter=None, csv_row_delimiter=None, external_table_definition=None, service_access_role_arn=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • bucket_folder (Optional[str]) – Not currently supported by AWS CloudFormation .

  • bucket_name (Optional[str]) – Not currently supported by AWS CloudFormation .

  • compression_type (Optional[str]) – Not currently supported by AWS CloudFormation .

  • csv_delimiter (Optional[str]) – Not currently supported by AWS CloudFormation .

  • csv_row_delimiter (Optional[str]) – Not currently supported by AWS CloudFormation .

  • external_table_definition (Optional[str]) – Not currently supported by AWS CloudFormation .

  • service_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-s3settings.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

s3_settings_property = 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"
)

Attributes

bucket_folder

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

bucket_name

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

compression_type

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

csv_delimiter

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

csv_row_delimiter

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

external_table_definition

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

service_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

SybaseSettingsProperty

class CfnEndpoint.SybaseSettingsProperty(*, secrets_manager_access_role_arn=None, secrets_manager_secret_id=None)

Bases: object

Not currently supported by AWS CloudFormation .

Parameters
  • secrets_manager_access_role_arn (Optional[str]) – Not currently supported by AWS CloudFormation .

  • secrets_manager_secret_id (Optional[str]) – Not currently supported by AWS CloudFormation .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-sybasesettings.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

sybase_settings_property = dms.CfnEndpoint.SybaseSettingsProperty(
    secrets_manager_access_role_arn="secretsManagerAccessRoleArn",
    secrets_manager_secret_id="secretsManagerSecretId"
)

Attributes

secrets_manager_access_role_arn

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]

secrets_manager_secret_id

Not currently supported by AWS CloudFormation .

Link

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

Return type

Optional[str]