CfnDataProvider
- class aws_cdk.aws_dms.CfnDataProvider(scope, id, *, engine, data_provider_identifier=None, data_provider_name=None, description=None, exact_settings=None, settings=None, tags=None)
Bases:
CfnResource
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
- 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 = dms.CfnDataProvider(self, "MyCfnDataProvider", 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" )] )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).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
anddocdb
. 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: - falsesettings (
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.
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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate 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
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- 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::DataProvider'
- attr_data_provider_arn
The Amazon Resource Name (ARN) string that uniquely identifies the data provider.
- CloudformationAttribute:
DataProviderArn
- attr_data_provider_creation_time
The time the data provider was created.
- CloudformationAttribute:
DataProviderCreationTime
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- data_provider_identifier
The identifier of the data provider.
- data_provider_name
The name of the data provider.
- description
A description of the data provider.
- engine
The type of database engine for the data provider.
- exact_settings
The property describes the exact settings which can be modified.
- 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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- 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 })
.
- settings
The settings in JSON format for a data provider.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
An array of key-value pairs to apply to this resource.
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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
DocDbSettingsProperty
- class CfnDataProvider.DocDbSettingsProperty(*, database_name, port, server_name, certificate_arn=None, ssl_mode=None)
Bases:
object
Provides information that defines a DocumentDB endpoint.
- Parameters:
database_name (
str
) – The database name on the DocumentDB source endpoint.port (
Union
[int
,float
]) – The port value for the DocumentDB source endpoint.server_name (
str
) – The name of the server on the DocumentDB source endpoint.certificate_arn (
Optional
[str
]) –ssl_mode (
Optional
[str
]) –
- See:
- 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 doc_db_settings_property = dms.CfnDataProvider.DocDbSettingsProperty( database_name="databaseName", port=123, server_name="serverName", # the properties below are optional certificate_arn="certificateArn", ssl_mode="sslMode" )
Attributes
- certificate_arn
-
- Type:
see
- database_name
The database name on the DocumentDB source endpoint.
- port
The port value for the DocumentDB source endpoint.
- server_name
The name of the server on the DocumentDB source endpoint.
IbmDb2LuwSettingsProperty
- class CfnDataProvider.IbmDb2LuwSettingsProperty(*, database_name, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
IbmDb2LuwSettings property identifier.
- Parameters:
database_name (
str
) –port (
Union
[int
,float
]) –server_name (
str
) –ssl_mode (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 ibm_db2_luw_settings_property = dms.CfnDataProvider.IbmDb2LuwSettingsProperty( database_name="databaseName", port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- database_name
-
- Type:
see
- port
-
- Type:
see
- server_name
-
- Type:
see
IbmDb2zOsSettingsProperty
- class CfnDataProvider.IbmDb2zOsSettingsProperty(*, database_name, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
IbmDb2zOsSettings property identifier.
- Parameters:
database_name (
str
) –port (
Union
[int
,float
]) –server_name (
str
) –ssl_mode (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 ibm_db2z_os_settings_property = dms.CfnDataProvider.IbmDb2zOsSettingsProperty( database_name="databaseName", port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- database_name
-
- Type:
see
- port
-
- Type:
see
- server_name
-
- Type:
see
MariaDbSettingsProperty
- class CfnDataProvider.MariaDbSettingsProperty(*, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
MariaDbSettings property identifier.
- Parameters:
port (
Union
[int
,float
]) –server_name (
str
) –ssl_mode (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 maria_db_settings_property = dms.CfnDataProvider.MariaDbSettingsProperty( port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- port
-
- Type:
see
- server_name
-
- Type:
see
MicrosoftSqlServerSettingsProperty
- class CfnDataProvider.MicrosoftSqlServerSettingsProperty(*, database_name, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
Provides information that defines a Microsoft SQL Server endpoint.
- Parameters:
database_name (
str
) – Database name for the endpoint.port (
Union
[int
,float
]) – Endpoint TCP port.server_name (
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 (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 microsoft_sql_server_settings_property = dms.CfnDataProvider.MicrosoftSqlServerSettingsProperty( database_name="databaseName", port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- database_name
Database name for the endpoint.
- port
Endpoint TCP 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.
MongoDbSettingsProperty
- class CfnDataProvider.MongoDbSettingsProperty(*, port, server_name, auth_mechanism=None, auth_source=None, auth_type=None, certificate_arn=None, database_name=None, ssl_mode=None)
Bases:
object
Provides information that defines a MongoDB endpoint.
- Parameters:
port (
Union
[int
,float
]) – The port value for the MongoDB source endpoint.server_name (
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.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 whenAuthType
is set to"no"
.auth_source (
Optional
[str
]) – The MongoDB database name. This setting isn’t used whenAuthType
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.ssl_mode (
Optional
[str
]) –
- See:
- 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 mongo_db_settings_property = 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" )
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 whenAuthType
is set to"no"
.
- auth_source
The MongoDB database name. This setting isn’t used when
AuthType
is set to"no"
.The default is
"admin"
.
- 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.
- certificate_arn
-
- Type:
see
- database_name
The database name on the MongoDB source endpoint.
- port
The port value for the MongoDB source endpoint.
- 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.
MySqlSettingsProperty
- class CfnDataProvider.MySqlSettingsProperty(*, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
Provides information that defines a MySQL endpoint.
- Parameters:
port (
Union
[int
,float
]) – Endpoint TCP port.server_name (
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 theEndpoint
field.ssl_mode (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 my_sql_settings_property = dms.CfnDataProvider.MySqlSettingsProperty( port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- port
Endpoint TCP 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.
OracleSettingsProperty
- class CfnDataProvider.OracleSettingsProperty(*, database_name, port, server_name, ssl_mode, asm_server=None, certificate_arn=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)
Bases:
object
Provides information that defines an Oracle endpoint.
- Parameters:
database_name (
str
) – Database name for the endpoint.port (
Union
[int
,float
]) – Endpoint TCP port.server_name (
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 (
str
) –asm_server (
Optional
[str
]) – For an Oracle source endpoint, your ASM server address. You can set this value from theasm_server
value. You setasm_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
]) –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 theSecretsManagerOracleAsmSecret
. ThisSecretsManagerOracleAsmSecret
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 andSecretsManagerOracleAsmSecretId
. Or you can specify clear-text values forAsmUser
,AsmPassword
, andAsmServerName
. You can’t specify both. For more information on creating thisSecretsManagerOracleAsmSecret
and theSecretsManagerOracleAsmAccessRoleArn
andSecretsManagerOracleAsmSecretId
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 theSecretsManagerOracleAsmSecret
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
]) –
- See:
- 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 oracle_settings_property = 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" )
Attributes
- asm_server
For an Oracle source endpoint, your ASM server address.
You can set this value from the
asm_server
value. You setasm_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
-
- Type:
see
- database_name
Database name for the endpoint.
- port
Endpoint TCP 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
. ThisSecretsManagerOracleAsmSecret
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* .
- 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.
- secrets_manager_security_db_encryption_access_role_arn
-
- Type:
see
- secrets_manager_security_db_encryption_secret_id
-
- 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.
PostgreSqlSettingsProperty
- class CfnDataProvider.PostgreSqlSettingsProperty(*, database_name, port, server_name, ssl_mode, certificate_arn=None)
Bases:
object
Provides information that defines a PostgreSQL endpoint.
- Parameters:
database_name (
str
) – Database name for the endpoint.port (
Union
[int
,float
]) – Endpoint TCP port. The default is 5432.server_name (
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 theEndpoint
field.ssl_mode (
str
) –certificate_arn (
Optional
[str
]) –
- See:
- 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 postgre_sql_settings_property = dms.CfnDataProvider.PostgreSqlSettingsProperty( database_name="databaseName", port=123, server_name="serverName", ssl_mode="sslMode", # the properties below are optional certificate_arn="certificateArn" )
Attributes
- certificate_arn
-
- Type:
see
- database_name
Database name for the endpoint.
- port
Endpoint TCP port.
The default is 5432.
- 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.
RedshiftSettingsProperty
- class CfnDataProvider.RedshiftSettingsProperty(*, database_name, port, server_name)
Bases:
object
Provides information that defines an Amazon Redshift endpoint.
- Parameters:
database_name (
str
) – The name of the Amazon Redshift data warehouse (service) that you are working with.port (
Union
[int
,float
]) – The port number for Amazon Redshift. The default value is 5439.server_name (
str
) – The name of the Amazon Redshift cluster you are using.
- See:
- 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 redshift_settings_property = dms.CfnDataProvider.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.
- port
The port number for Amazon Redshift.
The default value is 5439.
- server_name
The name of the Amazon Redshift cluster you are using.
SettingsProperty
- class CfnDataProvider.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:
- 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 settings_property = 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" ) )
Attributes
- doc_db_settings
DocDbSettings property identifier.
- ibm_db2_luw_settings
IbmDb2LuwSettings property identifier.
- ibm_db2_z_os_settings
IbmDb2zOsSettings property identifier.
- maria_db_settings
MariaDbSettings property identifier.
- microsoft_sql_server_settings
MicrosoftSqlServerSettings property identifier.
- mongo_db_settings
MongoDbSettings property identifier.
- my_sql_settings
MySqlSettings property identifier.
- oracle_settings
OracleSettings property identifier.
- postgre_sql_settings
PostgreSqlSettings property identifier.
- redshift_settings
RedshiftSettings property identifier.