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, IResource, IResource.Jsii$Default, IStreamConsumer, 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
Internal default implementation for IStreamConsumer.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      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(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • 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

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • 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.