Package software.amazon.awscdk.services.dynamodb

Class StreamGrants

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.dynamodb.StreamGrants
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:18.535Z") @Stability(Stable) public class StreamGrants extends software.amazon.jsii.JsiiObject
A set of permissions to grant on a Table Stream.

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;
 StreamGrants streamGrants = StreamGrants.Builder.create()
         .table(tableRef)
         .tableStreamArn("tableStreamArn")
         // the properties below are optional
         .encryptionKey(key)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StreamGrants.Builder
    A fluent builder for StreamGrants.

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    StreamGrants(StreamGrantsProps props)
     
    protected
    StreamGrants(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    StreamGrants(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Grant
    actions(IGrantable grantee, String... actions)
    Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.
    Grant
    list(IGrantable grantee)
    Permits an IAM Principal to list streams attached to current dynamodb table.
    Grant
    read(IGrantable grantee)
    Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • StreamGrants

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

    • StreamGrants

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

    • StreamGrants

      @Stability(Stable) public StreamGrants(@NotNull StreamGrantsProps props)
      Parameters:
      props - This parameter is required.

  • Method Details

    • actions

      @Stability(Stable) @NotNull public Grant actions(@NotNull IGrantable grantee, @NotNull String... actions)
      Adds an IAM policy statement associated with this table's stream to an IAM principal's policy.

      If encryptionKey is present, appropriate grants to the key needs to be added separately using the table.encryptionKey.grant* methods.

      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.
      actions - The set of actions to allow (i.e. "dynamodb:DescribeStream", "dynamodb:GetRecords", ...). This parameter is required.

    • list

      @Stability(Stable) @NotNull public Grant list(@NotNull IGrantable grantee)
      Permits an IAM Principal to list streams attached to current dynamodb table.

      Parameters:
      grantee - The principal (no-op if undefined). This parameter is required.

    • read

      @Stability(Stable) @NotNull public Grant read(@NotNull IGrantable grantee)
      Permits an IAM principal all stream data read operations for this table's stream: DescribeStream, GetRecords, GetShardIterator, ListStreams.

      Appropriate grants will also be added to the customer-managed KMS key if one was configured.

      Parameters:
      grantee - The principal to grant access to. This parameter is required.