SchemaConfiguration - Amazon Kinesis Data Firehose
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SchemaConfiguration

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

Contents

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

DatabaseName

Specifies the name of the Amazon 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

Region

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

RoleARN

The role that Kinesis Data Firehose can use to access Amazon Glue. This role must be in the same account you use for Kinesis Data 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

TableName

Specifies the Amazon 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

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, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\S+$

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: