Package software.amazon.awscdk.services.databrew

Class CfnJobProps.Builder

java.lang.Object
software.amazon.awscdk.services.databrew.CfnJobProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnJobProps>
Enclosing interface:
CfnJobProps
@Stability(Stable) public static final class CfnJobProps.Builder extends Object implements software.amazon.jsii.Builder<CfnJobProps>
A builder for CfnJobProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnJobProps.Builder name(String name)
      Sets the value of CfnJobProps.getName()
      Parameters:
      name - The unique name of the job. This parameter is required.
      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnJobProps.Builder roleArn(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

      @Stability(Stable) public CfnJobProps.Builder type(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

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

      @Stability(Stable) public CfnJobProps.Builder databaseOutputs(List<? extends 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

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

      @Stability(Stable) public CfnJobProps.Builder dataCatalogOutputs(List<? extends 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

      @Stability(Stable) public CfnJobProps.Builder datasetName(String datasetName)
      Sets the value of CfnJobProps.getDatasetName()
      Parameters:
      datasetName - A dataset that the job is to process.
      Returns:
      this

    • encryptionKeyArn

      @Stability(Stable) public CfnJobProps.Builder encryptionKeyArn(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

      @Stability(Stable) public CfnJobProps.Builder encryptionMode(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

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

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

      @Stability(Stable) public CfnJobProps.Builder logSubscription(String logSubscription)
      Sets the value of CfnJobProps.getLogSubscription()
      Parameters:
      logSubscription - The current status of Amazon CloudWatch logging for the job.
      Returns:
      this

    • maxCapacity

      @Stability(Stable) public CfnJobProps.Builder maxCapacity(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

      @Stability(Stable) public CfnJobProps.Builder maxRetries(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

      @Stability(Stable) public CfnJobProps.Builder outputLocation(IResolvable outputLocation)
      Sets the value of CfnJobProps.getOutputLocation()
      Parameters:
      outputLocation - AWS::DataBrew::Job.OutputLocation.
      Returns:
      this

    • outputLocation

      @Stability(Stable) public CfnJobProps.Builder outputLocation(CfnJob.OutputLocationProperty outputLocation)
      Sets the value of CfnJobProps.getOutputLocation()
      Parameters:
      outputLocation - AWS::DataBrew::Job.OutputLocation.
      Returns:
      this

    • outputs

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

      @Stability(Stable) public CfnJobProps.Builder outputs(List<? extends Object> outputs)
      Sets the value of CfnJobProps.getOutputs()
      Parameters:
      outputs - One or more artifacts that represent output from running the job.
      Returns:
      this

    • profileConfiguration

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

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

      @Stability(Stable) public CfnJobProps.Builder projectName(String projectName)
      Sets the value of CfnJobProps.getProjectName()
      Parameters:
      projectName - The name of the project that the job is associated with.
      Returns:
      this

    • recipe

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

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

      @Stability(Stable) public CfnJobProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnJobProps.getTags()
      Parameters:
      tags - Metadata tags that have been applied to the job.
      Returns:
      this

    • timeout

      @Stability(Stable) public CfnJobProps.Builder timeout(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

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

      @Stability(Stable) public CfnJobProps.Builder validationConfigurations(List<? extends Object> validationConfigurations)
      Sets the value of CfnJobProps.getValidationConfigurations()
      Parameters:
      validationConfigurations - List of validation configurations that are applied to the profile job.
      Returns:
      this

    • build

      @Stability(Stable) public CfnJobProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnJobProps>
      Returns:
      a new instance of CfnJobProps
      Throws:
      NullPointerException - if any required attribute was not provided