CfnDataProviderPropsMixin

class aws_cdk.mixins_preview.aws_dms.mixins.CfnDataProviderPropsMixin(props, *, strategy=None)

Bases: Mixin

Provides information that defines a data provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-dataprovider.html
CloudformationResource:: AWS::DMS::DataProvider
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

cfn_data_provider_props_mixin = dms_mixins.CfnDataProviderPropsMixin(dms_mixins.CfnDataProviderMixinProps(
    data_provider_identifier="dataProviderIdentifier",
    data_provider_name="dataProviderName",
    description="description",
    engine="engine",
    exact_settings=False,
    settings=dms_mixins.CfnDataProviderPropsMixin.SettingsProperty(
        doc_db_settings=dms_mixins.CfnDataProviderPropsMixin.DocDbSettingsProperty(
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        ibm_db2_luw_settings=dms_mixins.CfnDataProviderPropsMixin.IbmDb2LuwSettingsProperty(
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        ibm_db2_zOs_settings=dms_mixins.CfnDataProviderPropsMixin.IbmDb2zOsSettingsProperty(
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        maria_db_settings=dms_mixins.CfnDataProviderPropsMixin.MariaDbSettingsProperty(
            certificate_arn="certificateArn",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        microsoft_sql_server_settings=dms_mixins.CfnDataProviderPropsMixin.MicrosoftSqlServerSettingsProperty(
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        mongo_db_settings=dms_mixins.CfnDataProviderPropsMixin.MongoDbSettingsProperty(
            auth_mechanism="authMechanism",
            auth_source="authSource",
            auth_type="authType",
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        my_sql_settings=dms_mixins.CfnDataProviderPropsMixin.MySqlSettingsProperty(
            certificate_arn="certificateArn",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        oracle_settings=dms_mixins.CfnDataProviderPropsMixin.OracleSettingsProperty(
            asm_server="asmServer",
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            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",
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        postgre_sql_settings=dms_mixins.CfnDataProviderPropsMixin.PostgreSqlSettingsProperty(
            certificate_arn="certificateArn",
            database_name="databaseName",
            port=123,
            server_name="serverName",
            ssl_mode="sslMode"
        ),
        redshift_settings=dms_mixins.CfnDataProviderPropsMixin.RedshiftSettingsProperty(
            database_name="databaseName",
            port=123,
            server_name="serverName"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DMS::DataProvider.

Parameters:

props (Union[CfnDataProviderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['dataProviderIdentifier', 'dataProviderName', 'description', 'engine', 'exactSettings', 'settings', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DocDbSettingsProperty

class CfnDataProviderPropsMixin.DocDbSettingsProperty(*, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines a DocumentDB endpoint.

Parameters:

certificate_arn (Optional[str])
database_name (Optional[str]) – The database name on the DocumentDB source endpoint.
port (Union[int, float, None]) – The port value for the DocumentDB source endpoint.
server_name (Optional[str]) – The name of the server on the DocumentDB source endpoint.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

doc_db_settings_property = dms_mixins.CfnDataProviderPropsMixin.DocDbSettingsProperty(
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

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

Type:: see

database_name

The database name on the DocumentDB source endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-databasename

port

The port value for the DocumentDB source endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-port

server_name

The name of the server on the DocumentDB source endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-docdbsettings.html#cfn-dms-dataprovider-docdbsettings-servername

ssl_mode

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

Type:: see

IbmDb2LuwSettingsProperty

class CfnDataProviderPropsMixin.IbmDb2LuwSettingsProperty(*, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

IbmDb2LuwSettings property identifier.

Parameters:

certificate_arn (Optional[str])
database_name (Optional[str])
port (Union[int, float, None])
server_name (Optional[str])
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.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.mixins_preview.aws_dms import mixins as dms_mixins

ibm_db2_luw_settings_property = dms_mixins.CfnDataProviderPropsMixin.IbmDb2LuwSettingsProperty(
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-certificatearn

Type:: see

database_name

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

Type:: see

port

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

Type:: see

server_name

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

Type:: see

ssl_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2luwsettings.html#cfn-dms-dataprovider-ibmdb2luwsettings-sslmode

Type:: see

IbmDb2zOsSettingsProperty

class CfnDataProviderPropsMixin.IbmDb2zOsSettingsProperty(*, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

IbmDb2zOsSettings property identifier.

Parameters:

certificate_arn (Optional[str])
database_name (Optional[str])
port (Union[int, float, None])
server_name (Optional[str])
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.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.mixins_preview.aws_dms import mixins as dms_mixins

ibm_db2z_os_settings_property = dms_mixins.CfnDataProviderPropsMixin.IbmDb2zOsSettingsProperty(
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-certificatearn

Type:: see

database_name

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

Type:: see

port

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

Type:: see

server_name

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

Type:: see

ssl_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-ibmdb2zossettings.html#cfn-dms-dataprovider-ibmdb2zossettings-sslmode

Type:: see

MariaDbSettingsProperty

class CfnDataProviderPropsMixin.MariaDbSettingsProperty(*, certificate_arn=None, port=None, server_name=None, ssl_mode=None)

Bases: object

MariaDbSettings property identifier.

Parameters:

certificate_arn (Optional[str])
port (Union[int, float, None])
server_name (Optional[str])
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.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.mixins_preview.aws_dms import mixins as dms_mixins

maria_db_settings_property = dms_mixins.CfnDataProviderPropsMixin.MariaDbSettingsProperty(
    certificate_arn="certificateArn",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-certificatearn

Type:: see

port

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

Type:: see

server_name

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

Type:: see

ssl_mode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mariadbsettings.html#cfn-dms-dataprovider-mariadbsettings-sslmode

Type:: see

MicrosoftSqlServerSettingsProperty

class CfnDataProviderPropsMixin.MicrosoftSqlServerSettingsProperty(*, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines a Microsoft SQL Server endpoint.

Parameters:

certificate_arn (Optional[str])
database_name (Optional[str]) – Database name for the endpoint.
port (Union[int, float, None]) – Endpoint TCP port.
server_name (Optional[str]) – Fully qualified domain name of the endpoint. For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

microsoft_sql_server_settings_property = dms_mixins.CfnDataProviderPropsMixin.MicrosoftSqlServerSettingsProperty(
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

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

Type:: see

database_name

Database name for the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-databasename

port

Endpoint TCP port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-port

server_name

Fully qualified domain name of the endpoint.

For an Amazon RDS SQL Server instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-microsoftsqlserversettings.html#cfn-dms-dataprovider-microsoftsqlserversettings-servername

ssl_mode

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

Type:: see

MongoDbSettingsProperty

class CfnDataProviderPropsMixin.MongoDbSettingsProperty(*, auth_mechanism=None, auth_source=None, auth_type=None, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines a MongoDB endpoint.

Parameters:

auth_mechanism (Optional[str]) – The authentication mechanism you use to access the MongoDB source endpoint. For the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn’t used when AuthType is set to "no" .
auth_source (Optional[str]) – The MongoDB database name. This setting isn’t used when AuthType is set to "no" . The default is "admin" .
auth_type (Optional[str]) – The authentication type you use to access the MongoDB source endpoint. When when set to "no" , user name and password parameters are not used and can be empty.
certificate_arn (Optional[str])
database_name (Optional[str]) – The database name on the MongoDB source endpoint.
port (Union[int, float, None]) – The port value for the MongoDB source endpoint.
server_name (Optional[str]) – The name of the server on the MongoDB source endpoint. For MongoDB Atlas, provide the server name for any of the servers in the replication set.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

mongo_db_settings_property = dms_mixins.CfnDataProviderPropsMixin.MongoDbSettingsProperty(
    auth_mechanism="authMechanism",
    auth_source="authSource",
    auth_type="authType",
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

auth_mechanism

The authentication mechanism you use to access the MongoDB source endpoint.

For the default value, in MongoDB version 2.x, "default" is "mongodb_cr" . For MongoDB version 3.x or later, "default" is "scram_sha_1" . This setting isn’t used when AuthType is set to "no" .

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

auth_source

The MongoDB database name. This setting isn’t used when AuthType is set to "no" .

The default is "admin" .

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

auth_type

The authentication type you use to access the MongoDB source endpoint.

When when set to "no" , user name and password parameters are not used and can be empty.

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

certificate_arn

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

Type:: see

database_name

The database name on the MongoDB source endpoint.

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

port

The port value for the MongoDB source endpoint.

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

server_name

The name of the server on the MongoDB source endpoint.

For MongoDB Atlas, provide the server name for any of the servers in the replication set.

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

ssl_mode

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

Type:: see

MySqlSettingsProperty

class CfnDataProviderPropsMixin.MySqlSettingsProperty(*, certificate_arn=None, port=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines a MySQL endpoint.

Parameters:

certificate_arn (Optional[str])
port (Union[int, float, None]) – Endpoint TCP port.
server_name (Optional[str]) –
The host name of the endpoint database. For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field. For an Aurora MySQL instance, this is the output of DescribeDBClusters , in the Endpoint field.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

my_sql_settings_property = dms_mixins.CfnDataProviderPropsMixin.MySqlSettingsProperty(
    certificate_arn="certificateArn",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

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

Type:: see

port

Endpoint TCP port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-port

server_name

The host name of the endpoint database.

For an Amazon RDS MySQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

For an Aurora MySQL instance, this is the output of DescribeDBClusters , in the Endpoint field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-mysqlsettings.html#cfn-dms-dataprovider-mysqlsettings-servername

ssl_mode

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

Type:: see

OracleSettingsProperty

class CfnDataProviderPropsMixin.OracleSettingsProperty(*, asm_server=None, certificate_arn=None, database_name=None, port=None, secrets_manager_oracle_asm_access_role_arn=None, secrets_manager_oracle_asm_secret_id=None, secrets_manager_security_db_encryption_access_role_arn=None, secrets_manager_security_db_encryption_secret_id=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines an Oracle endpoint.

Parameters:

asm_server (Optional[str]) – For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database .
certificate_arn (Optional[str])
database_name (Optional[str]) – Database name for the endpoint.
port (Union[int, float, None]) – Endpoint TCP port.
secrets_manager_oracle_asm_access_role_arn (Optional[str]) – Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret . This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint. .. epigraph:: You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId . Or you can specify clear-text values for AsmUser , AsmPassword , and AsmServerName . You can’t specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
secrets_manager_oracle_asm_secret_id (Optional[str]) – Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
secrets_manager_security_db_encryption_access_role_arn (Optional[str])
secrets_manager_security_db_encryption_secret_id (Optional[str])
server_name (Optional[str]) –
Fully qualified domain name of the endpoint. For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

oracle_settings_property = dms_mixins.CfnDataProviderPropsMixin.OracleSettingsProperty(
    asm_server="asmServer",
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    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",
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

asm_server

For an Oracle source endpoint, your ASM server address.

You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-asmserver

certificate_arn

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

Type:: see

database_name

Database name for the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-databasename

port

Endpoint TCP port.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-port

secrets_manager_oracle_asm_access_role_arn

Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret . This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint. .. epigraph:

You can specify one of two sets of values for these permissions. You can specify the values for this setting and ``SecretsManagerOracleAsmSecretId`` . Or you can specify clear-text values for ``AsmUser`` , ``AsmPassword`` , and ``AsmServerName`` . You can't specify both. For more information on creating this ``SecretsManagerOracleAsmSecret`` and the ``SecretsManagerOracleAsmAccessRoleArn`` and ``SecretsManagerOracleAsmSecretId`` required to access it, see `Using secrets to access AWS Database Migration Service resources <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager>`_ in the *AWS Database Migration Service User Guide* .

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

secrets_manager_oracle_asm_secret_id

Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

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

secrets_manager_security_db_encryption_access_role_arn

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

Type:: see

secrets_manager_security_db_encryption_secret_id

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

Type:: see

server_name

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-servername

ssl_mode

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

Type:: see

PostgreSqlSettingsProperty

class CfnDataProviderPropsMixin.PostgreSqlSettingsProperty(*, certificate_arn=None, database_name=None, port=None, server_name=None, ssl_mode=None)

Bases: object

Provides information that defines a PostgreSQL endpoint.

Parameters:

certificate_arn (Optional[str])
database_name (Optional[str]) – Database name for the endpoint.
port (Union[int, float, None]) – Endpoint TCP port. The default is 5432.
server_name (Optional[str]) –
The host name of the endpoint database. For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field. For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters , in the Endpoint field.
ssl_mode (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

postgre_sql_settings_property = dms_mixins.CfnDataProviderPropsMixin.PostgreSqlSettingsProperty(
    certificate_arn="certificateArn",
    database_name="databaseName",
    port=123,
    server_name="serverName",
    ssl_mode="sslMode"
)

Attributes

certificate_arn

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

Type:: see

database_name

Database name for the endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-databasename

port

Endpoint TCP port.

The default is 5432.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-port

server_name

The host name of the endpoint database.

For an Amazon RDS PostgreSQL instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

For an Aurora PostgreSQL instance, this is the output of DescribeDBClusters , in the Endpoint field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-postgresqlsettings.html#cfn-dms-dataprovider-postgresqlsettings-servername

ssl_mode

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

Type:: see

RedshiftSettingsProperty

class CfnDataProviderPropsMixin.RedshiftSettingsProperty(*, database_name=None, port=None, server_name=None)

Bases: object

Provides information that defines an Amazon Redshift endpoint.

Parameters:

database_name (Optional[str]) – The name of the Amazon Redshift data warehouse (service) that you are working with.
port (Union[int, float, None]) – The port number for Amazon Redshift. The default value is 5439.
server_name (Optional[str]) – The name of the Amazon Redshift cluster you are using.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-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.
from aws_cdk.mixins_preview.aws_dms import mixins as dms_mixins

redshift_settings_property = dms_mixins.CfnDataProviderPropsMixin.RedshiftSettingsProperty(
    database_name="databaseName",
    port=123,
    server_name="serverName"
)

Attributes

database_name

The name of the Amazon Redshift data warehouse (service) that you are working with.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-databasename

port

The port number for Amazon Redshift.

The default value is 5439.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-port

server_name

The name of the Amazon Redshift cluster you are using.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-redshiftsettings.html#cfn-dms-dataprovider-redshiftsettings-servername

SettingsProperty

class CfnDataProviderPropsMixin.SettingsProperty(*, doc_db_settings=None, ibm_db2_luw_settings=None, ibm_db2_z_os_settings=None, maria_db_settings=None, microsoft_sql_server_settings=None, mongo_db_settings=None, my_sql_settings=None, oracle_settings=None, postgre_sql_settings=None, redshift_settings=None)

Bases: object

The property identifies the exact type of settings for the data provider.

Parameters:

doc_db_settings (Union[IResolvable, DocDbSettingsProperty, Dict[str, Any], None]) – DocDbSettings property identifier.
ibm_db2_luw_settings (Union[IResolvable, IbmDb2LuwSettingsProperty, Dict[str, Any], None]) – IbmDb2LuwSettings property identifier.
ibm_db2_z_os_settings (Union[IResolvable, IbmDb2zOsSettingsProperty, Dict[str, Any], None]) – IbmDb2zOsSettings property identifier.
maria_db_settings (Union[IResolvable, MariaDbSettingsProperty, Dict[str, Any], None]) – MariaDbSettings property identifier.
microsoft_sql_server_settings (Union[IResolvable, MicrosoftSqlServerSettingsProperty, Dict[str, Any], None]) – MicrosoftSqlServerSettings property identifier.
mongo_db_settings (Union[IResolvable, MongoDbSettingsProperty, Dict[str, Any], None]) – MongoDbSettings property identifier.
my_sql_settings (Union[IResolvable, MySqlSettingsProperty, Dict[str, Any], None]) – MySqlSettings property identifier.
oracle_settings (Union[IResolvable, OracleSettingsProperty, Dict[str, Any], None]) – OracleSettings property identifier.
postgre_sql_settings (Union[IResolvable, PostgreSqlSettingsProperty, Dict[str, Any], None]) – PostgreSqlSettings property identifier.
redshift_settings (Union[IResolvable, RedshiftSettingsProperty, Dict[str, Any], None]) – RedshiftSettings property identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-settings.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.mixins_preview.aws_dms import mixins as dms_mixins

settings_property = dms_mixins.CfnDataProviderPropsMixin.SettingsProperty(
    doc_db_settings=dms_mixins.CfnDataProviderPropsMixin.DocDbSettingsProperty(
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    ibm_db2_luw_settings=dms_mixins.CfnDataProviderPropsMixin.IbmDb2LuwSettingsProperty(
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    ibm_db2_zOs_settings=dms_mixins.CfnDataProviderPropsMixin.IbmDb2zOsSettingsProperty(
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    maria_db_settings=dms_mixins.CfnDataProviderPropsMixin.MariaDbSettingsProperty(
        certificate_arn="certificateArn",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    microsoft_sql_server_settings=dms_mixins.CfnDataProviderPropsMixin.MicrosoftSqlServerSettingsProperty(
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    mongo_db_settings=dms_mixins.CfnDataProviderPropsMixin.MongoDbSettingsProperty(
        auth_mechanism="authMechanism",
        auth_source="authSource",
        auth_type="authType",
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    my_sql_settings=dms_mixins.CfnDataProviderPropsMixin.MySqlSettingsProperty(
        certificate_arn="certificateArn",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    oracle_settings=dms_mixins.CfnDataProviderPropsMixin.OracleSettingsProperty(
        asm_server="asmServer",
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        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",
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    postgre_sql_settings=dms_mixins.CfnDataProviderPropsMixin.PostgreSqlSettingsProperty(
        certificate_arn="certificateArn",
        database_name="databaseName",
        port=123,
        server_name="serverName",
        ssl_mode="sslMode"
    ),
    redshift_settings=dms_mixins.CfnDataProviderPropsMixin.RedshiftSettingsProperty(
        database_name="databaseName",
        port=123,
        server_name="serverName"
    )
)