Skip to content

SchemaConfiguration

Source code in docs_src/capo_firehose/types/schema_configuration.py
class SchemaConfiguration(TypedDict, closed=True):
    role_arn: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>RoleARN</code> property is required and its value must be specified.</p> </important>"""
    catalog_id: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.</p>"""
    database_name: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>DatabaseName</code> property is required and its value must be specified.</p> </important>"""
    table_name: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema.</p> <important> <p>If the <code>SchemaConfiguration</code> request parameter is used as part of invoking the <code>CreateDeliveryStream</code> API, then the <code>TableName</code> property is required and its value must be specified.</p> </important>"""
    region: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>If you don't specify an Amazon Web Services Region, the default is the current Region.</p>"""
    version_id: NotRequired[
        "capo_firehose.types.non_empty_string_without_whitespace.NonEmptyStringWithoutWhitespace"
    ]
    """<p>Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to <code>LATEST</code>, Firehose uses the most recent version. This means that any updates to the table are automatically picked up.</p>"""

catalog_id instance-attribute

catalog_id: NotRequired[NonEmptyStringWithoutWhitespace]

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

database_name instance-attribute

database_name: NotRequired[NonEmptyStringWithoutWhitespace]

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

region instance-attribute

region: NotRequired[NonEmptyStringWithoutWhitespace]

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

role_arn instance-attribute

role_arn: NotRequired[NonEmptyStringWithoutWhitespace]

The role that Firehose can use to access Amazon Web Services 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.

table_name instance-attribute

table_name: NotRequired[NonEmptyStringWithoutWhitespace]

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

version_id instance-attribute

version_id: NotRequired[NonEmptyStringWithoutWhitespace]

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.