StreamConsumer L2 construct

A Kinesis Stream Consumer.

CloudFormation: AWS::Kinesis::StreamConsumer
L1 type: CfnStreamConsumer
Source: aws-kinesis/lib/stream-consumer.ts
Type last changed: v2.234.0 · 8 Jan 2026

Example

const lambdaRole = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
  description: 'Example role...',
});

const stream = new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
});
const streamConsumer = new kinesis.StreamConsumer(this, 'MyStreamConsumer', {
  streamConsumerName: 'MyStreamConsumer',
  stream,
});

// give lambda permissions to read stream via the stream consumer
streamConsumer.grantRead(lambdaRole);

python

lambda_role = iam.Role(self, "Role",
    assumed_by=iam.ServicePrincipal("lambda.amazonaws.com"),
    description="Example role..."
)

stream = kinesis.Stream(self, "MyEncryptedStream",
    encryption=kinesis.StreamEncryption.KMS
)
stream_consumer = kinesis.StreamConsumer(self, "MyStreamConsumer",
    stream_consumer_name="MyStreamConsumer",
    stream=stream
)

# give lambda permissions to read stream via the stream consumer
stream_consumer.grant_read(lambda_role)

java

Role lambdaRole = Role.Builder.create(this, "Role")
        .assumedBy(new ServicePrincipal("lambda.amazonaws.com"))
        .description("Example role...")
        .build();

Stream stream = Stream.Builder.create(this, "MyEncryptedStream")
        .encryption(StreamEncryption.KMS)
        .build();
StreamConsumer streamConsumer = StreamConsumer.Builder.create(this, "MyStreamConsumer")
        .streamConsumerName("MyStreamConsumer")
        .stream(stream)
        .build();

// give lambda permissions to read stream via the stream consumer
streamConsumer.grantRead(lambdaRole);

csharp

// Install: dotnet add package Amazon.CDK.Lib
var lambdaRole = new Role(this, "Role", new RoleProps {
    AssumedBy = new ServicePrincipal("lambda.amazonaws.com"),
    Description = "Example role..."
});

var stream = new Stream(this, "MyEncryptedStream", new StreamProps {
    Encryption = StreamEncryption.KMS
});
var streamConsumer = new StreamConsumer(this, "MyStreamConsumer", new StreamConsumerProps {
    StreamConsumerName = "MyStreamConsumer",
    Stream = stream
});

// give lambda permissions to read stream via the stream consumer
streamConsumer.GrantRead(lambdaRole);

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
lambdaRole := iam.NewRole(this, jsii.String("Role"), &RoleProps{
	AssumedBy: iam.NewServicePrincipal(jsii.String("lambda.amazonaws.com")),
	Description: jsii.String("Example role..."),
})

stream := kinesis.NewStream(this, jsii.String("MyEncryptedStream"), &StreamProps{
	Encryption: kinesis.StreamEncryption_KMS,
})
streamConsumer := kinesis.NewStreamConsumer(this, jsii.String("MyStreamConsumer"), &StreamConsumerProps{
	StreamConsumerName: jsii.String("MyStreamConsumer"),
	Stream: Stream,
})

// give lambda permissions to read stream via the stream consumer
streamConsumer.grantRead(lambdaRole)

Initializer

new StreamConsumer(scope: Construct, id: string, props: StreamConsumerProps)

python

StreamConsumer(scope: Construct, id: str, props: StreamConsumerProps)

java

new StreamConsumer(Construct scope, String id, StreamConsumerProps props)

csharp

new StreamConsumer(Construct scope, string id, StreamConsumerProps props)

NewStreamConsumer(Scope Construct, Id *string, Props StreamConsumerProps)

Construct Props

streamIStreamstreamIStreamstreamIStreamStreamIStreamStreamIStreamrequired#

The Kinesis data stream to associate this consumer with.

streamConsumerNamestringstream_consumer_namestrstreamConsumerNameStringStreamConsumerNamestringStreamConsumerName*stringrequired#

The name of the stream consumer.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

streamIStreamstreamIStreamstreamIStreamStreamIStreamStreamIStream#

The Kinesis data stream this consumer is associated with.

streamConsumerArnstringstream_consumer_arnstrstreamConsumerArnStringStreamConsumerArnstringStreamConsumerArn*string#

The Amazon Resource Name (ARN) of the stream consumer.

streamConsumerNamestringstream_consumer_namestrstreamConsumerNameStringStreamConsumerNamestringStreamConsumerName*string#

The name of the stream consumer.

streamConsumerRefStreamConsumerReferencestream_consumer_refStreamConsumerReferencestreamConsumerRefStreamConsumerReferenceStreamConsumerRefStreamConsumerReferenceStreamConsumerRefStreamConsumerReference#

A reference to this stream consumer.

Methods

addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#

Adds a statement to the IAM resource policy associated with this stream consumer.

If this stream consumer was created in this stack (new StreamConsumer), a resource policy will be automatically created upon the first call to addToResourcePolicy. If the stream is imported (StreamConsumer.from), then this is a no-op.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

fromStreamConsumerArn(scope: Construct, id: string, streamConsumerArn: string): IStreamConsumer@staticmethod def from_stream_consumer_arn(scope: Construct, id: str, stream_consumer_arn: str) -> IStreamConsumerpublic static IStreamConsumer fromStreamConsumerArn(Construct scope, String id, String streamConsumerArn)public static IStreamConsumer FromStreamConsumerArn(Construct scope, string id, string streamConsumerArn)func FromStreamConsumerArn(Scope Construct, Id *string, StreamConsumerArn *string) IStreamConsumerstatic#

Imports an existing Kinesis Stream Consumer by its arn.

3 parameters

Parameters

scopescopescopescopeScope — the Construct scope.
ididididId — the ID of the construct.
streamConsumerArnstream_consumer_arnstreamConsumerArnstreamConsumerArnStreamConsumerArn — the arn of the existing stream consumer.

fromStreamConsumerAttributes(scope: Construct, id: string, attrs: StreamConsumerAttributes): IStreamConsumer

@staticmethod def from_stream_consumer_attributes(scope: Construct, id: str, attrs: StreamConsumerAttributes) -> IStreamConsumer

public static IStreamConsumer fromStreamConsumerAttributes(Construct scope, String id, StreamConsumerAttributes attrs)public static IStreamConsumer FromStreamConsumerAttributes(Construct scope, string id, StreamConsumerAttributes attrs)func FromStreamConsumerAttributes(Scope Construct, Id *string, Attrs StreamConsumerAttributes) IStreamConsumerstatic#

Imports an existing Kinesis Stream Consumer by its attributes.

3 parameters

Parameters

scopescopescopescopeScope — the Construct scope.
ididididId — the ID of the construct.
attrsattrsattrsattrsAttrs — the attributes of the existing stream consumer.

grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#

Grant the indicated permissions on this stream consumer to the given IAM principal (Role/Group/User).

[disable-awslint:no-grants]

grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#

Grant read permissions for this stream consumer and its associated stream to an IAM principal (Role/Group/User).

[disable-awslint:no-grants]

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

Returns true if the construct was created by CDK, and false otherwise.

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

StreamConsumer L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

StreamConsumer L2 construct

Example

Initializer

Construct Props

Properties

Methods