software.amazon.awscdk.services.databrew

Class CfnJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.databrew.CfnJob

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:20.953Z")
 @Stability(value=Stable)
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.*;
 Object parameters;
 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(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(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();
 

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.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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJob(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getDatabaseOutputs() `AWS::DataBrew::Job.DatabaseOutputs`.
Object	getDataCatalogOutputs() `AWS::DataBrew::Job.DataCatalogOutputs`.
String	getDatasetName() `AWS::DataBrew::Job.DatasetName`.
String	getEncryptionKeyArn() `AWS::DataBrew::Job.EncryptionKeyArn`.
String	getEncryptionMode() `AWS::DataBrew::Job.EncryptionMode`.
Object	getJobSample() `AWS::DataBrew::Job.JobSample`.
String	getLogSubscription() `AWS::DataBrew::Job.LogSubscription`.
Number	getMaxCapacity() `AWS::DataBrew::Job.MaxCapacity`.
Number	getMaxRetries() `AWS::DataBrew::Job.MaxRetries`.
String	getName() `AWS::DataBrew::Job.Name`.
Object	getOutputLocation() `AWS::DataBrew::Job.OutputLocation`.
Object	getOutputs() `AWS::DataBrew::Job.Outputs`.
Object	getProfileConfiguration() `AWS::DataBrew::Job.ProfileConfiguration`.
String	getProjectName() `AWS::DataBrew::Job.ProjectName`.
Object	getRecipe() `AWS::DataBrew::Job.Recipe`.
String	getRoleArn() `AWS::DataBrew::Job.RoleArn`.
TagManager	getTags() `AWS::DataBrew::Job.Tags`.
Number	getTimeout() `AWS::DataBrew::Job.Timeout`.
String	getType() `AWS::DataBrew::Job.Type`.
Object	getValidationConfigurations() `AWS::DataBrew::Job.ValidationConfigurations`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDatabaseOutputs(IResolvable value) `AWS::DataBrew::Job.DatabaseOutputs`.
void	setDatabaseOutputs(List<Object> value) `AWS::DataBrew::Job.DatabaseOutputs`.
void	setDataCatalogOutputs(IResolvable value) `AWS::DataBrew::Job.DataCatalogOutputs`.
void	setDataCatalogOutputs(List<Object> value) `AWS::DataBrew::Job.DataCatalogOutputs`.
void	setDatasetName(String value) `AWS::DataBrew::Job.DatasetName`.
void	setEncryptionKeyArn(String value) `AWS::DataBrew::Job.EncryptionKeyArn`.
void	setEncryptionMode(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(String value) `AWS::DataBrew::Job.LogSubscription`.
void	setMaxCapacity(Number value) `AWS::DataBrew::Job.MaxCapacity`.
void	setMaxRetries(Number value) `AWS::DataBrew::Job.MaxRetries`.
void	setName(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(List<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(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(String value) `AWS::DataBrew::Job.RoleArn`.
void	setTimeout(Number value) `AWS::DataBrew::Job.Timeout`.
void	setType(String value) `AWS::DataBrew::Job.Type`.
void	setValidationConfigurations(IResolvable value) `AWS::DataBrew::Job.ValidationConfigurations`.
void	setValidationConfigurations(List<Object> value) `AWS::DataBrew::Job.ValidationConfigurations`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnJob(@NotNull
                                       software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::DataBrew::Job.Tags`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::DataBrew::Job.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::DataBrew::Job.Name`.

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

`AWS::DataBrew::Job.RoleArn`.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

`AWS::DataBrew::Job.RoleArn`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::DataBrew::Job.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::DataBrew::Job.Type`.

getDatabaseOutputs

@Stability(value=Stable)
 @Nullable
public Object getDatabaseOutputs()

`AWS::DataBrew::Job.DatabaseOutputs`.

setDatabaseOutputs

@Stability(value=Stable)
public void setDatabaseOutputs(@Nullable
                                                        IResolvable value)

`AWS::DataBrew::Job.DatabaseOutputs`.

setDatabaseOutputs

@Stability(value=Stable)
public void setDatabaseOutputs(@Nullable
                                                        List<Object> value)

`AWS::DataBrew::Job.DatabaseOutputs`.

getDataCatalogOutputs

@Stability(value=Stable)
 @Nullable
public Object getDataCatalogOutputs()

`AWS::DataBrew::Job.DataCatalogOutputs`.

setDataCatalogOutputs

@Stability(value=Stable)
public void setDataCatalogOutputs(@Nullable
                                                           IResolvable value)

`AWS::DataBrew::Job.DataCatalogOutputs`.

setDataCatalogOutputs

@Stability(value=Stable)
public void setDataCatalogOutputs(@Nullable
                                                           List<Object> value)

`AWS::DataBrew::Job.DataCatalogOutputs`.

getDatasetName

@Stability(value=Stable)
 @Nullable
public String getDatasetName()

`AWS::DataBrew::Job.DatasetName`.

setDatasetName

@Stability(value=Stable)
public void setDatasetName(@Nullable
                                                    String value)

`AWS::DataBrew::Job.DatasetName`.

getEncryptionKeyArn

@Stability(value=Stable)
 @Nullable
public String getEncryptionKeyArn()

`AWS::DataBrew::Job.EncryptionKeyArn`.

setEncryptionKeyArn

@Stability(value=Stable)
public void setEncryptionKeyArn(@Nullable
                                                         String value)

`AWS::DataBrew::Job.EncryptionKeyArn`.

getEncryptionMode

@Stability(value=Stable)
 @Nullable
public String getEncryptionMode()

`AWS::DataBrew::Job.EncryptionMode`.

setEncryptionMode

@Stability(value=Stable)
public void setEncryptionMode(@Nullable
                                                       String value)

`AWS::DataBrew::Job.EncryptionMode`.

getJobSample

@Stability(value=Stable)
 @Nullable
public Object getJobSample()

`AWS::DataBrew::Job.JobSample`.

setJobSample

@Stability(value=Stable)
public void setJobSample(@Nullable
                                                  CfnJob.JobSampleProperty value)

`AWS::DataBrew::Job.JobSample`.

setJobSample

@Stability(value=Stable)
public void setJobSample(@Nullable
                                                  IResolvable value)

`AWS::DataBrew::Job.JobSample`.

getLogSubscription

@Stability(value=Stable)
 @Nullable
public String getLogSubscription()

`AWS::DataBrew::Job.LogSubscription`.

setLogSubscription

@Stability(value=Stable)
public void setLogSubscription(@Nullable
                                                        String value)

`AWS::DataBrew::Job.LogSubscription`.

getMaxCapacity

@Stability(value=Stable)
 @Nullable
public Number getMaxCapacity()

`AWS::DataBrew::Job.MaxCapacity`.

setMaxCapacity

@Stability(value=Stable)
public void setMaxCapacity(@Nullable
                                                    Number value)

`AWS::DataBrew::Job.MaxCapacity`.

getMaxRetries

@Stability(value=Stable)
 @Nullable
public Number getMaxRetries()

`AWS::DataBrew::Job.MaxRetries`.

setMaxRetries

@Stability(value=Stable)
public void setMaxRetries(@Nullable
                                                   Number value)

`AWS::DataBrew::Job.MaxRetries`.

getOutputLocation

@Stability(value=Stable)
 @Nullable
public Object getOutputLocation()

`AWS::DataBrew::Job.OutputLocation`.

setOutputLocation

@Stability(value=Stable)
public void setOutputLocation(@Nullable
                                                       CfnJob.OutputLocationProperty value)

`AWS::DataBrew::Job.OutputLocation`.

setOutputLocation

@Stability(value=Stable)
public void setOutputLocation(@Nullable
                                                       IResolvable value)

`AWS::DataBrew::Job.OutputLocation`.

getOutputs

@Stability(value=Stable)
 @Nullable
public Object getOutputs()

`AWS::DataBrew::Job.Outputs`.

setOutputs

@Stability(value=Stable)
public void setOutputs(@Nullable
                                                IResolvable value)

`AWS::DataBrew::Job.Outputs`.

setOutputs

@Stability(value=Stable)
public void setOutputs(@Nullable
                                                List<Object> value)

`AWS::DataBrew::Job.Outputs`.

getProfileConfiguration

@Stability(value=Stable)
 @Nullable
public Object getProfileConfiguration()

`AWS::DataBrew::Job.ProfileConfiguration`.

setProfileConfiguration

@Stability(value=Stable)
public void setProfileConfiguration(@Nullable
                                                             CfnJob.ProfileConfigurationProperty value)

`AWS::DataBrew::Job.ProfileConfiguration`.

setProfileConfiguration

@Stability(value=Stable)
public void setProfileConfiguration(@Nullable
                                                             IResolvable value)

`AWS::DataBrew::Job.ProfileConfiguration`.

getProjectName

@Stability(value=Stable)
 @Nullable
public String getProjectName()

`AWS::DataBrew::Job.ProjectName`.

setProjectName

@Stability(value=Stable)
public void setProjectName(@Nullable
                                                    String value)

`AWS::DataBrew::Job.ProjectName`.

getRecipe

@Stability(value=Stable)
 @Nullable
public Object getRecipe()

`AWS::DataBrew::Job.Recipe`.

setRecipe

@Stability(value=Stable)
public void setRecipe(@Nullable
                                               CfnJob.RecipeProperty value)

`AWS::DataBrew::Job.Recipe`.

setRecipe

@Stability(value=Stable)
public void setRecipe(@Nullable
                                               IResolvable value)

`AWS::DataBrew::Job.Recipe`.

getTimeout

@Stability(value=Stable)
 @Nullable
public Number getTimeout()

`AWS::DataBrew::Job.Timeout`.

setTimeout

@Stability(value=Stable)
public void setTimeout(@Nullable
                                                Number value)

`AWS::DataBrew::Job.Timeout`.

getValidationConfigurations

@Stability(value=Stable)
 @Nullable
public Object getValidationConfigurations()

`AWS::DataBrew::Job.ValidationConfigurations`.

setValidationConfigurations

@Stability(value=Stable)
public void setValidationConfigurations(@Nullable
                                                                 IResolvable value)

`AWS::DataBrew::Job.ValidationConfigurations`.

setValidationConfigurations

@Stability(value=Stable)
public void setValidationConfigurations(@Nullable
                                                                 List<Object> value)

`AWS::DataBrew::Job.ValidationConfigurations`.