Interface ICfnJobProps
Properties for defining a CfnJob
.
Namespace: Amazon.CDK.AWS.DataBrew
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnJobProps
Syntax (vb)
Public Interface ICfnJobProps
Remarks
See: 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 cfnJobProps = 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
Properties
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 | 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 | 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. |
Properties
DatabaseOutputs
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
virtual object DatabaseOutputs { get; }
Property Value
System.Object
Remarks
DataCatalogOutputs
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
virtual object DataCatalogOutputs { get; }
Property Value
System.Object
Remarks
DatasetName
A dataset that the job is to process.
virtual string DatasetName { get; }
Property Value
System.String
Remarks
EncryptionKeyArn
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
virtual string EncryptionKeyArn { get; }
Property Value
System.String
Remarks
EncryptionMode
The encryption mode for the job, which can be one of the following:.
virtual string EncryptionMode { get; }
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.
virtual object JobSample { get; }
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.
virtual string LogSubscription { get; }
Property Value
System.String
Remarks
MaxCapacity
The maximum number of nodes that can be consumed when the job processes data.
virtual Nullable<double> MaxCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
MaxRetries
The maximum number of times to retry the job after a job run fails.
virtual Nullable<double> MaxRetries { get; }
Property Value
System.Nullable<System.Double>
Remarks
Name
The unique name of the job.
string Name { get; }
Property Value
System.String
Remarks
OutputLocation
The location in Amazon S3 where the job writes its output.
virtual object OutputLocation { get; }
Property Value
System.Object
Remarks
Outputs
One or more artifacts that represent output from running the job.
virtual object Outputs { get; }
Property Value
System.Object
Remarks
ProfileConfiguration
Configuration for profile jobs.
virtual object ProfileConfiguration { get; }
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.
virtual string ProjectName { get; }
Property Value
System.String
Remarks
Recipe
A series of data transformation steps that the job runs.
virtual object Recipe { get; }
Property Value
System.Object
Remarks
RoleArn
The Amazon Resource Name (ARN) of the role to be assumed for this job.
string RoleArn { get; }
Property Value
System.String
Remarks
Tags
Metadata tags that have been applied to the job.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Timeout
The job's timeout in minutes.
virtual Nullable<double> Timeout { get; }
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:.
string Type { get; }
Property Value
System.String
Remarks
ValidationConfigurations
List of validation configurations that are applied to the profile job.
virtual object ValidationConfigurations { get; }
Property Value
System.Object