Package software.amazon.awscdk.services.dms

Class CfnDataProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dms.CfnDataProvider
All Implemented Interfaces:
IInspectable, ITaggableV2, IDataProviderRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:35.014Z") @Stability(Stable) public class CfnDataProvider extends CfnResource implements IInspectable, IDataProviderRef, ITaggableV2
Provides information that defines a data provider.

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.*;
 CfnDataProvider cfnDataProvider = CfnDataProvider.Builder.create(this, "MyCfnDataProvider")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataProvider

      protected CfnDataProvider(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataProvider

      protected CfnDataProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataProvider

      @Stability(Stable) public CfnDataProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataProviderProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDataProviderArn

      @Stability(Stable) @NotNull public String getAttrDataProviderArn()
      The Amazon Resource Name (ARN) string that uniquely identifies the data provider.

    • getAttrDataProviderCreationTime

      @Stability(Stable) @NotNull public String getAttrDataProviderCreationTime()
      The time the data provider was created.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDataProviderRef

      @Stability(Stable) @NotNull public DataProviderReference getDataProviderRef()
      A reference to a DataProvider resource.
      Specified by:
      getDataProviderRef in interface IDataProviderRef

    • getEngine

      @Stability(Stable) @NotNull public String getEngine()
      The type of database engine for the data provider.

    • setEngine

      @Stability(Stable) public void setEngine(@NotNull String value)
      The type of database engine for the data provider.

    • getDataProviderIdentifier

      @Stability(Stable) @Nullable public String getDataProviderIdentifier()
      The identifier of the data provider.

    • setDataProviderIdentifier

      @Stability(Stable) public void setDataProviderIdentifier(@Nullable String value)
      The identifier of the data provider.

    • getDataProviderName

      @Stability(Stable) @Nullable public String getDataProviderName()
      The name of the data provider.

    • setDataProviderName

      @Stability(Stable) public void setDataProviderName(@Nullable String value)
      The name of the data provider.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the data provider.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the data provider.

    • getExactSettings

      @Stability(Stable) @Nullable public Object getExactSettings()
      The property describes the exact settings which can be modified.

      Returns union: either Boolean or IResolvable

    • setExactSettings

      @Stability(Stable) public void setExactSettings(@Nullable Boolean value)
      The property describes the exact settings which can be modified.

    • setExactSettings

      @Stability(Stable) public void setExactSettings(@Nullable IResolvable value)
      The property describes the exact settings which can be modified.

    • getSettings

      @Stability(Stable) @Nullable public Object getSettings()
      The settings in JSON format for a data provider.

      Returns union: either IResolvable or CfnDataProvider.SettingsProperty

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable IResolvable value)
      The settings in JSON format for a data provider.

    • setSettings

      @Stability(Stable) public void setSettings(@Nullable CfnDataProvider.SettingsProperty value)
      The settings in JSON format for a data provider.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.