Package software.amazon.awscdk.services.kinesis

Interface IStreamConsumer.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IResource, IResource.Jsii$Default, IStreamConsumer, IStreamConsumerRef, IStreamConsumerRef.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IStreamConsumer.Jsii$Proxy
Enclosing interface:
IStreamConsumer
@Internal public static interface IStreamConsumer.Jsii$Default extends IStreamConsumer, IResource.Jsii$Default, IStreamConsumerRef.Jsii$Default
Internal default implementation for IStreamConsumer.

  • Method Details

    • getStream

      @Stability(Stable) @NotNull default IStream getStream()
      The stream associated with this consumer.
      Specified by:
      getStream in interface IStreamConsumer

    • getStreamConsumerArn

      @Stability(Stable) @NotNull default String getStreamConsumerArn()
      The ARN of the stream consumer.
      Specified by:
      getStreamConsumerArn in interface IStreamConsumer

    • getStreamConsumerName

      @Stability(Stable) @NotNull default String getStreamConsumerName()
      The name of the stream consumer.
      Specified by:
      getStreamConsumerName in interface IStreamConsumer

    • addToResourcePolicy

      @Stability(Stable) @NotNull default AddToResourcePolicyResult addToResourcePolicy(@NotNull PolicyStatement statement)
      Adds a statement to the IAM resource policy associated with this stream consumer.

      If this stream consumer was created in this stack (new StreamConsumer), a resource policy will be automatically created upon the first call to addToResourcePolicy. If the stream consumer is imported (StreamConsumer.from), then this is a no-op.

      Specified by:
      addToResourcePolicy in interface IStreamConsumer
      Parameters:
      statement - This parameter is required.

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the indicated permissions on this stream consumer to the provided IAM principal.

      Specified by:
      grant in interface IStreamConsumer
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull default Grant grantRead(@NotNull IGrantable grantee)
      Grant read permissions for this stream consumer and its associated stream to an IAM principal (Role/Group/User).

      Specified by:
      grantRead in interface IStreamConsumer
      Parameters:
      grantee - This parameter is required.