IStreamConsumer

class aws_cdk.aws_kinesis.IStreamConsumer(*args, **kwargs)

Bases: IResource, Protocol

A Kinesis Stream Consumer.

Methods

add_to_resource_policy(statement)

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 consumer is imported (StreamConsumer.from), then this is a no-op.

Parameters:

statement (PolicyStatement)

Return type:

AddToResourcePolicyResult

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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).

Parameters:

policy (RemovalPolicy)

Return type:

None

grant(grantee, *actions)

Grant the indicated permissions on this stream consumer to the provided IAM principal.

Parameters:
Return type:

Grant

grant_read(grantee)

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

Parameters:

grantee (IGrantable)

Return type:

Grant

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

The tree node.

stack

The stack in which this resource is defined.

stream

The stream associated with this consumer.

Attribute:

true

stream_consumer_arn

The ARN of the stream consumer.

Attribute:

true

stream_consumer_name

The name of the stream consumer.

Attribute:

true