Package software.amazon.awscdk.services.datazone

Class CfnDataSource

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.datazone.CfnDataSource
All Implemented Interfaces:
IInspectable, IDataSourceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:36.069Z") @Stability(Stable) public class CfnDataSource extends CfnResource implements IInspectable, IDataSourceRef
The AWS::DataZone::DataSource resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.

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.datazone.*;
 CfnDataSource cfnDataSource = CfnDataSource.Builder.create(this, "MyCfnDataSource")
         .domainIdentifier("domainIdentifier")
         .name("name")
         .projectIdentifier("projectIdentifier")
         .type("type")
         // the properties below are optional
         .assetFormsInput(List.of(FormInputProperty.builder()
                 .formName("formName")
                 // the properties below are optional
                 .content("content")
                 .typeIdentifier("typeIdentifier")
                 .typeRevision("typeRevision")
                 .build()))
         .configuration(DataSourceConfigurationInputProperty.builder()
                 .glueRunConfiguration(GlueRunConfigurationInputProperty.builder()
                         .relationalFilterConfigurations(List.of(RelationalFilterConfigurationProperty.builder()
                                 .databaseName("databaseName")
                                 // the properties below are optional
                                 .filterExpressions(List.of(FilterExpressionProperty.builder()
                                         .expression("expression")
                                         .type("type")
                                         .build()))
                                 .schemaName("schemaName")
                                 .build()))
                         // the properties below are optional
                         .autoImportDataQualityResult(false)
                         .catalogName("catalogName")
                         .dataAccessRole("dataAccessRole")
                         .build())
                 .redshiftRunConfiguration(RedshiftRunConfigurationInputProperty.builder()
                         .relationalFilterConfigurations(List.of(RelationalFilterConfigurationProperty.builder()
                                 .databaseName("databaseName")
                                 // the properties below are optional
                                 .filterExpressions(List.of(FilterExpressionProperty.builder()
                                         .expression("expression")
                                         .type("type")
                                         .build()))
                                 .schemaName("schemaName")
                                 .build()))
                         // the properties below are optional
                         .dataAccessRole("dataAccessRole")
                         .redshiftCredentialConfiguration(RedshiftCredentialConfigurationProperty.builder()
                                 .secretManagerArn("secretManagerArn")
                                 .build())
                         .redshiftStorage(RedshiftStorageProperty.builder()
                                 .redshiftClusterSource(RedshiftClusterStorageProperty.builder()
                                         .clusterName("clusterName")
                                         .build())
                                 .redshiftServerlessSource(RedshiftServerlessStorageProperty.builder()
                                         .workgroupName("workgroupName")
                                         .build())
                                 .build())
                         .build())
                 .sageMakerRunConfiguration(SageMakerRunConfigurationInputProperty.builder()
                         .trackingAssets(Map.of(
                                 "trackingAssetsKey", List.of("trackingAssets")))
                         .build())
                 .build())
         .connectionIdentifier("connectionIdentifier")
         .description("description")
         .enableSetting("enableSetting")
         .environmentIdentifier("environmentIdentifier")
         .publishOnImport(false)
         .recommendation(RecommendationConfigurationProperty.builder()
                 .enableBusinessNameGeneration(false)
                 .build())
         .schedule(ScheduleConfigurationProperty.builder()
                 .schedule("schedule")
                 .timezone("timezone")
                 .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

    • CfnDataSource

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

    • CfnDataSource

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

    • CfnDataSource

      @Stability(Stable) public CfnDataSource(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataSourceProps 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.

    • getAttrConnectionId

      @Stability(Stable) @NotNull public String getAttrConnectionId()
      The connection ID that's part of the data source summary.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp of when the data source was created.

    • getAttrDomainId

      @Stability(Stable) @NotNull public String getAttrDomainId()
      The ID of the Amazon DataZone domain in which the data source exists.

    • getAttrEnvironmentId

      @Stability(Stable) @NotNull public String getAttrEnvironmentId()
      The ID of the environment in which the data source exists.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The identifier of the data source run.

    • getAttrLastRunAssetCount

      @Stability(Stable) @NotNull public IResolvable getAttrLastRunAssetCount()
      The count of the assets created during the last data source run.

    • getAttrLastRunAt

      @Stability(Stable) @NotNull public String getAttrLastRunAt()
      The timestamp of when the data source run was last performed.

    • getAttrLastRunStatus

      @Stability(Stable) @NotNull public String getAttrLastRunStatus()
      The status of the last data source run.

    • getAttrProjectId

      @Stability(Stable) @NotNull public String getAttrProjectId()
      The project ID included in the data source run activity.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the data source.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp of when the data source was updated.

    • getCfnProperties

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

    • getDataSourceRef

      @Stability(Stable) @NotNull public DataSourceReference getDataSourceRef()
      A reference to a DataSource resource.
      Specified by:
      getDataSourceRef in interface IDataSourceRef

    • getDomainIdentifier

      @Stability(Stable) @NotNull public String getDomainIdentifier()
      The ID of the Amazon DataZone domain where the data source is created.

    • setDomainIdentifier

      @Stability(Stable) public void setDomainIdentifier(@NotNull String value)
      The ID of the Amazon DataZone domain where the data source is created.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the data source.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the data source.

    • getProjectIdentifier

      @Stability(Stable) @NotNull public String getProjectIdentifier()
      The identifier of the Amazon DataZone project in which you want to add this data source.

    • setProjectIdentifier

      @Stability(Stable) public void setProjectIdentifier(@NotNull String value)
      The identifier of the Amazon DataZone project in which you want to add this data source.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the data source.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the data source.

    • getAssetFormsInput

      @Stability(Stable) @Nullable public Object getAssetFormsInput()
      The metadata forms attached to the assets that the data source works with.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.FormInputProperty>

    • setAssetFormsInput

      @Stability(Stable) public void setAssetFormsInput(@Nullable IResolvable value)
      The metadata forms attached to the assets that the data source works with.

    • setAssetFormsInput

      @Stability(Stable) public void setAssetFormsInput(@Nullable List<Object> value)
      The metadata forms attached to the assets that the data source works with.

    • getConfiguration

      @Stability(Stable) @Nullable public Object getConfiguration()
      The configuration of the data source.

      Returns union: either IResolvable or CfnDataSource.DataSourceConfigurationInputProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable IResolvable value)
      The configuration of the data source.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@Nullable CfnDataSource.DataSourceConfigurationInputProperty value)
      The configuration of the data source.

    • getConnectionIdentifier

      @Stability(Stable) @Nullable public String getConnectionIdentifier()
      The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.

    • setConnectionIdentifier

      @Stability(Stable) public void setConnectionIdentifier(@Nullable String value)
      The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the data source.

    • setDescription

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

    • getEnableSetting

      @Stability(Stable) @Nullable public String getEnableSetting()
      Specifies whether the data source is enabled.

    • setEnableSetting

      @Stability(Stable) public void setEnableSetting(@Nullable String value)
      Specifies whether the data source is enabled.

    • getEnvironmentIdentifier

      @Stability(Stable) @Nullable public String getEnvironmentIdentifier()
      The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

    • setEnvironmentIdentifier

      @Stability(Stable) public void setEnvironmentIdentifier(@Nullable String value)
      The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

    • getPublishOnImport

      @Stability(Stable) @Nullable public Object getPublishOnImport()
      Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

      Returns union: either Boolean or IResolvable

    • setPublishOnImport

      @Stability(Stable) public void setPublishOnImport(@Nullable Boolean value)
      Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

    • setPublishOnImport

      @Stability(Stable) public void setPublishOnImport(@Nullable IResolvable value)
      Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

    • getRecommendation

      @Stability(Stable) @Nullable public Object getRecommendation()
      Specifies whether the business name generation is to be enabled for this data source.

      Returns union: either IResolvable or CfnDataSource.RecommendationConfigurationProperty

    • setRecommendation

      @Stability(Stable) public void setRecommendation(@Nullable IResolvable value)
      Specifies whether the business name generation is to be enabled for this data source.

    • setRecommendation

      @Stability(Stable) public void setRecommendation(@Nullable CfnDataSource.RecommendationConfigurationProperty value)
      Specifies whether the business name generation is to be enabled for this data source.

    • getSchedule

      @Stability(Stable) @Nullable public Object getSchedule()
      The schedule of the data source runs.

      Returns union: either IResolvable or CfnDataSource.ScheduleConfigurationProperty

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable IResolvable value)
      The schedule of the data source runs.

    • setSchedule

      @Stability(Stable) public void setSchedule(@Nullable CfnDataSource.ScheduleConfigurationProperty value)
      The schedule of the data source runs.