Package software.amazon.awscdk.services.databrew

Class CfnJob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.databrew.CfnJob
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.090Z") @Stability(Stable) public class CfnJob extends CfnResource implements IInspectable
A CloudFormation AWS::DataBrew::Job.

Specifies a new DataBrew job.

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.*;
 CfnJob cfnJob = CfnJob.Builder.create(this, "MyCfnJob")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJob

      protected CfnJob(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnJob

      protected CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnJob

      @Stability(Stable) public CfnJob(@NotNull Construct scope, @NotNull String id, @NotNull CfnJobProps props)
      Create a new AWS::DataBrew::Job.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata tags that have been applied to the job.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The unique name of the job.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique name of the job.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the role to be assumed for this job.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the role to be assumed for this job.

    • getType

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

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      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.

    • getDatabaseOutputs

      @Stability(Stable) @Nullable public Object getDatabaseOutputs()
      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

    • setDatabaseOutputs

      @Stability(Stable) public void setDatabaseOutputs(@Nullable IResolvable value)
      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

    • setDatabaseOutputs

      @Stability(Stable) public void setDatabaseOutputs(@Nullable List<Object> value)
      Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.

    • getDataCatalogOutputs

      @Stability(Stable) @Nullable public Object getDataCatalogOutputs()
      One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

    • setDataCatalogOutputs

      @Stability(Stable) public void setDataCatalogOutputs(@Nullable IResolvable value)
      One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

    • setDataCatalogOutputs

      @Stability(Stable) public void setDataCatalogOutputs(@Nullable List<Object> value)
      One or more artifacts that represent the AWS Glue Data Catalog output from running the job.

    • getDatasetName

      @Stability(Stable) @Nullable public String getDatasetName()
      A dataset that the job is to process.

    • setDatasetName

      @Stability(Stable) public void setDatasetName(@Nullable String value)
      A dataset that the job is to process.

    • getEncryptionKeyArn

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

    • setEncryptionKeyArn

      @Stability(Stable) public void setEncryptionKeyArn(@Nullable String value)
      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

    • getEncryptionMode

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

    • setEncryptionMode

      @Stability(Stable) public void setEncryptionMode(@Nullable String value)
      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.

    • getJobSample

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

    • setJobSample

      @Stability(Stable) public void setJobSample(@Nullable IResolvable value)
      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.

    • setJobSample

      @Stability(Stable) public void setJobSample(@Nullable CfnJob.JobSampleProperty value)
      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.

    • getLogSubscription

      @Stability(Stable) @Nullable public String getLogSubscription()
      The current status of Amazon CloudWatch logging for the job.

    • setLogSubscription

      @Stability(Stable) public void setLogSubscription(@Nullable String value)
      The current status of Amazon CloudWatch logging for the job.

    • getMaxCapacity

      @Stability(Stable) @Nullable public Number getMaxCapacity()
      The maximum number of nodes that can be consumed when the job processes data.

    • setMaxCapacity

      @Stability(Stable) public void setMaxCapacity(@Nullable Number value)
      The maximum number of nodes that can be consumed when the job processes data.

    • getMaxRetries

      @Stability(Stable) @Nullable public Number getMaxRetries()
      The maximum number of times to retry the job after a job run fails.

    • setMaxRetries

      @Stability(Stable) public void setMaxRetries(@Nullable Number value)
      The maximum number of times to retry the job after a job run fails.

    • getOutputLocation

      @Stability(Stable) @Nullable public Object getOutputLocation()
      AWS::DataBrew::Job.OutputLocation.

    • setOutputLocation

      @Stability(Stable) public void setOutputLocation(@Nullable IResolvable value)
      AWS::DataBrew::Job.OutputLocation.

    • setOutputLocation

      @Stability(Stable) public void setOutputLocation(@Nullable CfnJob.OutputLocationProperty value)
      AWS::DataBrew::Job.OutputLocation.

    • getOutputs

      @Stability(Stable) @Nullable public Object getOutputs()
      One or more artifacts that represent output from running the job.

    • setOutputs

      @Stability(Stable) public void setOutputs(@Nullable IResolvable value)
      One or more artifacts that represent output from running the job.

    • setOutputs

      @Stability(Stable) public void setOutputs(@Nullable List<Object> value)
      One or more artifacts that represent output from running the job.

    • getProfileConfiguration

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

    • setProfileConfiguration

      @Stability(Stable) public void setProfileConfiguration(@Nullable IResolvable value)
      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.

    • setProfileConfiguration

      @Stability(Stable) public void setProfileConfiguration(@Nullable CfnJob.ProfileConfigurationProperty value)
      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.

    • getProjectName

      @Stability(Stable) @Nullable public String getProjectName()
      The name of the project that the job is associated with.

    • setProjectName

      @Stability(Stable) public void setProjectName(@Nullable String value)
      The name of the project that the job is associated with.

    • getRecipe

      @Stability(Stable) @Nullable public Object getRecipe()
      A series of data transformation steps that the job runs.

    • setRecipe

      @Stability(Stable) public void setRecipe(@Nullable IResolvable value)
      A series of data transformation steps that the job runs.

    • setRecipe

      @Stability(Stable) public void setRecipe(@Nullable CfnJob.RecipeProperty value)
      A series of data transformation steps that the job runs.

    • getTimeout

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

    • setTimeout

      @Stability(Stable) public void setTimeout(@Nullable Number value)
      The job's timeout in minutes.

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

    • getValidationConfigurations

      @Stability(Stable) @Nullable public Object getValidationConfigurations()
      List of validation configurations that are applied to the profile job.

    • setValidationConfigurations

      @Stability(Stable) public void setValidationConfigurations(@Nullable IResolvable value)
      List of validation configurations that are applied to the profile job.

    • setValidationConfigurations

      @Stability(Stable) public void setValidationConfigurations(@Nullable List<Object> value)
      List of validation configurations that are applied to the profile job.