Class CfnDeliveryStream.SchemaConfigurationProperty

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

Inheritance

object

CfnDeliveryStream.SchemaConfigurationProperty

Implements

CfnDeliveryStream.ISchemaConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeliveryStream.SchemaConfigurationProperty : CfnDeliveryStream.ISchemaConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStream.SchemaConfigurationProperty 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()

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

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()

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

public SchemaConfigurationProperty()

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"
             };

Properties

CatalogId

The ID of the AWS Glue Data Catalog.

public string? CatalogId { get; set; }

Property Value

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

string

Remarks

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.

Region

If you don't specify an AWS Region, the default is the current Region.

public string? Region { get; set; }

Property Value

string

Remarks

RoleArn

The role that Firehose can use to access AWS Glue.

public string? RoleArn { get; set; }

Property Value

string

Remarks

This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.

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.

TableName

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

public string? TableName { get; set; }

Property Value

string

Remarks

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.

VersionId

Specifies the table version for the output data schema.

public string? VersionId { get; set; }

Property Value

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