@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-20T22:19:53.633Z") public class CfnJob extends CfnResource implements IInspectable
Specifies a new DataBrew job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.databrew.*; Object parameters; CfnJob cfnJob = CfnJob.Builder.create(this, "MyCfnJob") .name("name") .roleArn("roleArn") .type("type") // the properties below are optional .databaseOutputs(List.of(DatabaseOutputProperty.builder() .databaseOptions(DatabaseTableOutputOptionsProperty.builder() .tableName("tableName") // the properties below are optional .tempDirectory(S3LocationProperty.builder() .bucket("bucket") // the properties below are optional .bucketOwner("bucketOwner") .key("key") .build()) .build()) .glueConnectionName("glueConnectionName") // the properties below are optional .databaseOutputMode("databaseOutputMode") .build())) .dataCatalogOutputs(List.of(DataCatalogOutputProperty.builder() .databaseName("databaseName") .tableName("tableName") // the properties below are optional .catalogId("catalogId") .databaseOptions(DatabaseTableOutputOptionsProperty.builder() .tableName("tableName") // the properties below are optional .tempDirectory(S3LocationProperty.builder() .bucket("bucket") // the properties below are optional .bucketOwner("bucketOwner") .key("key") .build()) .build()) .overwrite(false) .s3Options(S3TableOutputOptionsProperty.builder() .location(S3LocationProperty.builder() .bucket("bucket") // the properties below are optional .bucketOwner("bucketOwner") .key("key") .build()) .build()) .build())) .datasetName("datasetName") .encryptionKeyArn("encryptionKeyArn") .encryptionMode("encryptionMode") .jobSample(JobSampleProperty.builder() .mode("mode") .size(123) .build()) .logSubscription("logSubscription") .maxCapacity(123) .maxRetries(123) .outputLocation(OutputLocationProperty.builder() .bucket("bucket") // the properties below are optional .bucketOwner("bucketOwner") .key("key") .build()) .outputs(List.of(OutputProperty.builder() .location(S3LocationProperty.builder() .bucket("bucket") // the properties below are optional .bucketOwner("bucketOwner") .key("key") .build()) // the properties below are optional .compressionFormat("compressionFormat") .format("format") .formatOptions(OutputFormatOptionsProperty.builder() .csv(CsvOutputOptionsProperty.builder() .delimiter("delimiter") .build()) .build()) .maxOutputFiles(123) .overwrite(false) .partitionColumns(List.of("partitionColumns")) .build())) .profileConfiguration(ProfileConfigurationProperty.builder() .columnStatisticsConfigurations(List.of(ColumnStatisticsConfigurationProperty.builder() .statistics(StatisticsConfigurationProperty.builder() .includedStatistics(List.of("includedStatistics")) .overrides(List.of(StatisticOverrideProperty.builder() .parameters(parameters) .statistic("statistic") .build())) .build()) // the properties below are optional .selectors(List.of(ColumnSelectorProperty.builder() .name("name") .regex("regex") .build())) .build())) .datasetStatisticsConfiguration(StatisticsConfigurationProperty.builder() .includedStatistics(List.of("includedStatistics")) .overrides(List.of(StatisticOverrideProperty.builder() .parameters(parameters) .statistic("statistic") .build())) .build()) .entityDetectorConfiguration(EntityDetectorConfigurationProperty.builder() .entityTypes(List.of("entityTypes")) // the properties below are optional .allowedStatistics(AllowedStatisticsProperty.builder() .statistics(List.of("statistics")) .build()) .build()) .profileColumns(List.of(ColumnSelectorProperty.builder() .name("name") .regex("regex") .build())) .build()) .projectName("projectName") .recipe(RecipeProperty.builder() .name("name") // the properties below are optional .version("version") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .timeout(123) .validationConfigurations(List.of(ValidationConfigurationProperty.builder() .rulesetArn("rulesetArn") // the properties below are optional .validationMode("validationMode") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnJob.AllowedStatisticsProperty
Configuration of statistics that are allowed to be run on columns that contain detected entities.
|
static class |
CfnJob.Builder
A fluent builder for
CfnJob . |
static interface |
CfnJob.ColumnSelectorProperty
Selector of a column from a dataset for profile job configuration.
|
static interface |
CfnJob.ColumnStatisticsConfigurationProperty
Configuration for column evaluations for a profile job.
|
static interface |
CfnJob.CsvOutputOptionsProperty
Represents a set of options that define how DataBrew will write a comma-separated value (CSV) file.
|
static interface |
CfnJob.DatabaseOutputProperty
Represents a JDBC database output object which defines the output destination for a DataBrew recipe job to write into.
|
static interface |
CfnJob.DatabaseTableOutputOptionsProperty
Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
|
static interface |
CfnJob.DataCatalogOutputProperty
Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.
|
static interface |
CfnJob.EntityDetectorConfigurationProperty
Configuration of entity detection for a profile job.
|
static interface |
CfnJob.JobSampleProperty
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
|
static interface |
CfnJob.OutputFormatOptionsProperty
Represents a set of options that define the structure of comma-separated (CSV) job output.
|
static interface |
CfnJob.OutputLocationProperty
The location in Amazon S3 or AWS Glue Data Catalog where the job writes its output.
|
static interface |
CfnJob.OutputProperty
Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.
|
static interface |
CfnJob.ProfileConfigurationProperty
Configuration for profile jobs.
|
static interface |
CfnJob.RecipeProperty
Represents one or more actions to be performed on a DataBrew dataset.
|
static interface |
CfnJob.S3LocationProperty
Represents an Amazon S3 location (bucket name, bucket owner, and object key) where DataBrew can read input data, or write output from a job.
|
static interface |
CfnJob.S3TableOutputOptionsProperty
Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
|
static interface |
CfnJob.StatisticOverrideProperty
Override of a particular evaluation for a profile job.
|
static interface |
CfnJob.StatisticsConfigurationProperty
Configuration of evaluations for a profile job.
|
static interface |
CfnJob.ValidationConfigurationProperty
Configuration for data quality validation.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnJob(Construct scope,
java.lang.String id,
CfnJobProps props)
Create a new `AWS::DataBrew::Job`.
|
protected |
CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnJob(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDatabaseOutputs()
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
|
java.lang.Object |
getDataCatalogOutputs()
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
|
java.lang.String |
getDatasetName()
A dataset that the job is to process.
|
java.lang.String |
getEncryptionKeyArn()
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
|
java.lang.String |
getEncryptionMode()
The encryption mode for the job, which can be one of the following:.
|
java.lang.Object |
getJobSample()
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
|
java.lang.String |
getLogSubscription()
The current status of Amazon CloudWatch logging for the job.
|
java.lang.Number |
getMaxCapacity()
The maximum number of nodes that can be consumed when the job processes data.
|
java.lang.Number |
getMaxRetries()
The maximum number of times to retry the job after a job run fails.
|
java.lang.String |
getName()
The unique name of the job.
|
java.lang.Object |
getOutputLocation()
`AWS::DataBrew::Job.OutputLocation`.
|
java.lang.Object |
getOutputs()
One or more artifacts that represent output from running the job.
|
java.lang.Object |
getProfileConfiguration()
Configuration for profile jobs.
|
java.lang.String |
getProjectName()
The name of the project that the job is associated with.
|
java.lang.Object |
getRecipe()
A series of data transformation steps that the job runs.
|
java.lang.String |
getRoleArn()
The Amazon Resource Name (ARN) of the role to be assumed for this job.
|
TagManager |
getTags()
Metadata tags that have been applied to the job.
|
java.lang.Number |
getTimeout()
The job's timeout in minutes.
|
java.lang.String |
getType()
The job type of the job, which must be one of the following:.
|
java.lang.Object |
getValidationConfigurations()
List of validation configurations that are applied to the profile job.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setDatabaseOutputs(IResolvable value)
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
|
void |
setDatabaseOutputs(java.util.List<java.lang.Object> value)
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
|
void |
setDataCatalogOutputs(IResolvable value)
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
|
void |
setDataCatalogOutputs(java.util.List<java.lang.Object> value)
One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
|
void |
setDatasetName(java.lang.String value)
A dataset that the job is to process.
|
void |
setEncryptionKeyArn(java.lang.String value)
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
|
void |
setEncryptionMode(java.lang.String value)
The encryption mode for the job, which can be one of the following:.
|
void |
setJobSample(CfnJob.JobSampleProperty value)
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
|
void |
setJobSample(IResolvable value)
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
|
void |
setLogSubscription(java.lang.String value)
The current status of Amazon CloudWatch logging for the job.
|
void |
setMaxCapacity(java.lang.Number value)
The maximum number of nodes that can be consumed when the job processes data.
|
void |
setMaxRetries(java.lang.Number value)
The maximum number of times to retry the job after a job run fails.
|
void |
setName(java.lang.String value)
The unique name of the job.
|
void |
setOutputLocation(CfnJob.OutputLocationProperty value)
`AWS::DataBrew::Job.OutputLocation`.
|
void |
setOutputLocation(IResolvable value)
`AWS::DataBrew::Job.OutputLocation`.
|
void |
setOutputs(IResolvable value)
One or more artifacts that represent output from running the job.
|
void |
setOutputs(java.util.List<java.lang.Object> value)
One or more artifacts that represent output from running the job.
|
void |
setProfileConfiguration(CfnJob.ProfileConfigurationProperty value)
Configuration for profile jobs.
|
void |
setProfileConfiguration(IResolvable value)
Configuration for profile jobs.
|
void |
setProjectName(java.lang.String value)
The name of the project that the job is associated with.
|
void |
setRecipe(CfnJob.RecipeProperty value)
A series of data transformation steps that the job runs.
|
void |
setRecipe(IResolvable value)
A series of data transformation steps that the job runs.
|
void |
setRoleArn(java.lang.String value)
The Amazon Resource Name (ARN) of the role to be assumed for this job.
|
void |
setTimeout(java.lang.Number value)
The job's timeout in minutes.
|
void |
setType(java.lang.String value)
The job type of the job, which must be one of the following:.
|
void |
setValidationConfigurations(IResolvable value)
List of validation configurations that are applied to the profile job.
|
void |
setValidationConfigurations(java.util.List<java.lang.Object> value)
List of validation configurations that are applied to the profile job.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnJob(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnJob(Construct scope, java.lang.String id, CfnJobProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)
public java.lang.String getType()
PROFILE
- A job to analyze a dataset, to determine its size, data types, data distribution, and more.RECIPE
- A job to apply one or more transformations to a dataset.public void setType(java.lang.String value)
PROFILE
- A job to analyze a dataset, to determine its size, data types, data distribution, and more.RECIPE
- A job to apply one or more transformations to a dataset.public java.lang.Object getDatabaseOutputs()
public void setDatabaseOutputs(IResolvable value)
public void setDatabaseOutputs(java.util.List<java.lang.Object> value)
public java.lang.Object getDataCatalogOutputs()
public void setDataCatalogOutputs(IResolvable value)
public void setDataCatalogOutputs(java.util.List<java.lang.Object> value)
public java.lang.String getDatasetName()
public void setDatasetName(java.lang.String value)
public java.lang.String getEncryptionKeyArn()
For more information, see Encrypting data written by DataBrew jobs
public void setEncryptionKeyArn(java.lang.String value)
For more information, see Encrypting data written by DataBrew jobs
public java.lang.String getEncryptionMode()
SSE-KMS
- Server-side encryption with keys managed by AWS KMS .SSE-S3
- Server-side encryption with keys managed by Amazon S3.public void setEncryptionMode(java.lang.String value)
SSE-KMS
- Server-side encryption with keys managed by AWS KMS .SSE-S3
- Server-side encryption with keys managed by Amazon S3.public java.lang.Object getJobSample()
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.
public void setJobSample(IResolvable value)
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.
public void setJobSample(CfnJob.JobSampleProperty value)
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.
public java.lang.String getLogSubscription()
public void setLogSubscription(java.lang.String value)
public java.lang.Number getMaxCapacity()
public void setMaxCapacity(java.lang.Number value)
public java.lang.Number getMaxRetries()
public void setMaxRetries(java.lang.Number value)
public java.lang.Object getOutputLocation()
public void setOutputLocation(IResolvable value)
public void setOutputLocation(CfnJob.OutputLocationProperty value)
public java.lang.Object getOutputs()
public void setOutputs(IResolvable value)
public void setOutputs(java.util.List<java.lang.Object> value)
public java.lang.Object getProfileConfiguration()
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.
public void setProfileConfiguration(IResolvable value)
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.
public void setProfileConfiguration(CfnJob.ProfileConfigurationProperty value)
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.
public java.lang.String getProjectName()
public void setProjectName(java.lang.String value)
public java.lang.Object getRecipe()
public void setRecipe(IResolvable value)
public void setRecipe(CfnJob.RecipeProperty value)
public java.lang.Number getTimeout()
A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
public void setTimeout(java.lang.Number value)
A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
public java.lang.Object getValidationConfigurations()
public void setValidationConfigurations(IResolvable value)
public void setValidationConfigurations(java.util.List<java.lang.Object> value)