interface CfnDataSourceProps

Language	Type name
.NET	Amazon.CDK.aws_datazone.CfnDataSourceProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdatazone#CfnDataSourceProps
Java	software.amazon.awscdk.services.datazone.CfnDataSourceProps
Python	aws_cdk.aws_datazone.CfnDataSourceProps
TypeScript	aws-cdk-lib » aws_datazone » CfnDataSourceProps

Properties for defining a CfnDataSource.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datazone as datazone } from 'aws-cdk-lib';
const cfnDataSourceProps: datazone.CfnDataSourceProps = {
  domainIdentifier: 'domainIdentifier',
  environmentIdentifier: 'environmentIdentifier',
  name: 'name',
  projectIdentifier: 'projectIdentifier',
  type: 'type',

  // the properties below are optional
  assetFormsInput: [{
    formName: 'formName',

    // the properties below are optional
    content: 'content',
    typeIdentifier: 'typeIdentifier',
    typeRevision: 'typeRevision',
  }],
  configuration: {
    glueRunConfiguration: {
      relationalFilterConfigurations: [{
        databaseName: 'databaseName',

        // the properties below are optional
        filterExpressions: [{
          expression: 'expression',
          type: 'type',
        }],
        schemaName: 'schemaName',
      }],

      // the properties below are optional
      autoImportDataQualityResult: false,
      dataAccessRole: 'dataAccessRole',
    },
    redshiftRunConfiguration: {
      redshiftCredentialConfiguration: {
        secretManagerArn: 'secretManagerArn',
      },
      redshiftStorage: {
        redshiftClusterSource: {
          clusterName: 'clusterName',
        },
        redshiftServerlessSource: {
          workgroupName: 'workgroupName',
        },
      },
      relationalFilterConfigurations: [{
        databaseName: 'databaseName',

        // the properties below are optional
        filterExpressions: [{
          expression: 'expression',
          type: 'type',
        }],
        schemaName: 'schemaName',
      }],

      // the properties below are optional
      dataAccessRole: 'dataAccessRole',
    },
  },
  description: 'description',
  enableSetting: 'enableSetting',
  publishOnImport: false,
  recommendation: {
    enableBusinessNameGeneration: false,
  },
  schedule: {
    schedule: 'schedule',
    timezone: 'timezone',
  },
};

Properties

Name	Type	Description
domainIdentifier	string	The ID of the Amazon DataZone domain where the data source is created.
environmentIdentifier	string	The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
name	string	The name of the data source.
projectIdentifier	string	The identifier of the Amazon DataZone project in which you want to add this data source.
type	string	The type of the data source.
assetFormsInput?	IResolvable | IResolvable | FormInputProperty[]	The metadata forms attached to the assets that the data source works with.
configuration?	IResolvable | DataSourceConfigurationInputProperty	The configuration of the data source.
description?	string	The description of the data source.
enableSetting?	string	Specifies whether the data source is enabled.
publishOnImport?	boolean | IResolvable	Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
recommendation?	IResolvable | RecommendationConfigurationProperty	Specifies whether the business name generation is to be enabled for this data source.
schedule?	IResolvable | ScheduleConfigurationProperty	The schedule of the data source runs.

---

domainIdentifier

Type: string

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

---

environmentIdentifier

Type: string

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

---

name

Type: string

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

---

projectIdentifier

Type: string

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

---

type

Type: string

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

---

assetFormsInput?

Type: IResolvable | IResolvable | FormInputProperty[] (optional)

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

---

configuration?

Type: IResolvable | DataSourceConfigurationInputProperty (optional)

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

---

description?

Type: string (optional)

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

---

enableSetting?

Type: string (optional)

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

---

publishOnImport?

Type: boolean | IResolvable (optional)

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

---

recommendation?

Type: IResolvable | RecommendationConfigurationProperty (optional)

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

---

schedule?

Type: IResolvable | ScheduleConfigurationProperty (optional)

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