StreamConsumer

class StreamConsumer : KotlinCustomResource

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/v6/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
})
}
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.List;
import java.util.ArrayList;
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

Using pulumi import, import Kinesis Stream Consumers using the Amazon Resource Name (ARN). For example:

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

Properties

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name (ARN) of the stream consumer.

Link copied to clipboard

Approximate timestamp in RFC3339 format of when the stream consumer was created.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Name of the stream consumer.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val streamArn: Output<String>

Amazon Resource Name (ARN) of the data stream the consumer is registered with.

Link copied to clipboard
val urn: Output<String>