Package software.amazon.awscdk.services.databrew

Interface CfnJobProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:01:59.782Z")
@Stability(Stable)
public interface CfnJobProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnJob.

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.*;
 CfnJobProps cfnJobProps = CfnJobProps.builder()
         .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(Map.of(
                                                 "parametersKey", "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(Map.of(
                                         "parametersKey", "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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobProps.Builder	A builder for CfnJobProps
static final class	CfnJobProps.Jsii$Proxy	An implementation for CfnJobProps

Method Summary

Modifier and Type	Method	Description
static CfnJobProps.Builder	builder()
default Object	getDatabaseOutputs()	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
default Object	getDataCatalogOutputs()	One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
default String	getDatasetName()	A dataset that the job is to process.
default String	getEncryptionKeyArn()	The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
default String	getEncryptionMode()	The encryption mode for the job, which can be one of the following:.
default Object	getJobSample()	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
default String	getLogSubscription()	The current status of Amazon CloudWatch logging for the job.
default Number	getMaxCapacity()	The maximum number of nodes that can be consumed when the job processes data.
default Number	getMaxRetries()	The maximum number of times to retry the job after a job run fails.
String	getName()	The unique name of the job.
default Object	getOutputLocation()	The location in Amazon S3 where the job writes its output.
default Object	getOutputs()	One or more artifacts that represent output from running the job.
default Object	getProfileConfiguration()	Configuration for profile jobs.
default String	getProjectName()	The name of the project that the job is associated with.
default Object	getRecipe()	A series of data transformation steps that the job runs.
String	getRoleArn()	The Amazon Resource Name (ARN) of the role to be assumed for this job.
default List<CfnTag>	getTags()	Metadata tags that have been applied to the job.
default Number	getTimeout()	The job's timeout in minutes.
String	getType()	The job type of the job, which must be one of the following:.
default Object	getValidationConfigurations()	List of validation configurations that are applied to the profile job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The unique name of the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-name

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-rolearn

getType

@Stability(Stable)
@NotNull
String getType()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-type

getDatabaseOutputs

@Stability(Stable)
@Nullable
default Object getDatabaseOutputs()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-databaseoutputs

getDataCatalogOutputs

@Stability(Stable)
@Nullable
default Object getDataCatalogOutputs()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datacatalogoutputs

getDatasetName

@Stability(Stable)
@Nullable
default String getDatasetName()

A dataset that the job is to process.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-datasetname

getEncryptionKeyArn

@Stability(Stable)
@Nullable
default String getEncryptionKeyArn()

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

For more information, see Encrypting data written by DataBrew jobs

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionkeyarn

getEncryptionMode

@Stability(Stable)
@Nullable
default String getEncryptionMode()

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

• SSE-KMS - Server-side encryption with keys managed by AWS KMS .
• SSE-S3 - Server-side encryption with keys managed by Amazon S3.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-encryptionmode

getJobSample

@Stability(Stable)
@Nullable
default Object getJobSample()

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-jobsample

getLogSubscription

@Stability(Stable)
@Nullable
default String getLogSubscription()

The current status of Amazon CloudWatch logging for the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-logsubscription

getMaxCapacity

@Stability(Stable)
@Nullable
default Number getMaxCapacity()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxcapacity

getMaxRetries

@Stability(Stable)
@Nullable
default Number getMaxRetries()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-maxretries

getOutputLocation

@Stability(Stable)
@Nullable
default Object getOutputLocation()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputlocation

getOutputs

@Stability(Stable)
@Nullable
default Object getOutputs()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-outputs

getProfileConfiguration

@Stability(Stable)
@Nullable
default Object getProfileConfiguration()

Configuration for profile jobs.

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-profileconfiguration

getProjectName

@Stability(Stable)
@Nullable
default String getProjectName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-projectname

getRecipe

@Stability(Stable)
@Nullable
default Object getRecipe()

A series of data transformation steps that the job runs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-recipe

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata tags that have been applied to the job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-tags

getTimeout

@Stability(Stable)
@Nullable
default Number getTimeout()

The job's timeout in minutes.

A job that attempts to run longer than this timeout period ends with a status of TIMEOUT .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-timeout

getValidationConfigurations

@Stability(Stable)
@Nullable
default Object getValidationConfigurations()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-databrew-job.html#cfn-databrew-job-validationconfigurations

builder

@Stability(Stable)
static CfnJobProps.Builder builder()

Returns:

a CfnJobProps.Builder of CfnJobProps