Package software.amazon.awscdk.services.databrew

Interface CfnDataset.DatabaseInputDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataset.DatabaseInputDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnDataset

@Stability(Stable)
public static interface CfnDataset.DatabaseInputDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

Connection information for dataset input files stored in a database.

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.*;
 DatabaseInputDefinitionProperty databaseInputDefinitionProperty = DatabaseInputDefinitionProperty.builder()
         .glueConnectionName("glueConnectionName")
         // the properties below are optional
         .databaseTableName("databaseTableName")
         .queryString("queryString")
         .tempDirectory(S3LocationProperty.builder()
                 .bucket("bucket")
                 // the properties below are optional
                 .key("key")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataset.DatabaseInputDefinitionProperty.Builder	builder()
default String	getDatabaseTableName()	The table within the target database.
String	getGlueConnectionName()	The AWS Glue Connection that stores the connection information for the target database.
default String	getQueryString()	Custom SQL to run against the provided AWS Glue connection.
default Object	getTempDirectory()	An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGlueConnectionName

@Stability(Stable)
@NotNull
String getGlueConnectionName()

The AWS Glue Connection that stores the connection information for the target database.

getDatabaseTableName

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

The table within the target database.

getQueryString

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

Custom SQL to run against the provided AWS Glue connection.

This SQL will be used as the input for DataBrew projects and jobs.

getTempDirectory

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

An Amazon location that AWS Glue Data Catalog can use as a temporary directory.

builder

@Stability(Stable)
static CfnDataset.DatabaseInputDefinitionProperty.Builder builder()

Returns:

a CfnDataset.DatabaseInputDefinitionProperty.Builder of CfnDataset.DatabaseInputDefinitionProperty