Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data SchemaConfiguration = SchemaConfiguration' {}
- newSchemaConfiguration :: SchemaConfiguration
- schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text)
- schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text)
Documentation
data SchemaConfiguration Source #
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.
See: newSchemaConfiguration
smart constructor.
SchemaConfiguration' | |
|
Instances
newSchemaConfiguration :: SchemaConfiguration Source #
Create a value of SchemaConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:catalogId:SchemaConfiguration'
, schemaConfiguration_catalogId
- 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.
$sel:databaseName:SchemaConfiguration'
, schemaConfiguration_databaseName
- 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.
$sel:region:SchemaConfiguration'
, schemaConfiguration_region
- If you don't specify an Amazon Web Services Region, the default is the
current Region.
$sel:roleARN:SchemaConfiguration'
, schemaConfiguration_roleARN
- The role that Kinesis Data Firehose can use to access Amazon Web
Services Glue. This role must be in the same account you use for Kinesis
Data 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.
$sel:tableName:SchemaConfiguration'
, schemaConfiguration_tableName
- 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.
$sel:versionId:SchemaConfiguration'
, schemaConfiguration_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.
schemaConfiguration_catalogId :: Lens' SchemaConfiguration (Maybe Text) Source #
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.
schemaConfiguration_databaseName :: Lens' SchemaConfiguration (Maybe Text) Source #
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.
schemaConfiguration_region :: Lens' SchemaConfiguration (Maybe Text) Source #
If you don't specify an Amazon Web Services Region, the default is the current Region.
schemaConfiguration_roleARN :: Lens' SchemaConfiguration (Maybe Text) Source #
The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data 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.
schemaConfiguration_tableName :: Lens' SchemaConfiguration (Maybe Text) Source #
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.
schemaConfiguration_versionId :: Lens' SchemaConfiguration (Maybe Text) Source #
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.