software.amazon.awscdk.services.kinesis

Class Stream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.kinesis.Stream

All Implemented Interfaces:

IDependable, IResource, IStream, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:02.414Z")
 @Stability(value=Experimental)
public class Stream
extends Resource
implements IStream

(experimental) A Kinesis stream.

Can be encrypted with a KMS key.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Stream.Builder (experimental) A fluent builder for Stream.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesis.IStream

IStream.Jsii$Default, IStream.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Stream(software.constructs.Construct scope, String id)
	Stream(software.constructs.Construct scope, String id, StreamProps props)
protected	Stream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Stream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IStream	fromStreamArn(software.constructs.Construct scope, String id, String streamArn) (experimental) Import an existing Kinesis Stream provided an ARN.
static IStream	fromStreamAttributes(software.constructs.Construct scope, String id, StreamAttributes attrs) (experimental) Creates a Stream construct that represents an external stream.
IKey	getEncryptionKey() (experimental) Optional KMS encryption key associated with this stream.
String	getStreamArn() (experimental) The ARN of the stream.
String	getStreamName() (experimental) The name of the stream.
Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the indicated permissions on this stream to the given IAM principal (Role/Group/User).
Grant	grantRead(IGrantable grantee) (experimental) Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).
Grant	grantReadWrite(IGrantable grantee) (experimental) Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
Grant	grantWrite(IGrantable grantee) (experimental) Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Stream

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

Stream

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

Stream

@Stability(value=Experimental)
public Stream(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             StreamProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Stream

@Stability(value=Experimental)
public Stream(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromStreamArn

@Stability(value=Experimental)
 @NotNull
public static IStream fromStreamArn(@NotNull
                                                                             software.constructs.Construct scope,
                                                                             @NotNull
                                                                             String id,
                                                                             @NotNull
                                                                             String streamArn)

(experimental) Import an existing Kinesis Stream provided an ARN.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

streamArn - Stream ARN (i.e. arn:aws:kinesis:::stream/Foo). This parameter is required.

fromStreamAttributes

@Stability(value=Experimental)
 @NotNull
public static IStream fromStreamAttributes(@NotNull
                                                                                    software.constructs.Construct scope,
                                                                                    @NotNull
                                                                                    String id,
                                                                                    @NotNull
                                                                                    StreamAttributes attrs)

(experimental) Creates a Stream construct that represents an external stream.

Parameters:

scope - The parent creating construct (usually `this`). This parameter is required.

id - The construct's name. This parameter is required.

attrs - Stream import properties. This parameter is required.

grant

@Stability(value=Experimental)
 @NotNull
public Grant grant(@NotNull
                                                            IGrantable grantee,
                                                            @NotNull
                                                            String... actions)

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

Specified by:

grant in interface IStream

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=Experimental)
 @NotNull
public Grant grantRead(@NotNull
                                                                IGrantable grantee)

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

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

Specified by:

grantRead in interface IStream

Parameters:

grantee - This parameter is required.

grantReadWrite

@Stability(value=Experimental)
 @NotNull
public Grant grantReadWrite(@NotNull
                                                                     IGrantable grantee)

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

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

Specified by:

grantReadWrite in interface IStream

Parameters:

grantee - This parameter is required.

grantWrite

@Stability(value=Experimental)
 @NotNull
public Grant grantWrite(@NotNull
                                                                 IGrantable grantee)

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

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

Specified by:

grantWrite in interface IStream

Parameters:

grantee - This parameter is required.

getStreamArn

@Stability(value=Experimental)
 @NotNull
public String getStreamArn()

(experimental) The ARN of the stream.

Specified by:

getStreamArn in interface IStream

getStreamName

@Stability(value=Experimental)
 @NotNull
public String getStreamName()

(experimental) The name of the stream.

Specified by:

getStreamName in interface IStream

getEncryptionKey

@Stability(value=Experimental)
 @Nullable
public IKey getEncryptionKey()

(experimental) Optional KMS encryption key associated with this stream.

Specified by:

getEncryptionKey in interface IStream