Class CfnJob

Specifies a new DataBrew job.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnJob

Implements

IInspectable

ITaggable

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.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.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.DataBrew

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnJob : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnJob Inherits CfnResource Implements IInspectable, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

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 cfnJob = new CfnJob(this, "MyCfnJob", new CfnJobProps {
                 Name = "name",
                 RoleArn = "roleArn",
                 Type = "type",

                 // the properties below are optional
                 DatabaseOutputs = new [] { new DatabaseOutputProperty {
                     DatabaseOptions = new DatabaseTableOutputOptionsProperty {
                         TableName = "tableName",

                         // the properties below are optional
                         TempDirectory = new S3LocationProperty {
                             Bucket = "bucket",

                             // the properties below are optional
                             BucketOwner = "bucketOwner",
                             Key = "key"
                         }
                     },
                     GlueConnectionName = "glueConnectionName",

                     // the properties below are optional
                     DatabaseOutputMode = "databaseOutputMode"
                 } },
                 DataCatalogOutputs = new [] { new DataCatalogOutputProperty {
                     DatabaseName = "databaseName",
                     TableName = "tableName",

                     // the properties below are optional
                     CatalogId = "catalogId",
                     DatabaseOptions = new DatabaseTableOutputOptionsProperty {
                         TableName = "tableName",

                         // the properties below are optional
                         TempDirectory = new S3LocationProperty {
                             Bucket = "bucket",

                             // the properties below are optional
                             BucketOwner = "bucketOwner",
                             Key = "key"
                         }
                     },
                     Overwrite = false,
                     S3Options = new S3TableOutputOptionsProperty {
                         Location = new S3LocationProperty {
                             Bucket = "bucket",

                             // the properties below are optional
                             BucketOwner = "bucketOwner",
                             Key = "key"
                         }
                     }
                 } },
                 DatasetName = "datasetName",
                 EncryptionKeyArn = "encryptionKeyArn",
                 EncryptionMode = "encryptionMode",
                 JobSample = new JobSampleProperty {
                     Mode = "mode",
                     Size = 123
                 },
                 LogSubscription = "logSubscription",
                 MaxCapacity = 123,
                 MaxRetries = 123,
                 OutputLocation = new OutputLocationProperty {
                     Bucket = "bucket",

                     // the properties below are optional
                     BucketOwner = "bucketOwner",
                     Key = "key"
                 },
                 Outputs = new [] { new OutputProperty {
                     Location = new S3LocationProperty {
                         Bucket = "bucket",

                         // the properties below are optional
                         BucketOwner = "bucketOwner",
                         Key = "key"
                     },

                     // the properties below are optional
                     CompressionFormat = "compressionFormat",
                     Format = "format",
                     FormatOptions = new OutputFormatOptionsProperty {
                         Csv = new CsvOutputOptionsProperty {
                             Delimiter = "delimiter"
                         }
                     },
                     MaxOutputFiles = 123,
                     Overwrite = false,
                     PartitionColumns = new [] { "partitionColumns" }
                 } },
                 ProfileConfiguration = new ProfileConfigurationProperty {
                     ColumnStatisticsConfigurations = new [] { new ColumnStatisticsConfigurationProperty {
                         Statistics = new StatisticsConfigurationProperty {
                             IncludedStatistics = new [] { "includedStatistics" },
                             Overrides = new [] { new StatisticOverrideProperty {
                                 Parameters = new Dictionary<string, string> {
                                     { "parametersKey", "parameters" }
                                 },
                                 Statistic = "statistic"
                             } }
                         },

                         // the properties below are optional
                         Selectors = new [] { new ColumnSelectorProperty {
                             Name = "name",
                             Regex = "regex"
                         } }
                     } },
                     DatasetStatisticsConfiguration = new StatisticsConfigurationProperty {
                         IncludedStatistics = new [] { "includedStatistics" },
                         Overrides = new [] { new StatisticOverrideProperty {
                             Parameters = new Dictionary<string, string> {
                                 { "parametersKey", "parameters" }
                             },
                             Statistic = "statistic"
                         } }
                     },
                     EntityDetectorConfiguration = new EntityDetectorConfigurationProperty {
                         EntityTypes = new [] { "entityTypes" },

                         // the properties below are optional
                         AllowedStatistics = new AllowedStatisticsProperty {
                             Statistics = new [] { "statistics" }
                         }
                     },
                     ProfileColumns = new [] { new ColumnSelectorProperty {
                         Name = "name",
                         Regex = "regex"
                     } }
                 },
                 ProjectName = "projectName",
                 Recipe = new RecipeProperty {
                     Name = "name",

                     // the properties below are optional
                     Version = "version"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Timeout = 123,
                 ValidationConfigurations = new [] { new ValidationConfigurationProperty {
                     RulesetArn = "rulesetArn",

                     // the properties below are optional
                     ValidationMode = "validationMode"
                 } }
             });

Synopsis

Constructors

CfnJob(Construct, string, ICfnJobProps)

Specifies a new DataBrew job.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Specifies a new DataBrew job.
DataCatalogOutputs	One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
DatabaseOutputs	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
DatasetName	A dataset that the job is to process.
EncryptionKeyArn	The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
EncryptionMode	The encryption mode for the job, which can be one of the following:.
JobSample	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
LogSubscription	The current status of Amazon CloudWatch logging for the job.
MaxCapacity	The maximum number of nodes that can be consumed when the job processes data.
MaxRetries	The maximum number of times to retry the job after a job run fails.
Name	The unique name of the job.
OutputLocation	The location in Amazon S3 where the job writes its output.
Outputs	One or more artifacts that represent output from running the job.
ProfileConfiguration	Configuration for profile jobs.
ProjectName	The name of the project that the job is associated with.
Recipe	A series of data transformation steps that the job runs.
RoleArn	The Amazon Resource Name (ARN) of the role to be assumed for this job.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Metadata tags that have been applied to the job.
Timeout	The job's timeout in minutes.
Type	The job type of the job, which must be one of the following:.
ValidationConfigurations	List of validation configurations that are applied to the profile job.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Specifies a new DataBrew job.

Constructors

CfnJob(Construct, string, ICfnJobProps)

Specifies a new DataBrew job.

public CfnJob(Construct scope, string id, ICfnJobProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnJobProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Properties

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-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

CfnProperties

Specifies a new DataBrew job.

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-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

DataCatalogOutputs

One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

public virtual object? DataCatalogOutputs { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

DatabaseOutputs

Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

public virtual object? DatabaseOutputs { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

DatasetName

A dataset that the job is to process.

public virtual string? DatasetName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

EncryptionKeyArn

The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.

public virtual string? EncryptionKeyArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

EncryptionMode

The encryption mode for the job, which can be one of the following:.

public virtual string? EncryptionMode { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

JobSample

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.

public virtual object? JobSample { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

LogSubscription

The current status of Amazon CloudWatch logging for the job.

public virtual string? LogSubscription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

MaxCapacity

The maximum number of nodes that can be consumed when the job processes data.

public virtual double? MaxCapacity { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

MaxRetries

The maximum number of times to retry the job after a job run fails.

public virtual double? MaxRetries { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Name

The unique name of the job.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

OutputLocation

The location in Amazon S3 where the job writes its output.

public virtual object? OutputLocation { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Outputs

One or more artifacts that represent output from running the job.

public virtual object? Outputs { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

ProfileConfiguration

Configuration for profile jobs.

public virtual object? ProfileConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

ProjectName

The name of the project that the job is associated with.

public virtual string? ProjectName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Recipe

A series of data transformation steps that the job runs.

public virtual object? Recipe { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

RoleArn

The Amazon Resource Name (ARN) of the role to be assumed for this job.

public virtual string RoleArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

TagsRaw

Metadata tags that have been applied to the job.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Timeout

The job's timeout in minutes.

public virtual double? Timeout { get; set; }

Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Type

The job type of the job, which must be one of the following:.

public virtual string Type { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

ValidationConfigurations

List of validation configurations that are applied to the profile job.

public virtual object? ValidationConfigurations { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Specifies a new DataBrew job.

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-databrew-job.html

CloudformationResource: AWS::DataBrew::Job

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable