Interface CfnDataSourceProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSourceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-10T13:40:01.958Z")
@Stability(Stable)
public interface CfnDataSourceProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnDataSource.
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.*;
CfnDataSourceProps cfnDataSourceProps = CfnDataSourceProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDataSourcePropsstatic final classAn implementation forCfnDataSourceProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDataSourceProps.Builderbuilder()default ObjectThe metadata forms attached to the assets that the data source works with.default ObjectThe configuration of the data source.default StringThe unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.default StringThe description of the data source.The ID of the Amazon DataZone domain where the data source is created.default StringSpecifies whether the data source is enabled.default StringThe unique identifier of the Amazon DataZone environment to which the data source publishes assets.getName()The name of the data source.The identifier of the Amazon DataZone project in which you want to add this data source.default ObjectSpecifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.default ObjectSpecifies whether the business name generation is to be enabled for this data source.default ObjectThe schedule of the data source runs.getType()The type of the data source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDomainIdentifier
The ID of the Amazon DataZone domain where the data source is created.- See Also:
-
getName
The name of the data source.- See Also:
-
getProjectIdentifier
The identifier of the Amazon DataZone project in which you want to add this data source.- See Also:
-
getType
The type of the data source.In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for AWS Glue and Amazon Redshift.
- See Also:
-
getAssetFormsInput
The metadata forms attached to the assets that the data source works with.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDataSource.FormInputProperty>- See Also:
-
getConfiguration
The configuration of the data source.Returns union: either
IResolvableorCfnDataSource.DataSourceConfigurationInputProperty- See Also:
-
getConnectionIdentifier
The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.- See Also:
-
getDescription
The description of the data source.- See Also:
-
getEnableSetting
Specifies whether the data source is enabled.- See Also:
-
getEnvironmentIdentifier
The unique identifier of the Amazon DataZone environment to which the data source publishes assets.- See Also:
-
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
BooleanorIResolvable- See Also:
-
getRecommendation
Specifies whether the business name generation is to be enabled for this data source.Returns union: either
IResolvableorCfnDataSource.RecommendationConfigurationProperty- See Also:
-
getSchedule
The schedule of the data source runs.Returns union: either
IResolvableorCfnDataSource.ScheduleConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnDataSourceProps.BuilderofCfnDataSourceProps
-