Class CfnDeliveryStream.SchemaConfigurationProperty

Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.

Inheritance

System.Object

CfnDeliveryStream.SchemaConfigurationProperty

Implements

CfnDeliveryStream.ISchemaConfigurationProperty

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SchemaConfigurationProperty : Object, CfnDeliveryStream.ISchemaConfigurationProperty

Syntax (vb)

Public Class SchemaConfigurationProperty
    Inherits Object
    Implements CfnDeliveryStream.ISchemaConfigurationProperty

Remarks

This parameter is required if Enabled is set to true.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html

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

Constructors

SchemaConfigurationProperty()

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 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.

Constructors

SchemaConfigurationProperty()

public SchemaConfigurationProperty()

Properties

CatalogId

The ID of the AWS Glue Data Catalog.

public string CatalogId { get; set; }

Property Value

System.String

Remarks

If you don't supply this, the AWS account ID is used by default.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-catalogid

DatabaseName

Specifies the name of the AWS Glue database that contains the schema for the output data.

public string DatabaseName { get; set; }

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.

public string Region { get; set; }

Property Value

System.String

Remarks

RoleArn

The role that Firehose can use to access AWS Glue.

public string RoleArn { get; set; }

Property Value

System.String

Remarks

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.

TableName

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

public string TableName { get; set; }

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.

public string VersionId { get; set; }

Property Value

System.String

Remarks

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.

Implements

CfnDeliveryStream.ISchemaConfigurationProperty