Package software.amazon.awscdk.cfnpropertymixins.services.databrew

Interface CfnJobPropsMixin.DataCatalogOutputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobPropsMixin.DataCatalogOutputProperty.Jsii$Proxy

Enclosing class:

CfnJobPropsMixin

@Stability(Stable)
public static interface CfnJobPropsMixin.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.cfnpropertymixins.services.databrew.*;
 DataCatalogOutputProperty dataCatalogOutputProperty = DataCatalogOutputProperty.builder()
         .catalogId("catalogId")
         .databaseName("databaseName")
         .databaseOptions(DatabaseTableOutputOptionsProperty.builder()
                 .tableName("tableName")
                 .tempDirectory(S3LocationProperty.builder()
                         .bucket("bucket")
                         .bucketOwner("bucketOwner")
                         .key("key")
                         .build())
                 .build())
         .overwrite(false)
         .s3Options(S3TableOutputOptionsProperty.builder()
                 .location(S3LocationProperty.builder()
                         .bucket("bucket")
                         .bucketOwner("bucketOwner")
                         .key("key")
                         .build())
                 .build())
         .tableName("tableName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobPropsMixin.DataCatalogOutputProperty.Builder	builder()
default String	getCatalogId()	The unique identifier of the AWS account that holds the Data Catalog that stores the data.
default 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.
default String	getTableName()	The name of a table in the Data Catalog.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogId

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-catalogid

getDatabaseName

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

The name of a database in the Data Catalog.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databasename

getDatabaseOptions

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

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

Returns union: either IResolvable or CfnJobPropsMixin.DatabaseTableOutputOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-databaseoptions

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-overwrite

getS3Options

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

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

Returns union: either IResolvable or CfnJobPropsMixin.S3TableOutputOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-s3options

getTableName

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

The name of a table in the Data Catalog.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-datacatalogoutput.html#cfn-databrew-job-datacatalogoutput-tablename

builder

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

Returns:

a CfnJobPropsMixin.DataCatalogOutputProperty.Builder of CfnJobPropsMixin.DataCatalogOutputProperty