Interface CfnDeliveryStream.ISchemaConfigurationProperty
Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.AWS.KinesisFirehose.dll
Syntax (csharp)
public interface ISchemaConfigurationProperty
Syntax (vb)
Public Interface ISchemaConfigurationProperty
Remarks
This parameter is required if Enabled
is set to true.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisFirehose;
var schemaConfigurationProperty = new SchemaConfigurationProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
Region = "region",
RoleArn = "roleArn",
TableName = "tableName",
VersionId = "versionId"
};
Synopsis
Properties
CatalogId | The ID of the AWS Glue Data Catalog. |
DatabaseName | Specifies the name of the AWS Glue database that contains the schema for the output data. |
Region | If you don't specify an AWS Region, the default is the current Region. |
RoleArn | The role that Kinesis Data Firehose can use to access AWS Glue. |
TableName | Specifies the AWS Glue table that contains the column information that constitutes your data schema. |
VersionId | Specifies the table version for the output data schema. |
Properties
CatalogId
The ID of the AWS Glue Data Catalog.
virtual string CatalogId { get; }
Property Value
System.String
Remarks
If you don't supply this, the AWS account ID is used by default.
DatabaseName
Specifies the name of the AWS Glue database that contains the schema for the output data.
virtual string DatabaseName { get; }
Property Value
System.String
Remarks
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
If you don't specify an AWS Region, the default is the current Region.
virtual string Region { get; }
Property Value
System.String
Remarks
RoleArn
The role that Kinesis Data Firehose can use to access AWS Glue.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
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.
TableName
Specifies the AWS Glue table that contains the column information that constitutes your data schema.
virtual string TableName { get; }
Property Value
System.String
Remarks
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.
VersionId
Specifies the table version for the output data schema.
virtual string VersionId { get; }
Property Value
System.String
Remarks
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.