class CfnStreamConsumerPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Kinesis.Mixins.CfnStreamConsumerPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskinesis/mixins#CfnStreamConsumerPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.kinesis.mixins.CfnStreamConsumerPropsMixin
Python	aws_cdk.mixins_preview.aws_kinesis.mixins.CfnStreamConsumerPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_kinesis » mixins » CfnStreamConsumerPropsMixin

Implements IMixin

Extends Mixin

Use the AWS CloudFormation AWS::Kinesis::StreamConsumer resource to register a consumer with a Kinesis data stream.

The consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 20 consumers per stream. However, you can request a limit increase using the Kinesis Data Streams limits form . A given consumer can only be registered with one stream at a time.

For more information, see Using Consumers with Enhanced Fan-Out .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as kinesis_mixins } from '@aws-cdk/mixins-preview/aws-kinesis';
const cfnStreamConsumerPropsMixin = new kinesis_mixins.CfnStreamConsumerPropsMixin({
  consumerName: 'consumerName',
  streamArn: 'streamArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnStreamConsumerPropsMixin(props: CfnStreamConsumerMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnStreamConsumerMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Kinesis::StreamConsumer.

Properties

Name	Type	Description
props	CfnStreamConsumerMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnStreamConsumerMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.