AWS streams documentation change
Summary
Rewrote documentation to focus on managing enhanced fan-out consumers via AWS CLI/APIs instead of AWS Management Console. Added sections for CLI commands (register/describe/list/deregister consumers) and equivalent APIs. Added new 'Tagging consumers' section explaining metadata tagging for cost tracking and ABAC access control.
Security assessment
The change adds documentation about using tags with ABAC for access control, which is a security feature. However, there is no evidence this addresses an existing security vulnerability - it documents existing security capabilities rather than patching an issue.
Diff
diff --git a/streams/latest/dev/building-enhanced-consumers-console.md b/streams/latest/dev/building-enhanced-consumers-console.md index a6c488d16..90c340942 100644 --- a//streams/latest/dev/building-enhanced-consumers-console.md +++ b//streams/latest/dev/building-enhanced-consumers-console.md @@ -5 +5,3 @@ -# Manage enhanced fan-out consumers with the AWS Management Console +Manage consumers using the AWS CLIManage consumers using the Kinesis Data Streams APIsTagging consumers + +# Manage enhanced fan-out consumers with the AWS CLI or APIs @@ -9 +11,20 @@ Consumers that use _enhanced fan-out_ in Amazon Kinesis Data Streams can receive -You can use the AWS Management Console to see a list of all the consumers that are registered to use enhanced fan-out with a specific stream. For each such consumer, you can see details such as ARN, status, creation date, and monitoring metrics. +You can use AWS CLI or Kinesis Data Streams APIs to register, describe, list, and deregister a consumer that uses enhanced fan-out in Kinesis Data Streams. + +## Manage consumers using the AWS CLI + +You can register, describe, list, and deregister enhanced fan-out consumers using the AWS CLI. For examples, see the following documentation. + +[register-stream-consumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/register-stream-consumer.html) + + +Registers a consumer for a Kinesis data stream. You can apply tags while registering the consumer. + +[describe-stream-consumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-consumer.html) + + +Gets the description of a registered consumer with either consumer ARN or consumer name and stream ARN combination. + +[list-stream-consumers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-stream-consumers.html) + + +Lists the consumers registered to receive data from a stream using enhanced fan-out. @@ -11 +32 @@ You can use the AWS Management Console to see a list of all the consumers that a -###### To view consumers that are registered to use enhanced fan-out, their status, creation date, and metrics on the console +[deregister-stream-consumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/deregister-stream-consumer.html) @@ -13 +33,0 @@ You can use the AWS Management Console to see a list of all the consumers that a - 1. Sign in to the AWS Management Console and open the Kinesis console at [https://console.aws.amazon.com/kinesis](https://console.aws.amazon.com/kinesis). @@ -15 +35 @@ You can use the AWS Management Console to see a list of all the consumers that a - 2. Choose **Data Streams** in the navigation pane. +Deregister a consumer with either consumer ARN or consumer name and stream ARN combination. @@ -17 +37 @@ You can use the AWS Management Console to see a list of all the consumers that a - 3. Choose a Kinesis data stream to view its details. +## Manage consumers using the Kinesis Data Streams APIs @@ -19 +39 @@ You can use the AWS Management Console to see a list of all the consumers that a - 4. On the details page for the stream, choose the **Enhanced fan-out** tab. +You can register, describe, list, and deregister enhanced fan-out consumers using the Kinesis Data Streams APIs. For examples, see the following documentation. @@ -21 +41 @@ You can use the AWS Management Console to see a list of all the consumers that a - 5. Choose a consumer to see its name, status, and date of registration. +[RegisterStreamConsumer](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_RegisterStreamConsumer.html) @@ -23,0 +44 @@ You can use the AWS Management Console to see a list of all the consumers that a +Registers a consumer for a Kinesis data stream with tags. You can apply tags while registering the consumer. @@ -24,0 +46 @@ You can use the AWS Management Console to see a list of all the consumers that a +[DescribeStreamConsumer](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStreamConsumer.html) @@ -26 +47,0 @@ You can use the AWS Management Console to see a list of all the consumers that a -###### To deregister a consumer @@ -28 +49 @@ You can use the AWS Management Console to see a list of all the consumers that a - 1. Open the Kinesis console at [https://console.aws.amazon.com/kinesis](https://console.aws.amazon.com/kinesis). +Gets the description of a registered consumer with either consumer ARN or consumer name and stream ARN combination. @@ -30 +51 @@ You can use the AWS Management Console to see a list of all the consumers that a - 2. Choose **Data Streams** in the navigation pane. +[ListStreamConsumers](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreamConsumers.html) @@ -32 +52,0 @@ You can use the AWS Management Console to see a list of all the consumers that a - 3. Choose a Kinesis data stream to view its details. @@ -34 +54 @@ You can use the AWS Management Console to see a list of all the consumers that a - 4. On the details page for the stream, choose the **Enhanced fan-out** tab. +Lists the consumers registered to receive data from a stream using enhanced fan-out. @@ -36 +56 @@ You can use the AWS Management Console to see a list of all the consumers that a - 5. Select the check box to the left of the name of every consumer that you want to deregister. +[DeregisterStreamConsumer](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_DeregisterStreamConsumer.html) @@ -38 +57,0 @@ You can use the AWS Management Console to see a list of all the consumers that a - 6. Choose **Deregister consumer**. @@ -39,0 +59 @@ You can use the AWS Management Console to see a list of all the consumers that a +Deregister a consumer with either consumer ARN or consumer name and stream ARN combination. @@ -40,0 +61 @@ You can use the AWS Management Console to see a list of all the consumers that a +## Tagging consumers @@ -41,0 +63 @@ You can use the AWS Management Console to see a list of all the consumers that a +You can assign your own metadata to streams and enhanced fan-out consumers you create in Kinesis Data Streams in the form of tags. You can use tags to categorize and track costs of your consumers. You can also control access to consumers using tags with [attribute-based access control (ABAC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_attribute-based-access-control.html). For more information, see [Tag your Amazon Kinesis Data Streams resources](./tagging.html).