Package software.amazon.awscdk.services.databrew

Class CfnJob.Builder

java.lang.Object

software.amazon.awscdk.services.databrew.CfnJob.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJob>

Enclosing class:

CfnJob

@Stability(Stable)
public static final class CfnJob.Builder
extends Object
implements software.amazon.jsii.Builder<CfnJob>

A fluent builder for CfnJob.

Method Summary

Modifier and Type	Method	Description
CfnJob	build()
static CfnJob.Builder	create(software.constructs.Construct scope, String id)
CfnJob.Builder	databaseOutputs(List<? extends Object> databaseOutputs)	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
CfnJob.Builder	databaseOutputs(IResolvable databaseOutputs)	Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
CfnJob.Builder	dataCatalogOutputs(List<? extends Object> dataCatalogOutputs)	One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
CfnJob.Builder	dataCatalogOutputs(IResolvable dataCatalogOutputs)	One or more artifacts that represent the AWS Glue Data Catalog output from running the job.
CfnJob.Builder	datasetName(String datasetName)	A dataset that the job is to process.
CfnJob.Builder	encryptionKeyArn(String encryptionKeyArn)	The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output.
CfnJob.Builder	encryptionMode(String encryptionMode)	The encryption mode for the job, which can be one of the following:.
CfnJob.Builder	jobSample(IResolvable jobSample)	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
CfnJob.Builder	jobSample(CfnJob.JobSampleProperty jobSample)	A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run.
CfnJob.Builder	logSubscription(String logSubscription)	The current status of Amazon CloudWatch logging for the job.
CfnJob.Builder	maxCapacity(Number maxCapacity)	The maximum number of nodes that can be consumed when the job processes data.
CfnJob.Builder	maxRetries(Number maxRetries)	The maximum number of times to retry the job after a job run fails.
CfnJob.Builder	name(String name)	The unique name of the job.
CfnJob.Builder	outputLocation(IResolvable outputLocation)	The location in Amazon S3 where the job writes its output.
CfnJob.Builder	outputLocation(CfnJob.OutputLocationProperty outputLocation)	The location in Amazon S3 where the job writes its output.
CfnJob.Builder	outputs(List<? extends Object> outputs)	One or more artifacts that represent output from running the job.
CfnJob.Builder	outputs(IResolvable outputs)	One or more artifacts that represent output from running the job.
CfnJob.Builder	profileConfiguration(IResolvable profileConfiguration)	Configuration for profile jobs.
CfnJob.Builder	profileConfiguration(CfnJob.ProfileConfigurationProperty profileConfiguration)	Configuration for profile jobs.
CfnJob.Builder	projectName(String projectName)	The name of the project that the job is associated with.
CfnJob.Builder	recipe(IResolvable recipe)	A series of data transformation steps that the job runs.
CfnJob.Builder	recipe(CfnJob.RecipeProperty recipe)	A series of data transformation steps that the job runs.
CfnJob.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the role to be assumed for this job.
CfnJob.Builder	tags(List<? extends CfnTag> tags)	Metadata tags that have been applied to the job.
CfnJob.Builder	timeout(Number timeout)	The job's timeout in minutes.
CfnJob.Builder	type(String type)	The job type of the job, which must be one of the following:.
CfnJob.Builder	validationConfigurations(List<? extends Object> validationConfigurations)	List of validation configurations that are applied to the profile job.
CfnJob.Builder	validationConfigurations(IResolvable validationConfigurations)	List of validation configurations that are applied to the profile job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnJob.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnJob.Builder.

name

@Stability(Stable)
public CfnJob.Builder name(String name)

The unique name of the job.

Parameters:

name - The unique name of the job. This parameter is required.

Returns:

this

See Also:

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

roleArn

@Stability(Stable)
public CfnJob.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of the role to be assumed for this job. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnJob.Builder type(String type)

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.

Parameters:

type - The job type of the job, which must be one of the following:. This parameter is required.

Returns:

this

See Also:

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

databaseOutputs

@Stability(Stable)
public CfnJob.Builder databaseOutputs(IResolvable databaseOutputs)

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

Parameters:

databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. This parameter is required.

Returns:

this

See Also:

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

databaseOutputs

@Stability(Stable)
public CfnJob.Builder databaseOutputs(List<? extends Object> databaseOutputs)

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

Parameters:

databaseOutputs - Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into. This parameter is required.

Returns:

this

See Also:

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

dataCatalogOutputs

@Stability(Stable)
public CfnJob.Builder dataCatalogOutputs(IResolvable dataCatalogOutputs)

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

Parameters:

dataCatalogOutputs - One or more artifacts that represent the AWS Glue Data Catalog output from running the job. This parameter is required.

Returns:

this

See Also:

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

dataCatalogOutputs

@Stability(Stable)
public CfnJob.Builder dataCatalogOutputs(List<? extends Object> dataCatalogOutputs)

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

Parameters:

dataCatalogOutputs - One or more artifacts that represent the AWS Glue Data Catalog output from running the job. This parameter is required.

Returns:

this

See Also:

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

datasetName

