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

Class CfnStreamConsumerPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.kinesis.CfnStreamConsumerPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:00.671Z") @Stability(Stable) public class CfnStreamConsumerPropsMixin extends Mixin implements software.constructs.IMixin
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 .

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.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnStreamConsumerPropsMixin cfnStreamConsumerPropsMixin = CfnStreamConsumerPropsMixin.Builder.create(CfnStreamConsumerMixinProps.builder()
         .consumerName("consumerName")
         .streamArn("streamArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnStreamConsumerPropsMixin

      protected CfnStreamConsumerPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStreamConsumerPropsMixin

      protected CfnStreamConsumerPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStreamConsumerPropsMixin

      @Stability(Stable) public CfnStreamConsumerPropsMixin(@NotNull CfnStreamConsumerMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Kinesis::StreamConsumer.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnStreamConsumerPropsMixin

      @Stability(Stable) public CfnStreamConsumerPropsMixin(@NotNull CfnStreamConsumerMixinProps props)
      Create a mixin to apply properties to AWS::Kinesis::StreamConsumer.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnStreamConsumerMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()