1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. kinesis
  5. StreamConsumer

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

aws-native.kinesis.StreamConsumer

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

    Resource Type definition for AWS::Kinesis::StreamConsumer

    Create StreamConsumer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StreamConsumer(name: string, args: StreamConsumerArgs, opts?: CustomResourceOptions);
    @overload
    def StreamConsumer(resource_name: str,
                       args: StreamConsumerArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def StreamConsumer(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       stream_arn: Optional[str] = None,
                       consumer_name: Optional[str] = None,
                       tags: Optional[Sequence[_root_inputs.CreateOnlyTagArgs]] = None)
    func NewStreamConsumer(ctx *Context, name string, args StreamConsumerArgs, opts ...ResourceOption) (*StreamConsumer, error)
    public StreamConsumer(string name, StreamConsumerArgs args, CustomResourceOptions? opts = null)
    public StreamConsumer(String name, StreamConsumerArgs args)
    public StreamConsumer(String name, StreamConsumerArgs args, CustomResourceOptions options)
    
    type: aws-native:kinesis:StreamConsumer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args StreamConsumerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StreamConsumerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StreamConsumerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamConsumerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamConsumerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    StreamConsumer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The StreamConsumer resource accepts the following input properties:

    StreamArn string
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    ConsumerName string
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    Tags List<Pulumi.AwsNative.Inputs.CreateOnlyTag>
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
    StreamArn string
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    ConsumerName string
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    Tags CreateOnlyTagArgs
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
    streamArn String
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    consumerName String
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    tags List<CreateOnlyTag>
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
    streamArn string
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    consumerName string
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    tags CreateOnlyTag[]
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
    stream_arn str
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    consumer_name str
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    tags Sequence[CreateOnlyTagArgs]
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
    streamArn String
    The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
    consumerName String
    The name of the Kinesis Stream Consumer. For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
    tags List<Property Map>
    An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StreamConsumer resource produces the following output properties:

    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    CreateOnlyTag, CreateOnlyTagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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