software.amazon.awscdk.services.databrew

Class CfnJobProps.Builder

java.lang.Object

software.amazon.awscdk.services.databrew.CfnJobProps.Builder

Enclosing interface:

CfnJobProps

public static final class CfnJobProps.Builder
extends java.lang.Object

A builder for CfnJobProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnJobProps	build() Builds the configured instance.
CfnJobProps.Builder	databaseOutputs(IResolvable databaseOutputs) Sets the value of CfnJobProps.getDatabaseOutputs()
CfnJobProps.Builder	databaseOutputs(java.util.List<? extends java.lang.Object> databaseOutputs) Sets the value of CfnJobProps.getDatabaseOutputs()
CfnJobProps.Builder	dataCatalogOutputs(IResolvable dataCatalogOutputs) Sets the value of CfnJobProps.getDataCatalogOutputs()
CfnJobProps.Builder	dataCatalogOutputs(java.util.List<? extends java.lang.Object> dataCatalogOutputs) Sets the value of CfnJobProps.getDataCatalogOutputs()
CfnJobProps.Builder	datasetName(java.lang.String datasetName) Sets the value of CfnJobProps.getDatasetName()
CfnJobProps.Builder	encryptionKeyArn(java.lang.String encryptionKeyArn) Sets the value of CfnJobProps.getEncryptionKeyArn()
CfnJobProps.Builder	encryptionMode(java.lang.String encryptionMode) Sets the value of CfnJobProps.getEncryptionMode()
CfnJobProps.Builder	jobSample(CfnJob.JobSampleProperty jobSample) Sets the value of CfnJobProps.getJobSample()
CfnJobProps.Builder	jobSample(IResolvable jobSample) Sets the value of CfnJobProps.getJobSample()
CfnJobProps.Builder	logSubscription(java.lang.String logSubscription) Sets the value of CfnJobProps.getLogSubscription()
CfnJobProps.Builder	maxCapacity(java.lang.Number maxCapacity) Sets the value of CfnJobProps.getMaxCapacity()
CfnJobProps.Builder	maxRetries(java.lang.Number maxRetries) Sets the value of CfnJobProps.getMaxRetries()
CfnJobProps.Builder	name(java.lang.String name) Sets the value of CfnJobProps.getName()
CfnJobProps.Builder	outputLocation(CfnJob.OutputLocationProperty outputLocation) Sets the value of CfnJobProps.getOutputLocation()
CfnJobProps.Builder	outputLocation(IResolvable outputLocation) Sets the value of CfnJobProps.getOutputLocation()
CfnJobProps.Builder	outputs(IResolvable outputs) Sets the value of CfnJobProps.getOutputs()
CfnJobProps.Builder	outputs(java.util.List<? extends java.lang.Object> outputs) Sets the value of CfnJobProps.getOutputs()
CfnJobProps.Builder	profileConfiguration(CfnJob.ProfileConfigurationProperty profileConfiguration) Sets the value of CfnJobProps.getProfileConfiguration()
CfnJobProps.Builder	profileConfiguration(IResolvable profileConfiguration) Sets the value of CfnJobProps.getProfileConfiguration()
CfnJobProps.Builder	projectName(java.lang.String projectName) Sets the value of CfnJobProps.getProjectName()
CfnJobProps.Builder	recipe(CfnJob.RecipeProperty recipe) Sets the value of CfnJobProps.getRecipe()
CfnJobProps.Builder	recipe(IResolvable recipe) Sets the value of CfnJobProps.getRecipe()
CfnJobProps.Builder	roleArn(java.lang.String roleArn) Sets the value of CfnJobProps.getRoleArn()
CfnJobProps.Builder	tags(java.util.List<? extends CfnTag> tags) Sets the value of CfnJobProps.getTags()
CfnJobProps.Builder	timeout(java.lang.Number timeout) Sets the value of CfnJobProps.getTimeout()
CfnJobProps.Builder	type(java.lang.String type) Sets the value of CfnJobProps.getType()
CfnJobProps.Builder	validationConfigurations(IResolvable validationConfigurations) Sets the value of CfnJobProps.getValidationConfigurations()
CfnJobProps.Builder	validationConfigurations(java.util.List<? extends java.lang.Object> validationConfigurations) Sets the value of CfnJobProps.getValidationConfigurations()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

public CfnJobProps.Builder name(java.lang.String name)

Sets the value of CfnJobProps.getName()

Parameters:

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

Returns:

this

roleArn

public CfnJobProps.Builder roleArn(java.lang.String roleArn)

Sets the value of CfnJobProps.getRoleArn()

Parameters:

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

Returns:

this

type

public CfnJobProps.Builder type(java.lang.String type)

Sets the value of CfnJobProps.getType()

Parameters:

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

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

Returns:

this

databaseOutputs

public CfnJobProps.Builder databaseOutputs(IResolvable databaseOutputs)

Sets the value of CfnJobProps.getDatabaseOutputs()

Parameters:

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

Returns:

this

databaseOutputs

public CfnJobProps.Builder databaseOutputs(java.util.List<? extends java.lang.Object> databaseOutputs)

Sets the value of CfnJobProps.getDatabaseOutputs()

