Package software.amazon.awscdk.services.datazone

Interface CfnDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-03-04T22:57:22.400Z")
@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:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourceProps.Builder	builder()
default Object	getAssetFormsInput()	The metadata forms attached to the assets that the data source works with.
default Object	getConfiguration()	The configuration of the data source.
default String	getConnectionIdentifier()	The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.
default String	getDescription()	The description of the data source.
String	getDomainIdentifier()	The ID of the Amazon DataZone domain where the data source is created.
default String	getEnableSetting()	Specifies whether the data source is enabled.
default 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.
default Object	getPublishOnImport()	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
default Object	getRecommendation()	Specifies whether the business name generation is to be enabled for this data source.
default Object	getSchedule()	The schedule of the data source runs.
String	getType()	The type of the data source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDomainIdentifier

@Stability(Stable)
@NotNull
String getDomainIdentifier()

The ID of the Amazon DataZone domain where the data source is created.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the data source.

See Also:

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

getProjectIdentifier

@Stability(Stable)
@NotNull
String getProjectIdentifier()

The identifier of the Amazon DataZone project in which you want to add this data source.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

The type of the data source.

See Also:

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

getAssetFormsInput

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

The metadata forms attached to the assets that the data source works with.

See Also:

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

getConfiguration

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

The configuration of the data source.

See Also:

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

getConnectionIdentifier

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

The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.

See Also:

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

getDescription

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

The description of the data source.

See Also:

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

getEnableSetting

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

Specifies whether the data source is enabled.

See Also:

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

getEnvironmentIdentifier

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

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

See Also:

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

getPublishOnImport

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

Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.

See Also:

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

getRecommendation

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

Specifies whether the business name generation is to be enabled for this data source.

See Also:

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

getSchedule

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

The schedule of the data source runs.

See Also:

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

builder

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

Returns:

a CfnDataSourceProps.Builder of CfnDataSourceProps