AWS::KinesisFirehose::DeliveryStream SchemaConfiguration - AWS CloudFormation
SyntaxProperties

AWS::KinesisFirehose::DeliveryStream SchemaConfiguration

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "CatalogId" : String,
  "DatabaseName" : String,
  "Region" : String,
  "RoleARN" : String,
  "TableName" : String,
  "VersionId" : String
}

YAML

  CatalogId: String
  DatabaseName: String
  Region: String
  RoleARN: String
  TableName: String
  VersionId: String

Properties

CatalogId

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

DatabaseName

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

Important

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.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

Region

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

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

RoleARN

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.

Important

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.

Required: No

Type: String

Pattern: arn:.*

Minimum: 1

Maximum: 512

Update requires: No interruption

TableName

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

Important

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.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 1024

Update requires: No interruption

VersionId

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.

Required: No

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 1024

Update requires: No interruption