Interface Consumer.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Consumer.Builder,Consumer>, SdkBuilder<Consumer.Builder,Consumer>, SdkPojo
Enclosing class:
Consumer
public static interface Consumer.Builder extends SdkPojo, CopyableBuilder<Consumer.Builder,Consumer>

  • Method Details

    • consumerName

      Consumer.Builder consumerName(String consumerName)

      The name of the consumer is something you choose when you register the consumer.

      Parameters:
      consumerName - The name of the consumer is something you choose when you register the consumer.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumerARN

      Consumer.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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumerStatus

      Consumer.Builder consumerStatus(String consumerStatus)

      A consumer can't read data while in the CREATING or DELETING states.

      Parameters:
      consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • consumerStatus

      Consumer.Builder consumerStatus(ConsumerStatus consumerStatus)

      A consumer can't read data while in the CREATING or DELETING states.

      Parameters:
      consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • consumerCreationTimestamp

      Consumer.Builder consumerCreationTimestamp(Instant consumerCreationTimestamp)

      Parameters:
      consumerCreationTimestamp -
      Returns:
      Returns a reference to this object so that method calls can be chained together.