CfnDataProviderProps

class aws_cdk.aws_dms.CfnDataProviderProps(*, engine, data_provider_identifier=None, data_provider_name=None, description=None, exact_settings=None, settings=None, tags=None)

Bases: object

Properties for defining a CfnDataProvider.

Parameters:

engine (str) – The type of database engine for the data provider. Valid values include "aurora" , "aurora-postgresql" , "mysql" , "oracle" , "postgres" , "sqlserver" , redshift , mariadb , mongodb , db2 , db2-zos and docdb . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
data_provider_identifier (Optional[str]) – The identifier of the data provider. 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.
data_provider_name (Optional[str]) – The name of the data provider.
description (Optional[str]) – A description of the data provider. Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.
exact_settings (Union[bool, IResolvable, None]) – The property describes the exact settings which can be modified. Default: - false
settings (Union[IResolvable, SettingsProperty, Dict[str, Any], None]) – The settings in JSON format for a data provider.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_data_provider_props = dms.CfnDataProviderProps(
    engine="engine",

    # the properties below are optional
    data_provider_identifier="dataProviderIdentifier",
    data_provider_name="dataProviderName",
    description="description",
    exact_settings=False,
    settings=dms.CfnDataProvider.SettingsProperty(
        doc_db_settings=dms.CfnDataProvider.DocDbSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",

            # the properties below are optional
            certificate_arn="certificateArn",
            ssl_mode="sslMode"
        ),
        ibm_db2_luw_settings=dms.CfnDataProvider.IbmDb2LuwSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        ibm_db2_zOs_settings=dms.CfnDataProvider.IbmDb2zOsSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        maria_db_settings=dms.CfnDataProvider.MariaDbSettingsProperty(
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        microsoft_sql_server_settings=dms.CfnDataProvider.MicrosoftSqlServerSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        mongo_db_settings=dms.CfnDataProvider.MongoDbSettingsProperty(
            port=123,
            server_name="serverName",

            # the properties below are optional
            auth_mechanism="authMechanism",
            auth_source="authSource",
            auth_type="authType",
            certificate_arn="certificateArn",
            database_name="databaseName",
            ssl_mode="sslMode"
        ),
        my_sql_settings=dms.CfnDataProvider.MySqlSettingsProperty(
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        oracle_settings=dms.CfnDataProvider.OracleSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            asm_server="asmServer",
            certificate_arn="certificateArn",
            secrets_manager_oracle_asm_access_role_arn="secretsManagerOracleAsmAccessRoleArn",
            secrets_manager_oracle_asm_secret_id="secretsManagerOracleAsmSecretId",
            secrets_manager_security_db_encryption_access_role_arn="secretsManagerSecurityDbEncryptionAccessRoleArn",
            secrets_manager_security_db_encryption_secret_id="secretsManagerSecurityDbEncryptionSecretId"
        ),
        postgre_sql_settings=dms.CfnDataProvider.PostgreSqlSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode",

            # the properties below are optional
            certificate_arn="certificateArn"
        ),
        redshift_settings=dms.CfnDataProvider.RedshiftSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_provider_identifier

The identifier of the data provider.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovideridentifier

data_provider_name

The name of the data provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-dataprovidername

description

A description of the data provider.

Descriptions can have up to 31 characters. A description can contain only ASCII letters, digits, and hyphens (‘-‘). Also, it can’t end with a hyphen or contain two consecutive hyphens, and can only begin with a letter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-description

engine

The type of database engine for the data provider.

Valid values include "aurora" , "aurora-postgresql" , "mysql" , "oracle" , "postgres" , "sqlserver" , redshift , mariadb , mongodb , db2 , db2-zos and docdb . A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-engine

exact_settings

The property describes the exact settings which can be modified.

Default:

false

See:

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

settings

The settings in JSON format for a data provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html#cfn-dms-dataprovider-settings

tags

An array of key-value pairs to apply to this resource.

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