@Stability(Stable)
public CfnJob.Builder datasetName(String datasetName)

A dataset that the job is to process.

Parameters:

datasetName - A dataset that the job is to process. This parameter is required.

Returns:

this

See Also:

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

encryptionKeyArn

@Stability(Stable)
public CfnJob.Builder encryptionKeyArn(String encryptionKeyArn)

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

Parameters:

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

Returns:

this

See Also:

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

encryptionMode

@Stability(Stable)
public CfnJob.Builder encryptionMode(String encryptionMode)

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.

Parameters:

encryptionMode - The encryption mode for the job, which can be one of the following:. This parameter is required.

Returns:

this

See Also:

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

jobSample

@Stability(Stable)
public CfnJob.Builder jobSample(IResolvable jobSample)

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.

Parameters:

jobSample - A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. This parameter is required.

Returns:

this

See Also:

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

jobSample

@Stability(Stable)
public CfnJob.Builder jobSample(CfnJob.JobSampleProperty jobSample)

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.

Parameters:

jobSample - A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. This parameter is required.

Returns:

this

See Also:

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

logSubscription

@Stability(Stable)
public CfnJob.Builder logSubscription(String logSubscription)

The current status of Amazon CloudWatch logging for the job.

Parameters:

logSubscription - The current status of Amazon CloudWatch logging for the job. This parameter is required.

Returns:

this

See Also:

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

maxCapacity

@Stability(Stable)
public CfnJob.Builder maxCapacity(Number maxCapacity)

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

Parameters:

maxCapacity - The maximum number of nodes that can be consumed when the job processes data. This parameter is required.

Returns:

this

See Also:

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

maxRetries

@Stability(Stable)
public CfnJob.Builder maxRetries(Number maxRetries)

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

Parameters:

maxRetries - The maximum number of times to retry the job after a job run fails. This parameter is required.

Returns:

this

See Also:

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

outputLocation

@Stability(Stable)
public CfnJob.Builder outputLocation(IResolvable outputLocation)

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

Parameters:

outputLocation - The location in Amazon S3 where the job writes its output. This parameter is required.

Returns:

this

See Also:

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

outputLocation

@Stability(Stable)
public CfnJob.Builder outputLocation(CfnJob.OutputLocationProperty outputLocation)

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

Parameters:

outputLocation - The location in Amazon S3 where the job writes its output. This parameter is required.

Returns:

this

See Also:

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

outputs

@Stability(Stable)
public CfnJob.Builder outputs(IResolvable outputs)

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

Parameters:

outputs - One or more artifacts that represent output from running the job. This parameter is required.

Returns:

this

See Also:

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

outputs

@Stability(Stable)
public CfnJob.Builder outputs(List<? extends Object> outputs)

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

Parameters:

outputs - One or more artifacts that represent output from running the job. This parameter is required.

Returns:

this

See Also:

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

profileConfiguration

@Stability(Stable)
public CfnJob.Builder profileConfiguration(IResolvable profileConfiguration)

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.

Parameters:

profileConfiguration - Configuration for profile jobs. This parameter is required.

Returns:

this

See Also:

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

profileConfiguration

@Stability(Stable)
public CfnJob.Builder profileConfiguration(CfnJob.ProfileConfigurationProperty profileConfiguration)

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.

Parameters:

profileConfiguration - Configuration for profile jobs. This parameter is required.

Returns:

this

See Also:

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

projectName

@Stability(Stable)
public CfnJob.Builder projectName(String projectName)

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

Parameters:

projectName - The name of the project that the job is associated with. This parameter is required.

Returns:

this

See Also:

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

recipe

@Stability(Stable)
public CfnJob.Builder recipe(IResolvable recipe)

A series of data transformation steps that the job runs.

Parameters:

recipe - A series of data transformation steps that the job runs. This parameter is required.

Returns:

this

See Also:

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

recipe

@Stability(Stable)
public CfnJob.Builder recipe(CfnJob.RecipeProperty recipe)

A series of data transformation steps that the job runs.

Parameters:

recipe - A series of data transformation steps that the job runs. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnJob.Builder tags(List<? extends CfnTag> tags)

Metadata tags that have been applied to the job.

Parameters:

tags - Metadata tags that have been applied to the job. This parameter is required.

Returns:

this

See Also:

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

timeout

@Stability(Stable)
public CfnJob.Builder timeout(Number timeout)

The job's timeout in minutes.

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

Parameters:

timeout - The job's timeout in minutes. This parameter is required.

Returns:

this

See Also:

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

validationConfigurations

@Stability(Stable)
public CfnJob.Builder validationConfigurations(IResolvable validationConfigurations)

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

Parameters:

validationConfigurations - List of validation configurations that are applied to the profile job. This parameter is required.

Returns:

this

See Also:

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

validationConfigurations

@Stability(Stable)
public CfnJob.Builder validationConfigurations(List<? extends Object> validationConfigurations)

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

Parameters:

validationConfigurations - List of validation configurations that are applied to the profile job. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnJob build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnJob>

Returns:

a newly built instance of CfnJob.