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.
Contents
- CatalogId
-
The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS 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 AWS Glue database that contains the schema for the output data.
Important
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theDatabaseNameproperty 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 AWS 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 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
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theRoleARNproperty 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 AWS Glue table that contains the column information that constitutes your data schema.
Important
If the
SchemaConfigurationrequest parameter is used as part of invoking theCreateDeliveryStreamAPI, then theTableNameproperty 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, 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 AWS SDKs, see the following:
