Class CfnDataset
A CloudFormation AWS::DataBrew::Dataset
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.AWS.DataBrew.dll
Syntax (csharp)
public class CfnDataset : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDataset
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a new DataBrew dataset.
CloudformationResource: AWS::DataBrew::Dataset
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-dataset.html
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.DataBrew;
var cfnDataset = new CfnDataset(this, "MyCfnDataset", new CfnDatasetProps {
Input = new InputProperty {
DatabaseInputDefinition = new DatabaseInputDefinitionProperty {
GlueConnectionName = "glueConnectionName",
// the properties below are optional
DatabaseTableName = "databaseTableName",
QueryString = "queryString",
TempDirectory = new S3LocationProperty {
Bucket = "bucket",
// the properties below are optional
Key = "key"
}
},
DataCatalogInputDefinition = new DataCatalogInputDefinitionProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
TableName = "tableName",
TempDirectory = new S3LocationProperty {
Bucket = "bucket",
// the properties below are optional
Key = "key"
}
},
Metadata = new MetadataProperty {
SourceArn = "sourceArn"
},
S3InputDefinition = new S3LocationProperty {
Bucket = "bucket",
// the properties below are optional
Key = "key"
}
},
Name = "name",
// the properties below are optional
Format = "format",
FormatOptions = new FormatOptionsProperty {
Csv = new CsvOptionsProperty {
Delimiter = "delimiter",
HeaderRow = false
},
Excel = new ExcelOptionsProperty {
HeaderRow = false,
SheetIndexes = new [] { 123 },
SheetNames = new [] { "sheetNames" }
},
Json = new JsonOptionsProperty {
MultiLine = false
}
},
PathOptions = new PathOptionsProperty {
FilesLimit = new FilesLimitProperty {
MaxFiles = 123,
// the properties below are optional
Order = "order",
OrderedBy = "orderedBy"
},
LastModifiedDateCondition = new FilterExpressionProperty {
Expression = "expression",
ValuesMap = new [] { new FilterValueProperty {
Value = "value",
ValueReference = "valueReference"
} }
},
Parameters = new [] { new PathParameterProperty {
DatasetParameter = new DatasetParameterProperty {
Name = "name",
Type = "type",
// the properties below are optional
CreateColumn = false,
DatetimeOptions = new DatetimeOptionsProperty {
Format = "format",
// the properties below are optional
LocaleCode = "localeCode",
TimezoneOffset = "timezoneOffset"
},
Filter = new FilterExpressionProperty {
Expression = "expression",
ValuesMap = new [] { new FilterValueProperty {
Value = "value",
ValueReference = "valueReference"
} }
}
},
PathParameterName = "pathParameterName"
} }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDataset(Construct, String, ICfnDatasetProps) | Create a new |
CfnDataset(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataset(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Format | The file format of a dataset that is created from an Amazon S3 file or folder. |
FormatOptions | A set of options that define how DataBrew interprets the data in the dataset. |
Input | Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 . |
Name | The unique name of the dataset. |
PathOptions | A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset. |
Tags | Metadata tags that have been applied to the dataset. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataset(Construct, String, ICfnDatasetProps)
Create a new AWS::DataBrew::Dataset
.
public CfnDataset(Construct scope, string id, ICfnDatasetProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatasetProps
- resource properties.
CfnDataset(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataset(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataset(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataset(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Format
The file format of a dataset that is created from an Amazon S3 file or folder.
public virtual string Format { get; set; }
Property Value
System.String
Remarks
FormatOptions
A set of options that define how DataBrew interprets the data in the dataset.
public virtual object FormatOptions { get; set; }
Property Value
System.Object
Remarks
Input
Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog or Amazon S3 .
public virtual object Input { get; set; }
Property Value
System.Object
Remarks
Name
The unique name of the dataset.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
PathOptions
A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.
public virtual object PathOptions { get; set; }
Property Value
System.Object
Remarks
Tags
Metadata tags that have been applied to the dataset.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>