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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:16.925Z")
@Stability(Stable)
public class CfnDataSource
extends CfnResource
implements IInspectable

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")
         .environmentIdentifier("environmentIdentifier")
         .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)
                         .dataAccessRole("dataAccessRole")
                         .build())
                 .redshiftRunConfiguration(RedshiftRunConfigurationInputProperty.builder()
                         .redshiftCredentialConfiguration(RedshiftCredentialConfigurationProperty.builder()
                                 .secretManagerArn("secretManagerArn")
                                 .build())
                         .redshiftStorage(RedshiftStorageProperty.builder()
                                 .redshiftClusterSource(RedshiftClusterStorageProperty.builder()
                                         .clusterName("clusterName")
                                         .build())
                                 .redshiftServerlessSource(RedshiftServerlessStorageProperty.builder()
                                         .workgroupName("workgroupName")
                                         .build())
                                 .build())
                         .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")
                         .build())
                 .build())
         .description("description")
         .enableSetting("enableSetting")
         .publishOnImport(false)
         .recommendation(RecommendationConfigurationProperty.builder()
                 .enableBusinessNameGeneration(false)
                 .build())
         .schedule(ScheduleConfigurationProperty.builder()
                 .schedule("schedule")
                 .timezone("timezone")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDataSource.Builder	A fluent builder for CfnDataSource.
static interface	CfnDataSource.DataSourceConfigurationInputProperty	The configuration of the data source.
static interface	CfnDataSource.FilterExpressionProperty	A filter expression in Amazon DataZone.
static interface	CfnDataSource.FormInputProperty	The details of a metadata form.
static interface	CfnDataSource.GlueRunConfigurationInputProperty	The configuration details of the AWS Glue data source.
static interface	CfnDataSource.RecommendationConfigurationProperty	The recommendation configuration for the data source.
static interface	CfnDataSource.RedshiftClusterStorageProperty	The details of the Amazon Redshift cluster storage.
static interface	CfnDataSource.RedshiftCredentialConfigurationProperty	The details of the credentials required to access an Amazon Redshift cluster.
static interface	CfnDataSource.RedshiftRunConfigurationInputProperty	The relational filter configurations included in the configuration details of the Amazon Redshift data source.
static interface	CfnDataSource.RedshiftServerlessStorageProperty	The details of the Amazon Redshift Serverless workgroup storage.
static interface	CfnDataSource.RedshiftStorageProperty	The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
static interface	CfnDataSource.RelationalFilterConfigurationProperty	The relational filter configuration for the data source.
static interface	CfnDataSource.ScheduleConfigurationProperty	The details of the schedule of the data source runs.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataSource(software.constructs.Construct scope, String id, CfnDataSourceProps props)

Method Summary

Modifier and Type	Method	Description
Object	getAssetFormsInput()	The metadata forms attached to the assets that the data source works with.
String	getAttrCreatedAt()	The timestamp of when the data source was created.
String	getAttrDomainId()	The ID of the Amazon DataZone domain in which the data source exists.
String	getAttrEnvironmentId()	The ID of the environment in which the data source exists.
String	getAttrId()	The identifier of the data source run.
IResolvable	getAttrLastRunAssetCount()	The count of the assets created during the last data source run.
String	getAttrLastRunAt()	The timestamp of when the data source run was last performed.
String	getAttrLastRunStatus()	The status of the last data source run.
String	getAttrProjectId()	The project ID included in the data source run activity.
String	getAttrStatus()	The status of the data source.
String	getAttrUpdatedAt()	The timestamp of when the data source was updated.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	The configuration of the data source.
String	getDescription()	The description of the data source.
String	getDomainIdentifier()	The ID of the Amazon DataZone domain where the data source is created.
String	getEnableSetting()	Specifies whether the data source is enabled.
String	getEnvironmentIdentifier()	The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
String	getName()	The name of the data source.
String	getProjectIdentifier()	The identifier of the Amazon DataZone project in which you want to add this data source.
Object	getPublishOnImport()	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
Object	getRecommendation()	Specifies whether the business name generation is to be enabled for this data source.
Object	getSchedule()	The schedule of the data source runs.
String	getType()	The type of the data source.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssetFormsInput(List<Object> value)	The metadata forms attached to the assets that the data source works with.
void	setAssetFormsInput(IResolvable value)	The metadata forms attached to the assets that the data source works with.
void	setConfiguration(IResolvable value)	The configuration of the data source.
void	setConfiguration(CfnDataSource.DataSourceConfigurationInputProperty value)	The configuration of the data source.
void	setDescription(String value)	The description of the data source.
void	setDomainIdentifier(String value)	The ID of the Amazon DataZone domain where the data source is created.
void	setEnableSetting(String value)	Specifies whether the data source is enabled.
void	setEnvironmentIdentifier(String value)	The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
void	setName(String value)	The name of the data source.
void	setProjectIdentifier(String value)	The identifier of the Amazon DataZone project in which you want to add this data source.
void	setPublishOnImport(Boolean value)	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
void	setPublishOnImport(IResolvable value)	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
void	setRecommendation(IResolvable value)	Specifies whether the business name generation is to be enabled for this data source.
void	setRecommendation(CfnDataSource.RecommendationConfigurationProperty value)	Specifies whether the business name generation is to be enabled for this data source.
void	setSchedule(IResolvable value)	The schedule of the data source runs.
void	setSchedule(CfnDataSource.ScheduleConfigurationProperty value)	The schedule of the data source runs.
void	setType(String value)	The type of the data source.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

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

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.

getEnvironmentIdentifier

@Stability(Stable)
@NotNull
public String getEnvironmentIdentifier()

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

setEnvironmentIdentifier

@Stability(Stable)
public void setEnvironmentIdentifier(@NotNull
 String value)

The unique identifier of the Amazon DataZone environment to which the data source publishes assets.

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.

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.

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.

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.

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.

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.

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.

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.