Class CfnDataSource

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.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDataSource

Implements

IInspectable

IDataSourceRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataZone

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataSource : CfnResource, IInspectable, IDataSourceRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class CfnDataSource Inherits CfnResource Implements IInspectable, IDataSourceRef, IConstruct, IDependable, IEnvironmentAware

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", 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

Constructors

CfnDataSource(Construct, string, ICfnDataSourceProps)

Create a new AWS::DataZone::DataSource.

Properties

AssetFormsInput	The metadata forms attached to the assets that the data source works with.
AttrConnectionId	The connection ID that's part of the data source summary.
AttrCreatedAt	The timestamp of when the data source was created.
AttrDomainId	The ID of the Amazon DataZone domain in which the data source exists.
AttrEnvironmentId	The ID of the environment in which the data source exists.
AttrId	The identifier of the data source run.
AttrLastRunAssetCount	The count of the assets created during the last data source run.
AttrLastRunAt	The timestamp of when the data source run was last performed.
AttrLastRunStatus	The status of the last data source run.
AttrProjectId	The project ID included in the data source run activity.
AttrStatus	The status of the data source.
AttrUpdatedAt	The timestamp of when the data source was updated.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	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.
CfnPropertyNames	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.
Configuration	The configuration of the data source.
ConnectionIdentifier	The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.
DataSourceRef	A reference to a DataSource resource.
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.

Methods

ArnForDataSource(IDataSourceRef)	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.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDataSource(object)	Checks whether the given object is a CfnDataSource.
RenderProperties(IDictionary<string, object>)	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.

Constructors

CfnDataSource(Construct, string, ICfnDataSourceProps)

Create a new AWS::DataZone::DataSource.

public CfnDataSource(Construct scope, string id, ICfnDataSourceProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDataSourceProps

Resource properties.

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Properties

AssetFormsInput

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

public virtual object? AssetFormsInput { get; set; }

Property Value

object

Remarks

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

AttrConnectionId

The connection ID that's part of the data source summary.

public virtual string AttrConnectionId { get; }

Property Value

string

Remarks

CloudformationAttribute: ConnectionId

AttrCreatedAt

The timestamp of when the data source was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrDomainId

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

public virtual string AttrDomainId { get; }

Property Value

string

Remarks

CloudformationAttribute: DomainId

AttrEnvironmentId

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

public virtual string AttrEnvironmentId { get; }

Property Value

string

Remarks

CloudformationAttribute: EnvironmentId

AttrId

The identifier of the data source run.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrLastRunAssetCount

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

public virtual IResolvable AttrLastRunAssetCount { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: LastRunAssetCount

AttrLastRunAt

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

public virtual string AttrLastRunAt { get; }

Property Value

string

Remarks

CloudformationAttribute: LastRunAt

AttrLastRunStatus

The status of the last data source run.

public virtual string AttrLastRunStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: LastRunStatus

AttrProjectId

The project ID included in the data source run activity.

public virtual string AttrProjectId { get; }

Property Value

string

Remarks

CloudformationAttribute: ProjectId

AttrStatus

The status of the data source.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: Status

AttrUpdatedAt

The timestamp of when the data source was updated.

public virtual string AttrUpdatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: UpdatedAt

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

CfnProperties

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.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

CfnPropertyNames

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.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Configuration

The configuration of the data source.

public virtual object? Configuration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IDataSourceConfigurationInputProperty

ConnectionIdentifier

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

public virtual string? ConnectionIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

DataSourceRef

A reference to a DataSource resource.

public virtual IDataSourceReference DataSourceRef { get; }

Property Value

IDataSourceReference

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Description

The description of the data source.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

DomainIdentifier

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

public virtual string DomainIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

EnableSetting

Specifies whether the data source is enabled.

public virtual string? EnableSetting { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

EnvironmentIdentifier

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

public virtual string? EnvironmentIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Name

The name of the data source.

public virtual string Name { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

ProjectIdentifier

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

public virtual string ProjectIdentifier { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

PublishOnImport

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

public virtual object? PublishOnImport { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

Recommendation

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

public virtual object? Recommendation { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IRecommendationConfigurationProperty

Schedule

The schedule of the data source runs.

public virtual object? Schedule { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataSource.IScheduleConfigurationProperty

Type

The type of the data source.

public virtual string Type { get; set; }

Property Value

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Methods

ArnForDataSource(IDataSourceRef)

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.

public static string ArnForDataSource(IDataSourceRef resource)

Parameters

resource IDataSourceRef

Returns

string

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

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 cfnDataSource = new CfnDataSource(this, "MyCfnDataSource", 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"
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

IsCfnDataSource(object)

Checks whether the given object is a CfnDataSource.

public static bool IsCfnDataSource(object x)

Parameters

x object

Returns

bool

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

CloudformationResource: AWS::DataZone::DataSource

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDataSourceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware