Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.RecordConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.RecordConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.RecordConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kinesis.*;
 RecordConfigurationProperty recordConfigurationProperty = RecordConfigurationProperty.builder()
         .recordFormatType("recordFormatType")
         // the properties below are optional
         .gsrSchemaArn("gsrSchemaArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-recordconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannel.RecordConfigurationProperty.Builder	A builder for CfnChannel.RecordConfigurationProperty
static final class	CfnChannel.RecordConfigurationProperty.Jsii$Proxy	An implementation for CfnChannel.RecordConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannel.RecordConfigurationProperty.Builder	builder()
default String	getGsrSchemaArn()	The ARN of the AWS Glue Schema Registry (GSR) schema.
String	getRecordFormatType()	The format used to interpret records read from the source stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecordFormatType

@Stability(Stable)
@NotNull
String getRecordFormatType()

The format used to interpret records read from the source stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-recordconfiguration.html#cfn-kinesis-channel-recordconfiguration-recordformattype

getGsrSchemaArn

@Stability(Stable)
@Nullable
default String getGsrSchemaArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-channel-recordconfiguration.html#cfn-kinesis-channel-recordconfiguration-gsrschemaarn

builder

@Stability(Stable)
static CfnChannel.RecordConfigurationProperty.Builder builder()

Returns:

a CfnChannel.RecordConfigurationProperty.Builder of CfnChannel.RecordConfigurationProperty