We recommend new projects start with resources from the AWS provider.
aws-native.kinesis.StreamConsumer
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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:
- Stream
Arn string - The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
- Consumer
Name 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.
- List<Pulumi.
Aws Native. Inputs. Create Only Tag> - An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
- Stream
Arn string - The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
- Consumer
Name 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.
- Create
Only Tag Args - An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
- stream
Arn String - The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
- consumer
Name 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.
- List<Create
Only Tag> - An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
- stream
Arn string - The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
- consumer
Name 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.
- Create
Only Tag[] - 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.
- Sequence[Create
Only Tag Args] - An arbitrary set of tags (key–value pairs) to associate with the Kinesis consumer.
- stream
Arn String - The Amazon resource name (ARN) of the Kinesis data stream that you want to register the consumer with.
- consumer
Name 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.
- 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:
- Consumer
Arn 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
Creation stringTimestamp - Timestamp when the consumer was created.
- Consumer
Status 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 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
Creation stringTimestamp - Timestamp when the consumer was created.
- Consumer
Status 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 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
Creation StringTimestamp - Timestamp when the consumer was created.
- consumer
Status 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 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
Creation stringTimestamp - Timestamp when the consumer was created.
- consumer
Status 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_ strtimestamp - 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.
- consumer
Arn 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
Creation StringTimestamp - Timestamp when the consumer was created.
- consumer
Status 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.