Package software.amazon.awscdk.services.dynamodb

Interface StreamGrantsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StreamGrantsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:18.536Z")
@Stability(Stable)
public interface StreamGrantsProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for StreamGrants.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.interfaces.dynamodb.*;
 Key key;
 ITableRef tableRef;
 StreamGrantsProps streamGrantsProps = StreamGrantsProps.builder()
         .table(tableRef)
         .tableStreamArn("tableStreamArn")
         // the properties below are optional
         .encryptionKey(key)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StreamGrantsProps.Builder	A builder for StreamGrantsProps
static final class	StreamGrantsProps.Jsii$Proxy	An implementation for StreamGrantsProps

Method Summary

Modifier and Type	Method	Description
static StreamGrantsProps.Builder	builder()
default IKey	getEncryptionKey()	The encryption key of the table.
ITableRef	getTable()	The table this stream is for.
String	getTableStreamArn()	The ARN of the Stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTable

@Stability(Stable)
@NotNull
ITableRef getTable()

The table this stream is for.

getTableStreamArn

@Stability(Stable)
@NotNull
String getTableStreamArn()

The ARN of the Stream.

getEncryptionKey

@Stability(Stable)
@Nullable
default IKey getEncryptionKey()

The encryption key of the table.

Required permissions will be added to the key as well.

Default: - No key

builder

@Stability(Stable)
static StreamGrantsProps.Builder builder()

Returns:

a StreamGrantsProps.Builder of StreamGrantsProps