Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. kinesis
  5. getStreamConsumer

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.31.0 published on Wednesday, Jul 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.kinesis.getStreamConsumer

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.31.0 published on Wednesday, Jul 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Kinesis::StreamConsumer

    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?: InvokeOptions): Output<GetStreamConsumerResult>
    def get_stream_consumer(consumer_arn: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetStreamConsumerResult
def get_stream_consumer_output(consumer_arn: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = 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 CompletableFuture<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOptions options)
public static Output<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:kinesis:getStreamConsumer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConsumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    ConsumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerArn String
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumer_arn str
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerArn String
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

    getStreamConsumer Result

    The following output properties are available:

    ConsumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    ConsumerCreationTimestamp string
    Timestamp when the consumer was created.
    ConsumerStatus string
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE
    ConsumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    ConsumerCreationTimestamp string
    Timestamp when the consumer was created.
    ConsumerStatus string
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE
    consumerArn String
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerCreationTimestamp String
    Timestamp when the consumer was created.
    consumerStatus String
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE
    consumerArn string
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerCreationTimestamp string
    Timestamp when the consumer was created.
    consumerStatus string
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE
    consumer_arn str
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumer_creation_timestamp str
    Timestamp when the consumer was created.
    consumer_status str
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE
    consumerArn String
    The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
    consumerCreationTimestamp String
    Timestamp when the consumer was created.
    consumerStatus String
    A consumer can't read data while in the CREATING or DELETING states. Valid Values: CREATING | DELETING | ACTIVE

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.31.0 published on Wednesday, Jul 16, 2025 by Pulumi
    pulumi/pulumi-aws-native