Class CfnDataset

Represents an AWS Supply Chain data lake dataset.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDataset

Implements

IInspectable

IDatasetRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

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.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(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.SCN

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataset : CfnResource, IInspectable, IDatasetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnDataset Inherits CfnResource Implements IInspectable, IDatasetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

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.SCN;

             var cfnDataset = new CfnDataset(this, "MyCfnDataset", new CfnDatasetProps {
                 InstanceId = "instanceId",
                 Name = "name",
                 Namespace = "namespace",

                 // the properties below are optional
                 Description = "description",
                 PartitionSpec = new PartitionSpecProperty {
                     Fields = new [] { new DataLakeDatasetPartitionFieldProperty {
                         Name = "name",
                         Transform = new TransformProperty {
                             Type = "type"
                         }
                     } }
                 },
                 Schema = new SchemaProperty {
                     Fields = new [] { new DataLakeDatasetSchemaFieldProperty {
                         IsRequired = false,
                         Name = "name",
                         Type = "type"
                     } },
                     Name = "name",

                     // the properties below are optional
                     PrimaryKeys = new [] { new DataLakeDatasetPrimaryKeyFieldProperty {
                         Name = "name"
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnDataset(Construct, string, ICfnDatasetProps)

Create a new AWS::SCN::Dataset.

Properties

AttrArn	The Amazon Resource Name (ARN) of the dataset.
AttrCreatedTime	The creation time of the dataset.
AttrLastModifiedTime	The last modified time of the dataset.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Represents an AWS Supply Chain data lake dataset.
CfnPropertyNames	Represents an AWS Supply Chain data lake dataset.
DatasetRef	A reference to a Dataset resource.
Description	The description of the dataset.
InstanceId	The Amazon Web Services Supply Chain instance identifier.
Name	The name of the dataset.
Namespace	The namespace of the dataset.
PartitionSpec	The partition specification of the dataset.
Schema	The schema of the dataset.
Tags	The tags for the dataset.

Methods

ArnForDataset(IDatasetRef)	Represents an AWS Supply Chain data lake dataset.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnDataset(object)	Checks whether the given object is a CfnDataset.
RenderProperties(IDictionary<string, object>)	Represents an AWS Supply Chain data lake dataset.

Constructors

CfnDataset(Construct, string, ICfnDatasetProps)

Create a new AWS::SCN::Dataset.

public CfnDataset(Construct scope, string id, ICfnDatasetProps props)

Parameters

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

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the dataset.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedTime

The creation time of the dataset.

public virtual string AttrCreatedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedTime

AttrLastModifiedTime

The last modified time of the dataset.

public virtual string AttrLastModifiedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: LastModifiedTime

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-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

CfnProperties

Represents an AWS Supply Chain data lake dataset.

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

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

CfnPropertyNames

Represents an AWS Supply Chain data lake dataset.

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-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

DatasetRef

A reference to a Dataset resource.

public virtual IDatasetReference DatasetRef { get; }

Property Value

IDatasetReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

Description

The description of the dataset.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

InstanceId

The Amazon Web Services Supply Chain instance identifier.

public virtual string InstanceId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

Name

The name of the dataset.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

Namespace

The namespace of the dataset.

public virtual string Namespace { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

PartitionSpec

The partition specification of the dataset.

public virtual object? PartitionSpec { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataset.IPartitionSpecProperty

Schema

The schema of the dataset.

public virtual object? Schema { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDataset.ISchemaProperty

Methods

ArnForDataset(IDatasetRef)

Represents an AWS Supply Chain data lake dataset.

public static string ArnForDataset(IDatasetRef resource)

Parameters

resource IDatasetRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

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.SCN;

             var cfnDataset = new CfnDataset(this, "MyCfnDataset", new CfnDatasetProps {
                 InstanceId = "instanceId",
                 Name = "name",
                 Namespace = "namespace",

                 // the properties below are optional
                 Description = "description",
                 PartitionSpec = new PartitionSpecProperty {
                     Fields = new [] { new DataLakeDatasetPartitionFieldProperty {
                         Name = "name",
                         Transform = new TransformProperty {
                             Type = "type"
                         }
                     } }
                 },
                 Schema = new SchemaProperty {
                     Fields = new [] { new DataLakeDatasetSchemaFieldProperty {
                         IsRequired = false,
                         Name = "name",
                         Type = "type"
                     } },
                     Name = "name",

                     // the properties below are optional
                     PrimaryKeys = new [] { new DataLakeDatasetPrimaryKeyFieldProperty {
                         Name = "name"
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

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-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

IsCfnDataset(object)

Checks whether the given object is a CfnDataset.

public static bool IsCfnDataset(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Represents an AWS Supply Chain data lake dataset.

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-scn-dataset.html

CloudformationResource: AWS::SCN::Dataset

ExampleMetadata: fixture=_generated

Implements

IInspectable

IDatasetRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2