Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.CopyCommandProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.CopyCommandProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(Stable)
public static interface CfnDeliveryStream.CopyCommandProperty
extends software.amazon.jsii.JsiiSerializable

The CopyCommand property type configures the Amazon Redshift COPY command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.

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.kinesisfirehose.*;
 CopyCommandProperty copyCommandProperty = CopyCommandProperty.builder()
         .dataTableName("dataTableName")
         // the properties below are optional
         .copyOptions("copyOptions")
         .dataTableColumns("dataTableColumns")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.CopyCommandProperty.Builder	builder()
default String	getCopyOptions()	Parameters to use with the Amazon Redshift COPY command.
default String	getDataTableColumns()	A comma-separated list of column names.
String	getDataTableName()	The name of the target table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataTableName

@Stability(Stable)
@NotNull
String getDataTableName()

The name of the target table.

The table must already exist in the database.

getCopyOptions

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

Parameters to use with the Amazon Redshift COPY command.

For examples, see the CopyOptions content for the CopyCommand data type in the Amazon Kinesis Data Firehose API Reference .

getDataTableColumns

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

A comma-separated list of column names.

builder

@Stability(Stable)
static CfnDeliveryStream.CopyCommandProperty.Builder builder()

Returns:

a CfnDeliveryStream.CopyCommandProperty.Builder of CfnDeliveryStream.CopyCommandProperty