Class Stream

A Kinesis stream.

Inheritance

System.Object

Construct

Resource

Stream

Implements

IStream

IResource

IConstruct

Constructs.IConstruct

IDependable

Inherited Members

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Kinesis

Assembly: Amazon.CDK.AWS.Kinesis.dll

Syntax (csharp)

public class Stream : Resource, IStream, IResource, IConstruct, IConstruct, IDependable

Syntax (vb)

Public Class Stream
    Inherits Resource
    Implements IStream, IResource, IConstruct, IConstruct, IDependable

Remarks

Can be encrypted with a KMS key.

Synopsis

Constructors

Stream(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Stream(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
Stream(Construct, String, IStreamProps)

Properties

EncryptionKey	Optional KMS encryption key associated with this stream.
StreamArn	The ARN of the stream.
StreamName	The name of the stream.

Methods

FromStreamArn(Construct, String, String)	Import an existing Kinesis Stream provided an ARN.
FromStreamAttributes(Construct, String, IStreamAttributes)	Creates a Stream construct that represents an external stream.
Grant(IGrantable, String[])	Grant the indicated permissions on this stream to the given IAM principal (Role/Group/User).
GrantRead(IGrantable)	Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).
GrantReadWrite(IGrantable)	Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
GrantWrite(IGrantable)	Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).

Constructors

Stream(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Stream(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

Stream(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Stream(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Stream(Construct, String, IStreamProps)

public Stream(Construct scope, string id, IStreamProps props = null)

Parameters

scope Constructs.Construct
id System.String
props IStreamProps

Properties

EncryptionKey

Optional KMS encryption key associated with this stream.

public virtual IKey EncryptionKey { get; }

Property Value

IKey

StreamArn

The ARN of the stream.

public virtual string StreamArn { get; }

Property Value

System.String

StreamName

The name of the stream.

public virtual string StreamName { get; }

Property Value

System.String

Methods

FromStreamArn(Construct, String, String)

Import an existing Kinesis Stream provided an ARN.

public static IStream FromStreamArn(Construct scope, string id, string streamArn)

Parameters

scope Constructs.Construct: The parent creating construct (usually this).
id System.String: The construct's name.
streamArn System.String: Stream ARN (i.e. arn:aws:kinesis:<region>:<account-id>:stream/Foo).

Returns

IStream

FromStreamAttributes(Construct, String, IStreamAttributes)

Creates a Stream construct that represents an external stream.

public static IStream FromStreamAttributes(Construct scope, string id, IStreamAttributes attrs)

Parameters

scope Constructs.Construct: The parent creating construct (usually this).
id System.String: The construct's name.
attrs IStreamAttributes: Stream import properties.

Returns

IStream

Grant(IGrantable, String[])

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

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

Parameters

grantee IGrantable
actions System.String[]

Returns

Grant

GrantRead(IGrantable)

Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).

public virtual Grant GrantRead(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

If an encryption key is used, permission to ues the key to decrypt the contents of the stream will also be granted.

GrantReadWrite(IGrantable)

Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).

public virtual Grant GrantReadWrite(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.

GrantWrite(IGrantable)

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

public virtual Grant GrantWrite(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Remarks

If an encryption key is used, permission to ues the key to decrypt the contents of the stream will also be granted.

Implements

IStream

IResource

IConstruct

Constructs.IConstruct

IDependable