CfnJob

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:41.133Z")
public class CfnJob
extends CfnResource
implements IInspectable

A CloudFormation `AWS::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
                                 .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
                                 .key("key")
                                 .build())
                         .build())
                 .overwrite(false)
                 .s3Options(S3TableOutputOptionsProperty.builder()
                         .location(S3LocationProperty.builder()
                                 .bucket("bucket")
                                 // the properties below are optional
                                 .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
                 .key("key")
                 .build())
         .outputs(List.of(OutputProperty.builder()
                 .location(S3LocationProperty.builder()
                         .bucket("bucket")
                         // the properties below are optional
                         .key("key")
                         .build())
                 // the properties below are optional
                 .compressionFormat("compressionFormat")
                 .format("format")
                 .formatOptions(OutputFormatOptionsProperty.builder()
                         .csv(CsvOutputOptionsProperty.builder()
                                 .delimiter("delimiter")
                                 .build())
                         .build())
                 .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(ParameterMapProperty.builder().build())
                                         .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(ParameterMapProperty.builder().build())
                                 .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnJob.AllowedStatisticsProperty` Example:
`static class`	`CfnJob.Builder` A fluent builder for `CfnJob`.
`static interface`	`CfnJob.ColumnSelectorProperty` Example:
`static interface`	`CfnJob.ColumnStatisticsConfigurationProperty` Example:
`static interface`	`CfnJob.CsvOutputOptionsProperty` Example:
`static interface`	`CfnJob.DatabaseOutputProperty` Example:
`static interface`	`CfnJob.DatabaseTableOutputOptionsProperty` Example:
`static interface`	`CfnJob.DataCatalogOutputProperty` Example:
`static interface`	`CfnJob.EntityDetectorConfigurationProperty` Example:
`static interface`	`CfnJob.JobSampleProperty` Example:
`static interface`	`CfnJob.OutputFormatOptionsProperty` Example:
`static interface`	`CfnJob.OutputLocationProperty` Example:
`static interface`	`CfnJob.OutputProperty` Example:
`static interface`	`CfnJob.ParameterMapProperty` Example:
`static interface`	`CfnJob.ProfileConfigurationProperty` Example:
`static interface`	`CfnJob.RecipeProperty` Example:
`static interface`	`CfnJob.S3LocationProperty` Example:
`static interface`	`CfnJob.S3TableOutputOptionsProperty` Example:
`static interface`	`CfnJob.StatisticOverrideProperty` Example:
`static interface`	`CfnJob.StatisticsConfigurationProperty` Example:
`static interface`	`CfnJob.ValidationConfigurationProperty` Example:

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnJob(Construct scope, java.lang.String id, CfnJobProps props)` Create a new `AWS::DataBrew::Job`.
`protected`	`CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnJob(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDatabaseOutputs()` `AWS::DataBrew::Job.DatabaseOutputs`.
`java.lang.Object`	`getDataCatalogOutputs()` `AWS::DataBrew::Job.DataCatalogOutputs`.
`java.lang.String`	`getDatasetName()` `AWS::DataBrew::Job.DatasetName`.
`java.lang.String`	`getEncryptionKeyArn()` `AWS::DataBrew::Job.EncryptionKeyArn`.
`java.lang.String`	`getEncryptionMode()` `AWS::DataBrew::Job.EncryptionMode`.
`java.lang.Object`	`getJobSample()` `AWS::DataBrew::Job.JobSample`.
`java.lang.String`	`getLogSubscription()` `AWS::DataBrew::Job.LogSubscription`.
`java.lang.Number`	`getMaxCapacity()` `AWS::DataBrew::Job.MaxCapacity`.
`java.lang.Number`	`getMaxRetries()` `AWS::DataBrew::Job.MaxRetries`.
`java.lang.String`	`getName()` `AWS::DataBrew::Job.Name`.
`java.lang.Object`	`getOutputLocation()` `AWS::DataBrew::Job.OutputLocation`.
`java.lang.Object`	`getOutputs()` `AWS::DataBrew::Job.Outputs`.
`java.lang.Object`	`getProfileConfiguration()` `AWS::DataBrew::Job.ProfileConfiguration`.
`java.lang.String`	`getProjectName()` `AWS::DataBrew::Job.ProjectName`.
`java.lang.Object`	`getRecipe()` `AWS::DataBrew::Job.Recipe`.
`java.lang.String`	`getRoleArn()` `AWS::DataBrew::Job.RoleArn`.
`TagManager`	`getTags()` `AWS::DataBrew::Job.Tags`.
`java.lang.Number`	`getTimeout()` `AWS::DataBrew::Job.Timeout`.
`java.lang.String`	`getType()` `AWS::DataBrew::Job.Type`.
`java.lang.Object`	`getValidationConfigurations()` `AWS::DataBrew::Job.ValidationConfigurations`.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDatabaseOutputs(IResolvable value)` `AWS::DataBrew::Job.DatabaseOutputs`.
`void`	`setDatabaseOutputs(java.util.List<java.lang.Object> value)` `AWS::DataBrew::Job.DatabaseOutputs`.
`void`	`setDataCatalogOutputs(IResolvable value)` `AWS::DataBrew::Job.DataCatalogOutputs`.
`void`	`setDataCatalogOutputs(java.util.List<java.lang.Object> value)` `AWS::DataBrew::Job.DataCatalogOutputs`.
`void`	`setDatasetName(java.lang.String value)` `AWS::DataBrew::Job.DatasetName`.
`void`	`setEncryptionKeyArn(java.lang.String value)` `AWS::DataBrew::Job.EncryptionKeyArn`.
`void`	`setEncryptionMode(java.lang.String value)` `AWS::DataBrew::Job.EncryptionMode`.
`void`	`setJobSample(CfnJob.JobSampleProperty value)` `AWS::DataBrew::Job.JobSample`.
`void`	`setJobSample(IResolvable value)` `AWS::DataBrew::Job.JobSample`.
`void`	`setLogSubscription(java.lang.String value)` `AWS::DataBrew::Job.LogSubscription`.
`void`	`setMaxCapacity(java.lang.Number value)` `AWS::DataBrew::Job.MaxCapacity`.
`void`	`setMaxRetries(java.lang.Number value)` `AWS::DataBrew::Job.MaxRetries`.
`void`	`setName(java.lang.String value)` `AWS::DataBrew::Job.Name`.
`void`	`setOutputLocation(CfnJob.OutputLocationProperty value)` `AWS::DataBrew::Job.OutputLocation`.
`void`	`setOutputLocation(IResolvable value)` `AWS::DataBrew::Job.OutputLocation`.
`void`	`setOutputs(IResolvable value)` `AWS::DataBrew::Job.Outputs`.
`void`	`setOutputs(java.util.List<java.lang.Object> value)` `AWS::DataBrew::Job.Outputs`.
`void`	`setProfileConfiguration(CfnJob.ProfileConfigurationProperty value)` `AWS::DataBrew::Job.ProfileConfiguration`.
`void`	`setProfileConfiguration(IResolvable value)` `AWS::DataBrew::Job.ProfileConfiguration`.
`void`	`setProjectName(java.lang.String value)` `AWS::DataBrew::Job.ProjectName`.
`void`	`setRecipe(CfnJob.RecipeProperty value)` `AWS::DataBrew::Job.Recipe`.
`void`	`setRecipe(IResolvable value)` `AWS::DataBrew::Job.Recipe`.
`void`	`setRoleArn(java.lang.String value)` `AWS::DataBrew::Job.RoleArn`.
`void`	`setTimeout(java.lang.Number value)` `AWS::DataBrew::Job.Timeout`.
`void`	`setType(java.lang.String value)` `AWS::DataBrew::Job.Type`.
`void`	`setValidationConfigurations(IResolvable value)` `AWS::DataBrew::Job.ValidationConfigurations`.
`void`	`setValidationConfigurations(java.util.List<java.lang.Object> value)` `AWS::DataBrew::Job.ValidationConfigurations`.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnJob
```
protected CfnJob(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnJob
```
protected CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnJob
```
public CfnJob(Construct scope,
              java.lang.String id,
              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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    `AWS::DataBrew::Job.Tags`.
  - getName
```
public java.lang.String getName()
```
    `AWS::DataBrew::Job.Name`.
  - setName
```
public void setName(java.lang.String value)
```
    `AWS::DataBrew::Job.Name`.
  - getRoleArn
```
public java.lang.String getRoleArn()
```
    `AWS::DataBrew::Job.RoleArn`.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    `AWS::DataBrew::Job.RoleArn`.
  - getType
```
public java.lang.String getType()
```
    `AWS::DataBrew::Job.Type`.
  - setType
```
public void setType(java.lang.String value)
```
    `AWS::DataBrew::Job.Type`.
  - getDatabaseOutputs
```
public java.lang.Object getDatabaseOutputs()
```
    `AWS::DataBrew::Job.DatabaseOutputs`.
  - setDatabaseOutputs
```
public void setDatabaseOutputs(IResolvable value)
```
    `AWS::DataBrew::Job.DatabaseOutputs`.
  - setDatabaseOutputs
```
public void setDatabaseOutputs(java.util.List<java.lang.Object> value)
```
    `AWS::DataBrew::Job.DatabaseOutputs`.
  - getDataCatalogOutputs
```
public java.lang.Object getDataCatalogOutputs()
```
    `AWS::DataBrew::Job.DataCatalogOutputs`.
  - setDataCatalogOutputs
```
public void setDataCatalogOutputs(IResolvable value)
```
    `AWS::DataBrew::Job.DataCatalogOutputs`.
  - setDataCatalogOutputs
```
public void setDataCatalogOutputs(java.util.List<java.lang.Object> value)
```
    `AWS::DataBrew::Job.DataCatalogOutputs`.
  - getDatasetName
```
public java.lang.String getDatasetName()
```
    `AWS::DataBrew::Job.DatasetName`.
  - setDatasetName
```
public void setDatasetName(java.lang.String value)
```
    `AWS::DataBrew::Job.DatasetName`.
  - getEncryptionKeyArn
```
public java.lang.String getEncryptionKeyArn()
```
    `AWS::DataBrew::Job.EncryptionKeyArn`.
  - setEncryptionKeyArn
```
public void setEncryptionKeyArn(java.lang.String value)
```
    `AWS::DataBrew::Job.EncryptionKeyArn`.
  - getEncryptionMode
```
public java.lang.String getEncryptionMode()
```
    `AWS::DataBrew::Job.EncryptionMode`.
  - setEncryptionMode
```
public void setEncryptionMode(java.lang.String value)
```
    `AWS::DataBrew::Job.EncryptionMode`.
  - getJobSample
```
public java.lang.Object getJobSample()
```
    `AWS::DataBrew::Job.JobSample`.
  - setJobSample
```
public void setJobSample(IResolvable value)
```
    `AWS::DataBrew::Job.JobSample`.
  - setJobSample
```
public void setJobSample(CfnJob.JobSampleProperty value)
```
    `AWS::DataBrew::Job.JobSample`.
  - getLogSubscription
```
public java.lang.String getLogSubscription()
```
    `AWS::DataBrew::Job.LogSubscription`.
  - setLogSubscription
```
public void setLogSubscription(java.lang.String value)
```
    `AWS::DataBrew::Job.LogSubscription`.
  - getMaxCapacity
```
public java.lang.Number getMaxCapacity()
```
    `AWS::DataBrew::Job.MaxCapacity`.
  - setMaxCapacity
```
public void setMaxCapacity(java.lang.Number value)
```
    `AWS::DataBrew::Job.MaxCapacity`.
  - getMaxRetries
```
public java.lang.Number getMaxRetries()
```
    `AWS::DataBrew::Job.MaxRetries`.
  - setMaxRetries
```
public void setMaxRetries(java.lang.Number value)
```
    `AWS::DataBrew::Job.MaxRetries`.
  - getOutputLocation
```
public java.lang.Object getOutputLocation()
```
    `AWS::DataBrew::Job.OutputLocation`.
  - setOutputLocation
```
public void setOutputLocation(IResolvable value)
```
    `AWS::DataBrew::Job.OutputLocation`.
  - setOutputLocation
```
public void setOutputLocation(CfnJob.OutputLocationProperty value)
```
    `AWS::DataBrew::Job.OutputLocation`.
  - getOutputs
```
public java.lang.Object getOutputs()
```
    `AWS::DataBrew::Job.Outputs`.
  - setOutputs
```
public void setOutputs(IResolvable value)
```
    `AWS::DataBrew::Job.Outputs`.
  - setOutputs
```
public void setOutputs(java.util.List<java.lang.Object> value)
```
    `AWS::DataBrew::Job.Outputs`.
  - getProfileConfiguration
```
public java.lang.Object getProfileConfiguration()
```
    `AWS::DataBrew::Job.ProfileConfiguration`.
  - setProfileConfiguration
```
public void setProfileConfiguration(IResolvable value)
```
    `AWS::DataBrew::Job.ProfileConfiguration`.
  - setProfileConfiguration
```
public void setProfileConfiguration(CfnJob.ProfileConfigurationProperty value)
```
    `AWS::DataBrew::Job.ProfileConfiguration`.
  - getProjectName
```
public java.lang.String getProjectName()
```
    `AWS::DataBrew::Job.ProjectName`.
  - setProjectName
```
public void setProjectName(java.lang.String value)
```
    `AWS::DataBrew::Job.ProjectName`.
  - getRecipe
```
public java.lang.Object getRecipe()
```
    `AWS::DataBrew::Job.Recipe`.
  - setRecipe
```
public void setRecipe(IResolvable value)
```
    `AWS::DataBrew::Job.Recipe`.
  - setRecipe
```
public void setRecipe(CfnJob.RecipeProperty value)
```
    `AWS::DataBrew::Job.Recipe`.
  - getTimeout
```
public java.lang.Number getTimeout()
```
    `AWS::DataBrew::Job.Timeout`.
  - setTimeout
```
public void setTimeout(java.lang.Number value)
```
    `AWS::DataBrew::Job.Timeout`.
  - getValidationConfigurations
```
public java.lang.Object getValidationConfigurations()
```
    `AWS::DataBrew::Job.ValidationConfigurations`.
  - setValidationConfigurations
```
public void setValidationConfigurations(IResolvable value)
```
    `AWS::DataBrew::Job.ValidationConfigurations`.
  - setValidationConfigurations
```
public void setValidationConfigurations(java.util.List<java.lang.Object> value)
```
    `AWS::DataBrew::Job.ValidationConfigurations`.

Class CfnJob

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnJob

CfnJob

CfnJob

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getName

setName

getRoleArn

setRoleArn

getType

setType

getDatabaseOutputs

setDatabaseOutputs

setDatabaseOutputs

getDataCatalogOutputs

setDataCatalogOutputs

setDataCatalogOutputs

getDatasetName

setDatasetName

getEncryptionKeyArn

setEncryptionKeyArn

getEncryptionMode

setEncryptionMode

getJobSample

setJobSample

setJobSample

getLogSubscription

setLogSubscription

getMaxCapacity

setMaxCapacity

getMaxRetries

setMaxRetries

getOutputLocation

setOutputLocation

setOutputLocation

getOutputs

setOutputs

setOutputs

getProfileConfiguration

setProfileConfiguration

setProfileConfiguration

getProjectName

setProjectName

getRecipe

setRecipe

setRecipe

getTimeout

setTimeout

getValidationConfigurations

setValidationConfigurations

setValidationConfigurations