public static interface ConsumerDescription.Builder extends SdkPojo, CopyableBuilder<ConsumerDescription.Builder,ConsumerDescription>
Modifier and Type | Method and Description |
---|---|
ConsumerDescription.Builder |
consumerARN(String consumerARN)
When you register a consumer, Kinesis Data Streams generates an ARN for it.
|
ConsumerDescription.Builder |
consumerCreationTimestamp(Instant consumerCreationTimestamp)
|
ConsumerDescription.Builder |
consumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
|
ConsumerDescription.Builder |
consumerStatus(ConsumerStatus consumerStatus)
A consumer can't read data while in the
CREATING or DELETING states. |
ConsumerDescription.Builder |
consumerStatus(String consumerStatus)
A consumer can't read data while in the
CREATING or DELETING states. |
ConsumerDescription.Builder |
streamARN(String streamARN)
The ARN of the stream with which you registered the consumer.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
ConsumerDescription.Builder consumerName(String consumerName)
The name of the consumer is something you choose when you register the consumer.
consumerName
- The name of the consumer is something you choose when you register the consumer.ConsumerDescription.Builder consumerARN(String consumerARN)
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
consumerARN
- When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be
able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
ConsumerDescription.Builder consumerStatus(String consumerStatus)
A consumer can't read data while in the CREATING
or DELETING
states.
consumerStatus
- A consumer can't read data while in the CREATING
or DELETING
states.ConsumerStatus
,
ConsumerStatus
ConsumerDescription.Builder consumerStatus(ConsumerStatus consumerStatus)
A consumer can't read data while in the CREATING
or DELETING
states.
consumerStatus
- A consumer can't read data while in the CREATING
or DELETING
states.ConsumerStatus
,
ConsumerStatus
ConsumerDescription.Builder consumerCreationTimestamp(Instant consumerCreationTimestamp)
consumerCreationTimestamp
- ConsumerDescription.Builder streamARN(String streamARN)
The ARN of the stream with which you registered the consumer.
streamARN
- The ARN of the stream with which you registered the consumer.Copyright © 2021. All rights reserved.