software.amazon.awscdk.services.kinesis

Interface IStream

All Superinterfaces:

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

All Known Subinterfaces:

IStream.Jsii$Default

All Known Implementing Classes:

IStream.Jsii$Proxy, Stream

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:02.414Z")
 @Stability(value=Experimental)
public interface IStream
extends software.amazon.jsii.JsiiSerializable, IResource

(experimental) A Kinesis Stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStream.Jsii$Default Internal default implementation for IStream.
static class	IStream.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
default 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 provided IAM principal.
Grant	grantRead(IGrantable grantee) (experimental) Grant read 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 write permissions for this stream and its contents to an IAM principal (Role/Group/User).

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

Method Detail

getStreamArn

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

(experimental) The ARN of the stream.

getStreamName

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

(experimental) The name of the stream.

getEncryptionKey

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

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

grant

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

(experimental) Grant the indicated permissions on this stream to the provided IAM principal.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=Experimental)
 @NotNull
Grant grantRead(@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.

Parameters:

grantee - This parameter is required.

grantReadWrite

@Stability(value=Experimental)
 @NotNull
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.

Parameters:

grantee - This parameter is required.

grantWrite

@Stability(value=Experimental)
 @NotNull
Grant grantWrite(@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 encrypt the contents of the stream will also be granted.

Parameters:

grantee - This parameter is required.