interface RecordConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Kinesis.CfnChannel.RecordConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesis#CfnChannel_RecordConfigurationProperty |
 Java | software.amazon.awscdk.services.kinesis.CfnChannel.RecordConfigurationProperty |
 Python | aws_cdk.aws_kinesis.CfnChannel.RecordConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_kinesis » CfnChannel » RecordConfigurationProperty |
The configuration that describes how records on the source stream are encoded.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const recordConfigurationProperty: kinesis.CfnChannel.RecordConfigurationProperty = {
recordFormatType: 'recordFormatType',
// the properties below are optional
gsrSchemaArn: 'gsrSchemaArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| record | string | The format used to interpret records read from the source stream. |
| gsr | string | The ARN of the AWS Glue Schema Registry (GSR) schema. |
recordFormatType
Type:
string
The format used to interpret records read from the source stream.
gsrSchemaArn?
Type:
string
(optional)
The ARN of the AWS Glue Schema Registry (GSR) schema.
Required for the S3 Tables destination, where it is used to create the S3 Table and to validate that the record format matches the table schema. Also used when RecordFormatType is GSR_JSON to interpret records read from the source stream. Vanilla S3 delivery writes records as S3 objects and does not need a schema. The schema must be in the same account and region as the channel.