Package software.amazon.awscdk.services.kinesis

Interface CfnChannel.StreamConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannel.StreamConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnChannel

@Stability(Stable)
public static interface CfnChannel.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.services.kinesis.*;
 StreamConfigurationProperty streamConfigurationProperty = StreamConfigurationProperty.builder()
         .recordConfiguration(RecordConfigurationProperty.builder()
                 .recordFormatType("recordFormatType")
                 // the properties below are optional
                 .gsrSchemaArn("gsrSchemaArn")
                 .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	CfnChannel.StreamConfigurationProperty.Builder	A builder for CfnChannel.StreamConfigurationProperty
static final class	CfnChannel.StreamConfigurationProperty.Jsii$Proxy	An implementation for CfnChannel.StreamConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnChannel.StreamConfigurationProperty.Builder	builder()
Object	getRecordConfiguration()	The configuration that describes how records on the source stream are encoded.
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)
@NotNull
Object getRecordConfiguration()

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

Returns union: either IResolvable or CfnChannel.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)
@NotNull
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 CfnChannel.StreamConfigurationProperty.Builder builder()

Returns:

a CfnChannel.StreamConfigurationProperty.Builder of CfnChannel.StreamConfigurationProperty