StreamConsumer class

Provides a resource to manage a Kinesis Stream Consumer.

> Note: You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.

For more details, see the Amazon Kinesis Stream Consumer Documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.kinesis.Stream("example", {
    name: "example-stream",
    shardCount: 1,
});
const exampleStreamConsumer = new aws.kinesis.StreamConsumer("example", {
    name: "example-consumer",
    streamArn: example.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.kinesis.Stream("example",
    name="example-stream",
    shard_count=1)
example_stream_consumer = aws.kinesis.StreamConsumer("example",
    name="example-consumer",
    stream_arn=example.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Kinesis.Stream("example", new()
    {
        Name = "example-stream",
        ShardCount = 1,
    });

    var exampleStreamConsumer = new Aws.Kinesis.StreamConsumer("example", new()
    {
        Name = "example-consumer",
        StreamArn = example.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/kinesis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := kinesis.NewStream(ctx, "example", &kinesis.StreamArgs{
			Name:       pulumi.String("example-stream"),
			ShardCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = kinesis.NewStreamConsumer(ctx, "example", &kinesis.StreamConsumerArgs{
			Name:      pulumi.String("example-consumer"),
			StreamArn: example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_kinesis_stream" "example" {
  name        = "example-stream"
  shard_count = 1
}
resource "aws_kinesis_streamconsumer" "example" {
  name       = "example-consumer"
  stream_arn = aws_kinesis_stream.example.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.Stream;
import com.pulumi.aws.kinesis.StreamArgs;
import com.pulumi.aws.kinesis.StreamConsumer;
import com.pulumi.aws.kinesis.StreamConsumerArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Stream("example", StreamArgs.builder()
            .name("example-stream")
            .shardCount(1)
            .build());

        var exampleStreamConsumer = new StreamConsumer("exampleStreamConsumer", StreamConsumerArgs.builder()
            .name("example-consumer")
            .streamArn(example.arn())
            .build());

    }
}
resources:
  example:
    type: aws:kinesis:Stream
    properties:
      name: example-stream
      shardCount: 1
  exampleStreamConsumer:
    type: aws:kinesis:StreamConsumer
    name: example
    properties:
      name: example-consumer
      streamArn: ${example.arn}

Import

Identity Schema

Required

  • arn (String) ARN of the stream consumer.

Using pulumi import, import Kinesis Stream Consumers using arn. For example:

$ pulumi import aws:kinesis/streamConsumer:StreamConsumer example arn:aws:kinesis:us-west-2:123456789012:stream/example/consumer/example:1616044553

Constructors

StreamConsumer(String name, {StreamConsumerArgs? args, CustomResourceOptions? options})
Creates a new StreamConsumer. name The Pulumi resource name. args Arguments used to configure this StreamConsumer. The set of arguments for StreamConsumer. options Resource options controlling this resource's behavior.
StreamConsumer.reference(String urn)
Creates a typed reference to an existing StreamConsumer resource.

Properties

arn ↔ Output<String>
ARN of the stream consumer.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationTimestamp ↔ Output<String>
Approximate timestamp in RFC3339 format of when the stream consumer was created.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the stream consumer.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
streamArn ↔ Output<String>
ARN of the data stream the consumer is registered with.
latefinal
tags ↔ Output<Map<String, String>?>
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {StreamConsumerState? state, CustomResourceOptions? options}) → StreamConsumer
Gets an existing StreamConsumer resource's state with the given name and id.