Package software.amazon.awscdk.services.dms

Interface CfnDataProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:35.022Z")
@Stability(Stable)
public interface CfnDataProviderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataProvider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnDataProviderProps cfnDataProviderProps = CfnDataProviderProps.builder()
         .engine("engine")
         // the properties below are optional
         .dataProviderIdentifier("dataProviderIdentifier")
         .dataProviderName("dataProviderName")
         .description("description")
         .exactSettings(false)
         .settings(SettingsProperty.builder()
                 .docDbSettings(DocDbSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .sslMode("sslMode")
                         .build())
                 .ibmDb2LuwSettings(IbmDb2LuwSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .ibmDb2ZOsSettings(IbmDb2zOsSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .mariaDbSettings(MariaDbSettingsProperty.builder()
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .microsoftSqlServerSettings(MicrosoftSqlServerSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .mongoDbSettings(MongoDbSettingsProperty.builder()
                         .port(123)
                         .serverName("serverName")
                         // the properties below are optional
                         .authMechanism("authMechanism")
                         .authSource("authSource")
                         .authType("authType")
                         .certificateArn("certificateArn")
                         .databaseName("databaseName")
                         .sslMode("sslMode")
                         .build())
                 .mySqlSettings(MySqlSettingsProperty.builder()
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .oracleSettings(OracleSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .asmServer("asmServer")
                         .certificateArn("certificateArn")
                         .secretsManagerOracleAsmAccessRoleArn("secretsManagerOracleAsmAccessRoleArn")
                         .secretsManagerOracleAsmSecretId("secretsManagerOracleAsmSecretId")
                         .secretsManagerSecurityDbEncryptionAccessRoleArn("secretsManagerSecurityDbEncryptionAccessRoleArn")
                         .secretsManagerSecurityDbEncryptionSecretId("secretsManagerSecurityDbEncryptionSecretId")
                         .build())
                 .postgreSqlSettings(PostgreSqlSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .sslMode("sslMode")
                         // the properties below are optional
                         .certificateArn("certificateArn")
                         .build())
                 .redshiftSettings(RedshiftSettingsProperty.builder()
                         .databaseName("databaseName")
                         .port(123)
                         .serverName("serverName")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataProviderProps.Builder	A builder for CfnDataProviderProps
static final class	CfnDataProviderProps.Jsii$Proxy	An implementation for CfnDataProviderProps

Method Summary

Modifier and Type	Method	Description
static CfnDataProviderProps.Builder	builder()
default String	getDataProviderIdentifier()	The identifier of the data provider.
default String	getDataProviderName()	The name of the data provider.
default String	getDescription()	A description of the data provider.
String	getEngine()	The type of database engine for the data provider.
default Object	getExactSettings()	The property describes the exact settings which can be modified.
default Object	getSettings()	The settings in JSON format for a data provider.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEngine

@Stability(Stable)
@NotNull
String getEngine()

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 Also:

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

getDataProviderIdentifier

@Stability(Stable)
@Nullable
default String getDataProviderIdentifier()

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 Also:

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

getDataProviderName

@Stability(Stable)
@Nullable
default String getDataProviderName()

The name of the data provider.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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 Also:

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

getExactSettings

@Stability(Stable)
@Nullable
default Object getExactSettings()

The property describes the exact settings which can be modified.

Returns union: either Boolean or IResolvable

Default: - false

See Also:

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

getSettings

@Stability(Stable)
@Nullable
default Object getSettings()

The settings in JSON format for a data provider.

Returns union: either IResolvable or CfnDataProvider.SettingsProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnDataProviderProps.Builder builder()

Returns:

a CfnDataProviderProps.Builder of CfnDataProviderProps