class CfnDataSource (construct)

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

Implements IConstruct, IDependable, 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.

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 cfnDataSource = new datazone.CfnDataSource(this, 'MyCfnDataSource', {
  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',
  },
});

Initializer

new CfnDataSource(scope: Construct, id: string, props: CfnDataSourceProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnDataSourceProps — Resource properties.

Construct Props

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

Properties

Name	Type	Description
attrCreatedAt	string	The timestamp of when the data source was created.
attrDomainId	string	The ID of the Amazon DataZone domain in which the data source exists.
attrEnvironmentId	string	The ID of the environment in which the data source exists.
attrId	string	The identifier of the data source run.
attrLastRunAssetCount	IResolvable	The count of the assets created during the last data source run.
attrLastRunAt	string	The timestamp of when the data source run was last performed.
attrLastRunStatus	string	The status of the last data source run.
attrProjectId	string	The project ID included in the data source run activity.
attrStatus	string	The status of the data source.
attrUpdatedAt	string	The timestamp of when the data source was updated.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
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.
logicalId	string	The logical ID for this CloudFormation stack element.
name	string	The name of the data source.
node	Node	The tree node.
projectIdentifier	string	The identifier of the Amazon DataZone project in which you want to add this data source.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrCreatedAt

Type: string

The timestamp of when the data source was created.

---

attrDomainId

Type: string

The ID of the Amazon DataZone domain in which the data source exists.

---

attrEnvironmentId

Type: string

The ID of the environment in which the data source exists.

---

attrId

Type: string

The identifier of the data source run.

---

attrLastRunAssetCount

Type: IResolvable

The count of the assets created during the last data source run.

---

attrLastRunAt

Type: string

The timestamp of when the data source run was last performed.

---

attrLastRunStatus

Type: string

The status of the last data source run.

---

attrProjectId

Type: string

The project ID included in the data source run activity.

---

attrStatus

Type: string

The status of the data source.

---

attrUpdatedAt

Type: string

The timestamp of when the data source was updated.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

domainIdentifier

Type: string

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

---

environmentIdentifier

Type: string

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

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

name

Type: string

The name of the data source.

---

node

Type: Node

The tree node.

---

projectIdentifier

Type: string

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

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

type

Type: string

The type of the data source.

---

assetFormsInput?

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

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

---

configuration?

Type: IResolvable | DataSourceConfigurationInputProperty (optional)

The configuration of the data source.

---

description?

Type: string (optional)

The description of the data source.

---

enableSetting?

Type: string (optional)

Specifies whether the data source is enabled.

---

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.

---

recommendation?

Type: IResolvable | RecommendationConfigurationProperty (optional)

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

---

schedule?

Type: IResolvable | ScheduleConfigurationProperty (optional)

The schedule of the data source runs.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }