Package software.amazon.awscdk.services.databrew

Interface CfnJob.DataCatalogOutputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJob.DataCatalogOutputProperty.Jsii$Proxy

Enclosing class:

CfnJob

@Stability(Stable)
public static interface CfnJob.DataCatalogOutputProperty
extends software.amazon.jsii.JsiiSerializable

Represents options that specify how and where in the AWS Glue Data Catalog DataBrew writes the output generated by recipe jobs.

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.*;
 DataCatalogOutputProperty dataCatalogOutputProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJob.DataCatalogOutputProperty.Builder	A builder for CfnJob.DataCatalogOutputProperty
static final class	CfnJob.DataCatalogOutputProperty.Jsii$Proxy	An implementation for CfnJob.DataCatalogOutputProperty

Method Summary

Modifier and Type	Method	Description
static CfnJob.DataCatalogOutputProperty.Builder	builder()
default String	getCatalogId()	The unique identifier of the AWS account that holds the Data Catalog that stores the data.
String	getDatabaseName()	The name of a database in the Data Catalog.
default Object	getDatabaseOptions()	Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.
default Object	getOverwrite()	A value that, if true, means that any data in the location specified for output is overwritten with new output.
default Object	getS3Options()	Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.
String	getTableName()	The name of a table in the Data Catalog.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

The name of a database in the Data Catalog.

getTableName

@Stability(Stable)
@NotNull
String getTableName()

The name of a table in the Data Catalog.

getCatalogId

@Stability(Stable)
@Nullable
default String getCatalogId()

The unique identifier of the AWS account that holds the Data Catalog that stores the data.

getDatabaseOptions

@Stability(Stable)
@Nullable
default Object getDatabaseOptions()

Represents options that specify how and where DataBrew writes the database output generated by recipe jobs.

getOverwrite

@Stability(Stable)
@Nullable
default Object getOverwrite()

A value that, if true, means that any data in the location specified for output is overwritten with new output.

Not supported with DatabaseOptions.

getS3Options

@Stability(Stable)
@Nullable
default Object getS3Options()

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by recipe jobs.

builder

@Stability(Stable)
static CfnJob.DataCatalogOutputProperty.Builder builder()

Returns:

a CfnJob.DataCatalogOutputProperty.Builder of CfnJob.DataCatalogOutputProperty