Interface IStreamConsumer

A Kinesis Stream Consumer.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IStreamConsumerRef.StreamConsumerRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.Kinesis

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IStreamConsumer : IResource, IStreamConsumerRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IStreamConsumer Inherits IResource, IStreamConsumerRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

Stream	The stream associated with this consumer.
StreamConsumerArn	The ARN of the stream consumer.
StreamConsumerName	The name of the stream consumer.

Methods

AddToResourcePolicy(PolicyStatement)	Adds a statement to the IAM resource policy associated with this stream consumer.
Grant(IGrantable, params string[])	Grant the indicated permissions on this stream consumer to the provided IAM principal.
GrantRead(IGrantable)	Grant read permissions for this stream consumer and its associated stream to an IAM principal (Role/Group/User).

Properties

Stream

The stream associated with this consumer.

IStream Stream { get; }

Property Value

IStream

Remarks

Attribute: true

StreamConsumerArn

The ARN of the stream consumer.

string StreamConsumerArn { get; }

Property Value

string

Remarks

Attribute: true

StreamConsumerName

The name of the stream consumer.

string StreamConsumerName { get; }

Property Value

string

Remarks

Attribute: true

Methods

AddToResourcePolicy(PolicyStatement)

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

IAddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)

Parameters

statement PolicyStatement

Returns

IAddToResourcePolicyResult

Remarks

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.

Grant(IGrantable, params string[])

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

Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

actions string[]

Returns

Grant

GrantRead(IGrantable)

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

Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant