software.amazon.awscdk.services.kinesis

Interface IStream.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IStream, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IStream.Jsii$Proxy

Enclosing interface:

IStream

@Internal
public static interface IStream.Jsii$Default
extends IStream, IResource.Jsii$Default

Internal default implementation for IStream.

Nested Class Summary

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

IStream.Jsii$Default, IStream.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default IKey	getEncryptionKey() (experimental) Optional KMS encryption key associated with this stream.
default ResourceEnvironment	getEnv() (experimental) The environment this resource belongs to.
default ConstructNode	getNode() (experimental) The construct tree node for this construct.
default Stack	getStack() (experimental) The stack in which this resource is defined.
default String	getStreamArn() (experimental) The ARN of the stream.
default String	getStreamName() (experimental) The name of the stream.
default Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the indicated permissions on this stream to the provided IAM principal.
default Grant	grantRead(IGrantable grantee) (experimental) Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).
default Grant	grantReadWrite(IGrantable grantee) (experimental) Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
default 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.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Experimental)
 @NotNull
default ConstructNode getNode()

(experimental) The construct tree node for this construct.

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

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

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getStreamArn

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

(experimental) The ARN of the stream.

Specified by:

getStreamArn in interface IStream

getStreamName

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

(experimental) The name of the stream.

Specified by:

getStreamName in interface IStream

getEncryptionKey

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

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

Specified by:

getEncryptionKey in interface IStream

grant

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

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

Specified by:

grant in interface IStream

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

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

Specified by:

grantRead in interface IStream

Parameters:

grantee - This parameter is required.

grantReadWrite

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

Specified by:

grantWrite in interface IStream

Parameters:

grantee - This parameter is required.