Class CfnJob
A CloudFormation AWS::DataBrew::Job
.
Inherited Members
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.AWS.DataBrew.dll
Syntax (csharp)
public class CfnJob : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnJob
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a new DataBrew job.
CloudformationResource: AWS::DataBrew::Job
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.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 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) | Create a new |
CfnJob(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnJob(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 | |
DatabaseOutputs | Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. |
DataCatalogOutputs | One or more artifacts that represent the AWS Glue Data Catalog output from running the job. |
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 |
|
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 | 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>) |
Constructors
CfnJob(Construct, String, ICfnJobProps)
Create a new AWS::DataBrew::Job
.
public CfnJob(Construct scope, string id, ICfnJobProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnJobProps
- resource properties.
CfnJob(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnJob(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnJob(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnJob(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
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
System.Object
Remarks
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
System.Object
Remarks
DatasetName
A dataset that the job is to process.
public virtual string DatasetName { get; set; }
Property Value
System.String
Remarks
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
System.String
Remarks
EncryptionMode
The encryption mode for the job, which can be one of the following:.
public virtual string EncryptionMode { get; set; }
Property Value
System.String
Remarks
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
System.Object
Remarks
If a JobSample
value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
LogSubscription
The current status of Amazon CloudWatch logging for the job.
public virtual string LogSubscription { get; set; }
Property Value
System.String
Remarks
MaxCapacity
The maximum number of nodes that can be consumed when the job processes data.
public virtual Nullable<double> MaxCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
MaxRetries
The maximum number of times to retry the job after a job run fails.
public virtual Nullable<double> MaxRetries { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Name
The unique name of the job.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
OutputLocation
AWS::DataBrew::Job.OutputLocation
.
public virtual object OutputLocation { get; set; }
Property Value
System.Object
Remarks
Outputs
One or more artifacts that represent output from running the job.
public virtual object Outputs { get; set; }
Property Value
System.Object
Remarks
ProfileConfiguration
Configuration for profile jobs.
public virtual object ProfileConfiguration { get; set; }
Property Value
System.Object
Remarks
Configuration can be used to select columns, do evaluations, and override default parameters of evaluations. When configuration is undefined, the profile job will apply default settings to all supported columns.
ProjectName
The name of the project that the job is associated with.
public virtual string ProjectName { get; set; }
Property Value
System.String
Remarks
Recipe
A series of data transformation steps that the job runs.
public virtual object Recipe { get; set; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of the role to be assumed for this job.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
Tags
Metadata tags that have been applied to the job.
public virtual TagManager Tags { get; }
Property Value
Remarks
Timeout
The job's timeout in minutes.
public virtual Nullable<double> Timeout { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
Type
The job type of the job, which must be one of the following:.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
ValidationConfigurations
List of validation configurations that are applied to the profile job.
public virtual object ValidationConfigurations { get; set; }
Property Value
System.Object
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>