Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.SchemaConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.SchemaConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

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

Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.

This parameter is required if Enabled is set to true.

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.*;
 SchemaConfigurationProperty schemaConfigurationProperty = SchemaConfigurationProperty.builder()
         .catalogId("catalogId")
         .databaseName("databaseName")
         .region("region")
         .roleArn("roleArn")
         .tableName("tableName")
         .versionId("versionId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.SchemaConfigurationProperty.Builder	builder()
default String	getCatalogId()	The ID of the AWS Glue Data Catalog.
default String	getDatabaseName()	Specifies the name of the AWS Glue database that contains the schema for the output data.
default String	getRegion()	If you don't specify an AWS Region, the default is the current Region.
default String	getRoleArn()	The role that Firehose can use to access AWS Glue.
default String	getTableName()	Specifies the AWS Glue table that contains the column information that constitutes your data schema.
default String	getVersionId()	Specifies the table version for the output data schema.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCatalogId

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

The ID of the AWS Glue Data Catalog.

If you don't supply this, the AWS account ID is used by default.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid

getDatabaseName

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

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-databasename

getRegion

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

If you don't specify an AWS Region, the default is the current Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-region

getRoleArn

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

The role that Firehose can use to access AWS Glue.

This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-rolearn

getTableName

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

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-tablename

getVersionId

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

Specifies the table version for the output data schema.

If you don't specify this version ID, or if you set it to LATEST , Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid

builder

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

Returns:

a CfnDeliveryStream.SchemaConfigurationProperty.Builder of CfnDeliveryStream.SchemaConfigurationProperty