Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. kinesis
  6. getStreamConsumer
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.kinesis.getStreamConsumer

aws logo aws logo
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides details about a Kinesis Stream Consumer.

    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 = aws.kinesis.getStreamConsumer({
    name: "example-consumer",
    streamArn: exampleAwsKinesisStream.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.kinesis.get_stream_consumer(name="example-consumer",
    stream_arn=example_aws_kinesis_stream["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 {
		_, err := kinesis.LookupStreamConsumer(ctx, &kinesis.LookupStreamConsumerArgs{
			Name:      pulumi.StringRef("example-consumer"),
			StreamArn: exampleAwsKinesisStream.Arn,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Kinesis.GetStreamConsumer.Invoke(new()
    {
        Name = "example-consumer",
        StreamArn = exampleAwsKinesisStream.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.KinesisFunctions;
import com.pulumi.aws.kinesis.inputs.GetStreamConsumerArgs;
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) {
        final var example = KinesisFunctions.getStreamConsumer(GetStreamConsumerArgs.builder()
            .name("example-consumer")
            .streamArn(exampleAwsKinesisStream.arn())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:kinesis:getStreamConsumer
      arguments:
        name: example-consumer
        streamArn: ${exampleAwsKinesisStream.arn}

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_kinesis_getstreamconsumer" "example" {
  name       = "example-consumer"
  stream_arn = exampleAwsKinesisStream.arn
}

    Using getStreamConsumer

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStreamConsumer(args: GetStreamConsumerArgs, opts?: InvokeOptions): Promise<GetStreamConsumerResult>
function getStreamConsumerOutput(args: GetStreamConsumerOutputArgs, opts?: InvokeOutputOptions): Output<GetStreamConsumerResult>
    def get_stream_consumer(arn: Optional[str] = None,
                        name: Optional[str] = None,
                        region: Optional[str] = None,
                        stream_arn: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetStreamConsumerResult
def get_stream_consumer_output(arn: pulumi.Input[Optional[str]] = None,
                        name: pulumi.Input[Optional[str]] = None,
                        region: pulumi.Input[Optional[str]] = None,
                        stream_arn: pulumi.Input[Optional[str]] = None,
                        tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetStreamConsumerResult]
    func LookupStreamConsumer(ctx *Context, args *LookupStreamConsumerArgs, opts ...InvokeOption) (*LookupStreamConsumerResult, error)
func LookupStreamConsumerOutput(ctx *Context, args *LookupStreamConsumerOutputArgs, opts ...InvokeOption) LookupStreamConsumerResultOutput

    > Note: This function is named LookupStreamConsumer in the Go SDK.

    public static class GetStreamConsumer 
{
    public static Task<GetStreamConsumerResult> InvokeAsync(GetStreamConsumerArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConsumerResult> Invoke(GetStreamConsumerInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamConsumerResult> Invoke(GetStreamConsumerInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOptions options)
public static Output<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOptions options)
public static Output<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws:kinesis/getStreamConsumer:getStreamConsumer
  arguments:
    # arguments dictionary
    data "aws_kinesis_get_stream_consumer" "name" {
    # arguments
}

    The following arguments are supported:

    StreamArn string
    ARN of the data stream the consumer is registered with.
    Arn string
    ARN of the stream consumer.
    Name string
    Name of the stream consumer.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    StreamArn string
    ARN of the data stream the consumer is registered with.
    Arn string
    ARN of the stream consumer.
    Name string
    Name of the stream consumer.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags assigned to the resource.
    stream_arn string
    ARN of the data stream the consumer is registered with.
    arn string
    ARN of the stream consumer.
    name string
    Name of the stream consumer.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags assigned to the resource.
    streamArn String
    ARN of the data stream the consumer is registered with.
    arn String
    ARN of the stream consumer.
    name String
    Name of the stream consumer.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags assigned to the resource.
    streamArn string
    ARN of the data stream the consumer is registered with.
    arn string
    ARN of the stream consumer.
    name string
    Name of the stream consumer.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    stream_arn str
    ARN of the data stream the consumer is registered with.
    arn str
    ARN of the stream consumer.
    name str
    Name of the stream consumer.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    streamArn String
    ARN of the data stream the consumer is registered with.
    arn String
    ARN of the stream consumer.
    name String
    Name of the stream consumer.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags assigned to the resource.

    getStreamConsumer Result

    The following output properties are available:

    Arn string
    CreationTimestamp string
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Region string
    Status string
    Current status of the stream consumer.
    StreamArn string
    Tags Dictionary<string, string>
    Map of tags assigned to the resource.
    Arn string
    CreationTimestamp string
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Region string
    Status string
    Current status of the stream consumer.
    StreamArn string
    Tags map[string]string
    Map of tags assigned to the resource.
    arn string
    creation_timestamp string
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    region string
    status string
    Current status of the stream consumer.
    stream_arn string
    tags map(string)
    Map of tags assigned to the resource.
    arn String
    creationTimestamp String
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    region String
    status String
    Current status of the stream consumer.
    streamArn String
    tags Map<String,String>
    Map of tags assigned to the resource.
    arn string
    creationTimestamp string
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    region string
    status string
    Current status of the stream consumer.
    streamArn string
    tags {[key: string]: string}
    Map of tags assigned to the resource.
    arn str
    creation_timestamp str
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    region str
    status str
    Current status of the stream consumer.
    stream_arn str
    tags Mapping[str, str]
    Map of tags assigned to the resource.
    arn String
    creationTimestamp String
    Approximate timestamp in RFC3339 format of when the stream consumer was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    region String
    status String
    Current status of the stream consumer.
    streamArn String
    tags Map<String>
    Map of tags assigned to the resource.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.50.0
    published on Thursday, Oct 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial