Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding documentation for optional kinesis stream name #1037

Merged
merged 3 commits into from
Oct 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions docs/source/clusters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -461,15 +461,16 @@ Configuration Options
The ``kinesis`` module expects a single key (``streams``) whose value is a dictionary with the
following options:

======================= ============ ===============
**Key** **Default** **Description**
----------------------- ------------ ---------------
``create_user`` ``false`` Create an IAM user authorized to ``PutRecords`` on the stream
``retention`` --- Length of time (hours) data records remain in the stream
``shard_level_metrics`` ``[]`` Enable these `enhanced shard-level metrics <https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-shard>`_
``shards`` --- Number of shards (determines stream data capacity)
``trusted_accounts`` ``[]`` Authorize these account IDs to assume an IAM role which can write to the stream
======================= ============ ===============
======================= ================================== ===============
**Key** **Default** **Description**
----------------------- ---------------------------------- ---------------
``create_user`` ``false`` Create an IAM user authorized to ``PutRecords`` on the stream
``retention`` --- Length of time (hours) data records remain in the stream
``shard_level_metrics`` ``[]`` Enable these `enhanced shard-level metrics <https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html#kinesis-metrics-shard>`_
``shards`` --- Number of shards (determines stream data capacity)
``trusted_accounts`` ``[]`` Authorize these account IDs to assume an IAM role which can write to the stream
``stream_name`` ``<prefix>_<cluster>_streamalert`` [optional] Custom name for the stream that will be created
======================= ================================== ===============

Scaling
~~~~~~~
Expand Down Expand Up @@ -588,16 +589,16 @@ for StreamAlert consumption.
Configuration Options
~~~~~~~~~~~~~~~~~~~~~

===================== ========================================== ===============
**Key** **Default** **Description**
--------------------- ------------------------------------------ ---------------
``cross_account_ids`` ``[]`` Authorize flow log delivery from these accounts
``enabled`` --- Toggle flow log creation
``enis`` ``[]`` Add flow logs for these ENIs
``log_group_name`` ``"PREFIX_CLUSTER_streamalert_flow_logs"`` Flow logs are directed to this log group
``subnets`` ``[]`` Add flow logs for these VPC subnet IDs
``vpcs`` ``[]`` Add flow logs for these VPC IDs
===================== ========================================== ===============
===================== ============================================ ===============
**Key** **Default** **Description**
--------------------- -------------------------------------------- ---------------
``cross_account_ids`` ``[]`` Authorize flow log delivery from these accounts
``enabled`` --- Toggle flow log creation
``enis`` ``[]`` Add flow logs for these ENIs
``log_group_name`` ``<prefix>_<cluster>_streamalert_flow_logs`` Flow logs are directed to this log group
``subnets`` ``[]`` Add flow logs for these VPC subnet IDs
``vpcs`` ``[]`` Add flow logs for these VPC IDs
===================== ============================================ ===============


.. _s3_events:
Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/tf_kinesis_streams/iam.tf
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ resource "aws_iam_user" "streamalert" {
resource "aws_iam_group" "streamalert" {
count = "${var.create_user ? 1 : 0}"
name = "${var.prefix}_${var.cluster}_streamalert_users"
path = "/"
path = "/streamalert/"
}

// IAM Group Membership: Assign streamalert user to group
Expand Down