Interface ICfnDataSourceProps

Properties for defining a CfnDataSource.

Namespace: Amazon.CDK.AWS.DataZone

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDataSourceProps

Syntax (vb)

Public Interface ICfnDataSourceProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.DataZone;

             var cfnDataSourceProps = new CfnDataSourceProps {
                 DomainIdentifier = "domainIdentifier",
                 Name = "name",
                 ProjectIdentifier = "projectIdentifier",
                 Type = "type",

                 // the properties below are optional
                 AssetFormsInput = new [] { new FormInputProperty {
                     FormName = "formName",

                     // the properties below are optional
                     Content = "content",
                     TypeIdentifier = "typeIdentifier",
                     TypeRevision = "typeRevision"
                 } },
                 Configuration = new DataSourceConfigurationInputProperty {
                     GlueRunConfiguration = new GlueRunConfigurationInputProperty {
                         RelationalFilterConfigurations = new [] { new RelationalFilterConfigurationProperty {
                             DatabaseName = "databaseName",

                             // the properties below are optional
                             FilterExpressions = new [] { new FilterExpressionProperty {
                                 Expression = "expression",
                                 Type = "type"
                             } },
                             SchemaName = "schemaName"
                         } },

                         // the properties below are optional
                         AutoImportDataQualityResult = false,
                         CatalogName = "catalogName",
                         DataAccessRole = "dataAccessRole"
                     },
                     RedshiftRunConfiguration = new RedshiftRunConfigurationInputProperty {
                         RelationalFilterConfigurations = new [] { new RelationalFilterConfigurationProperty {
                             DatabaseName = "databaseName",

                             // the properties below are optional
                             FilterExpressions = new [] { new FilterExpressionProperty {
                                 Expression = "expression",
                                 Type = "type"
                             } },
                             SchemaName = "schemaName"
                         } },

                         // the properties below are optional
                         DataAccessRole = "dataAccessRole",
                         RedshiftCredentialConfiguration = new RedshiftCredentialConfigurationProperty {
                             SecretManagerArn = "secretManagerArn"
                         },
                         RedshiftStorage = new RedshiftStorageProperty {
                             RedshiftClusterSource = new RedshiftClusterStorageProperty {
                                 ClusterName = "clusterName"
                             },
                             RedshiftServerlessSource = new RedshiftServerlessStorageProperty {
                                 WorkgroupName = "workgroupName"
                             }
                         }
                     },
                     SageMakerRunConfiguration = new SageMakerRunConfigurationInputProperty {
                         TrackingAssets = new Dictionary<string, string[]> {
                             { "trackingAssetsKey", new [] { "trackingAssets" } }
                         }
                     }
                 },
                 ConnectionIdentifier = "connectionIdentifier",
                 Description = "description",
                 EnableSetting = "enableSetting",
                 EnvironmentIdentifier = "environmentIdentifier",
                 PublishOnImport = false,
                 Recommendation = new RecommendationConfigurationProperty {
                     EnableBusinessNameGeneration = false
                 },
                 Schedule = new ScheduleConfigurationProperty {
                     Schedule = "schedule",
                     Timezone = "timezone"
                 }
             };

Synopsis

Properties

AssetFormsInput	The metadata forms attached to the assets that the data source works with.
Configuration	The configuration of the data source.
ConnectionIdentifier	The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.
Description	The description of the data source.
DomainIdentifier	The ID of the Amazon DataZone domain where the data source is created.
EnableSetting	Specifies whether the data source is enabled.
EnvironmentIdentifier	The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
Name	The name of the data source.
ProjectIdentifier	The identifier of the Amazon DataZone project in which you want to add this data source.
PublishOnImport	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
Recommendation	Specifies whether the business name generation is to be enabled for this data source.
Schedule	The schedule of the data source runs.
Type	The type of the data source.

Properties

AssetFormsInput

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

object? AssetFormsInput { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnDataSource.IFormInputProperty)[]

Configuration

The configuration of the data source.

object? Configuration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDataSource.IDataSourceConfigurationInputProperty

ConnectionIdentifier

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

string? ConnectionIdentifier { get; }

Property Value

string

Remarks

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

Description

The description of the data source.

string? Description { get; }

Property Value

string

Remarks

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

DomainIdentifier

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

string DomainIdentifier { get; }

Property Value

string

Remarks

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

EnableSetting

Specifies whether the data source is enabled.

string? EnableSetting { get; }

Property Value

string

Remarks

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

EnvironmentIdentifier

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

string? EnvironmentIdentifier { get; }

Property Value

string

Remarks

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

Name

The name of the data source.

string Name { get; }

Property Value

string

Remarks

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

ProjectIdentifier

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

string ProjectIdentifier { get; }

Property Value

string

Remarks

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

PublishOnImport

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

object? PublishOnImport { get; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

Recommendation

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

object? Recommendation { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDataSource.IRecommendationConfigurationProperty

Schedule

The schedule of the data source runs.

object? Schedule { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDataSource.IScheduleConfigurationProperty

Type

The type of the data source.

string Type { get; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-type