AWS::DataZone::DataSource - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::DataZone::DataSource

The AWS::DataZone::DataSourceresource 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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataZone::DataSource",
  "Properties" : {
      "AssetFormsInput" : [ FormInput, ... ],
      "Configuration" : DataSourceConfigurationInput,
      "Description" : String,
      "DomainIdentifier" : String,
      "EnableSetting" : String,
      "EnvironmentIdentifier" : String,
      "Name" : String,
      "ProjectIdentifier" : String,
      "PublishOnImport" : Boolean,
      "Recommendation" : RecommendationConfiguration,
      "Schedule" : ScheduleConfiguration,
      "Type" : String
    }
}

Properties

AssetFormsInput

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

Required: No

Type: Array of FormInput

Minimum: 0

Maximum: 10

Update requires: No interruption

Configuration

The configuration of the data source.

Required: No

Type: DataSourceConfigurationInput

Update requires: No interruption

Description

The description of the data source.

Required: No

Type: String

Maximum: 2048

Update requires: No interruption

DomainIdentifier

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

Required: Yes

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

EnableSetting

Specifies whether the data source is enabled.

Required: No

Type: String

Allowed values: ENABLED | DISABLED

Update requires: No interruption

EnvironmentIdentifier

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

Required: Yes

Type: String

Update requires: Replacement

Name

The name of the data source.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

ProjectIdentifier

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

Required: Yes

Type: String

Update requires: Replacement

PublishOnImport

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

Required: No

Type: Boolean

Update requires: No interruption

Recommendation

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

Required: No

Type: RecommendationConfiguration

Update requires: No interruption

Schedule

The schedule of the data source runs.

Required: No

Type: ScheduleConfiguration

Update requires: No interruption

Type

The type of the data source.

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainId and the DataSourceId, which uniquely identifies the data source. For example: { "Ref": "MyDataSource" } for the resource with the logical ID MyDataSource, Ref returns DomainId|DataSourceId.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The timestamp of when the data source was created.

DomainId

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

EnvironmentId

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

Id

The identifier of the data source run.

LastRunAssetCount

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

LastRunAt

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

LastRunStatus

The status of the last data source run.

ProjectId

The project ID included in the data source run activity.

Status

The status of the data source.

UpdatedAt

The timestamp of when the data source was updated.