Parameters:

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

Returns:

this

dataCatalogOutputs

public CfnJobProps.Builder dataCatalogOutputs(IResolvable dataCatalogOutputs)

Sets the value of CfnJobProps.getDataCatalogOutputs()

Parameters:

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

Returns:

this

dataCatalogOutputs

public CfnJobProps.Builder dataCatalogOutputs(java.util.List<? extends java.lang.Object> dataCatalogOutputs)

Sets the value of CfnJobProps.getDataCatalogOutputs()

Parameters:

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

Returns:

this

datasetName

public CfnJobProps.Builder datasetName(java.lang.String datasetName)

Sets the value of CfnJobProps.getDatasetName()

Parameters:

datasetName - A dataset that the job is to process.

Returns:

this

encryptionKeyArn

public CfnJobProps.Builder encryptionKeyArn(java.lang.String encryptionKeyArn)

Sets the value of CfnJobProps.getEncryptionKeyArn()

Parameters:

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

Returns:

this

encryptionMode

public CfnJobProps.Builder encryptionMode(java.lang.String encryptionMode)

Sets the value of CfnJobProps.getEncryptionMode()

Parameters:

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.

Returns:

this

jobSample

public CfnJobProps.Builder jobSample(IResolvable jobSample)

Sets the value of CfnJobProps.getJobSample()

Parameters:

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.

Returns:

this

jobSample

public CfnJobProps.Builder jobSample(CfnJob.JobSampleProperty jobSample)

Sets the value of CfnJobProps.getJobSample()

Parameters:

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.

Returns:

this

logSubscription

public CfnJobProps.Builder logSubscription(java.lang.String logSubscription)

Sets the value of CfnJobProps.getLogSubscription()

Parameters:

logSubscription - The current status of Amazon CloudWatch logging for the job.

Returns:

this

maxCapacity

public CfnJobProps.Builder maxCapacity(java.lang.Number maxCapacity)

Sets the value of CfnJobProps.getMaxCapacity()

Parameters:

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

Returns:

this

maxRetries

public CfnJobProps.Builder maxRetries(java.lang.Number maxRetries)

Sets the value of CfnJobProps.getMaxRetries()

Parameters:

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

Returns:

this

outputLocation

public CfnJobProps.Builder outputLocation(IResolvable outputLocation)

Sets the value of CfnJobProps.getOutputLocation()

Parameters:

outputLocation - `AWS::DataBrew::Job.OutputLocation`.

Returns:

this

outputLocation

public CfnJobProps.Builder outputLocation(CfnJob.OutputLocationProperty outputLocation)

Sets the value of CfnJobProps.getOutputLocation()

Parameters:

outputLocation - `AWS::DataBrew::Job.OutputLocation`.

Returns:

this

outputs

public CfnJobProps.Builder outputs(IResolvable outputs)

Sets the value of CfnJobProps.getOutputs()

Parameters:

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

Returns:

this

outputs

public CfnJobProps.Builder outputs(java.util.List<? extends java.lang.Object> outputs)

Sets the value of CfnJobProps.getOutputs()

Parameters:

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

Returns:

this

profileConfiguration

public CfnJobProps.Builder profileConfiguration(IResolvable profileConfiguration)

Sets the value of CfnJobProps.getProfileConfiguration()

Parameters:

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.

Returns:

this

profileConfiguration

public CfnJobProps.Builder profileConfiguration(CfnJob.ProfileConfigurationProperty profileConfiguration)

Sets the value of CfnJobProps.getProfileConfiguration()

Parameters:

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.

Returns:

this

projectName

public CfnJobProps.Builder projectName(java.lang.String projectName)

Sets the value of CfnJobProps.getProjectName()

Parameters:

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

Returns:

this

recipe

public CfnJobProps.Builder recipe(IResolvable recipe)

Sets the value of CfnJobProps.getRecipe()

Parameters:

recipe - A series of data transformation steps that the job runs.

Returns:

this

recipe

public CfnJobProps.Builder recipe(CfnJob.RecipeProperty recipe)

Sets the value of CfnJobProps.getRecipe()

Parameters:

recipe - A series of data transformation steps that the job runs.

Returns:

this

tags

public CfnJobProps.Builder tags(java.util.List<? extends CfnTag> tags)

Sets the value of CfnJobProps.getTags()

Parameters:

tags - Metadata tags that have been applied to the job.

Returns:

this

timeout

public CfnJobProps.Builder timeout(java.lang.Number timeout)

Sets the value of CfnJobProps.getTimeout()

Parameters:

timeout - The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT .

Returns:

this

validationConfigurations

public CfnJobProps.Builder validationConfigurations(IResolvable validationConfigurations)

Sets the value of CfnJobProps.getValidationConfigurations()

Parameters:

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

Returns:

this

validationConfigurations

public CfnJobProps.Builder validationConfigurations(java.util.List<? extends java.lang.Object> validationConfigurations)

Sets the value of CfnJobProps.getValidationConfigurations()

Parameters:

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

Returns:

this

build

public CfnJobProps build()

Builds the configured instance.

Returns:

a new instance of CfnJobProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided