Package software.amazon.awscdk.cfnpropertymixins.services.databrew

Class CfnJobPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.databrew.CfnJobPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnJobPropsMixin>

Enclosing class:

CfnJobPropsMixin

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

A fluent builder for CfnJobPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnJobPropsMixin.Builder.

create

@Stability(Stable)
public static CfnJobPropsMixin.Builder create()

Returns:

a new instance of CfnJobPropsMixin.Builder.

databaseOutputs

@Stability(Stable)
public CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 .
• 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 CfnJobPropsMixin.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 CfnJobPropsMixin.Builder jobSample(CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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

name

@Stability(Stable)
public CfnJobPropsMixin.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

outputLocation

@Stability(Stable)
public CfnJobPropsMixin.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 CfnJobPropsMixin.Builder outputLocation(CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.Builder profileConfiguration(CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin.Builder recipe(CfnJobPropsMixin.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

roleArn

@Stability(Stable)
public CfnJobPropsMixin.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

tags

@Stability(Stable)
public CfnJobPropsMixin.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 CfnJobPropsMixin.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

type

@Stability(Stable)
public CfnJobPropsMixin.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

validationConfigurations

@Stability(Stable)
public CfnJobPropsMixin.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 CfnJobPropsMixin.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 CfnJobPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnJobPropsMixin.