Package software.amazon.awscdk.cfnpropertymixins.services.kinesis

Interface CfnChannelPropsMixin.StreamConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelPropsMixin.StreamConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannelPropsMixin

@Stability(Stable)
public static interface CfnChannelPropsMixin.StreamConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration of a Kinesis stream that the channel reads from.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kinesis.*;
 StreamConfigurationProperty streamConfigurationProperty = StreamConfigurationProperty.builder()
         .recordConfiguration(RecordConfigurationProperty.builder()
                 .gsrSchemaArn("gsrSchemaArn")
                 .recordFormatType("recordFormatType")
                 .build())
         .streamArn("streamArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnChannelPropsMixin.StreamConfigurationProperty.Builder	builder()
default Object	getRecordConfiguration()	The configuration that describes how records on the source stream are encoded.
default String	getStreamArn()	The Amazon resource name (ARN) of the Kinesis data stream that the channel reads from.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecordConfiguration

@Stability(Stable)
@Nullable
default Object getRecordConfiguration()

The configuration that describes how records on the source stream are encoded.

Returns union: either IResolvable or CfnChannelPropsMixin.RecordConfigurationProperty

See Also:

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

getStreamArn

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

The Amazon resource name (ARN) of the Kinesis data stream that the channel reads from.

See Also:

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

builder

@Stability(Stable)
static CfnChannelPropsMixin.StreamConfigurationProperty.Builder builder()

Returns:

a CfnChannelPropsMixin.StreamConfigurationProperty.Builder of CfnChannelPropsMixin.StreamConfigurationProperty