Skip to content

Latest commit

 

History

History
294 lines (181 loc) · 15.2 KB

README.md

File metadata and controls

294 lines (181 loc) · 15.2 KB
Raw

README Header

Cloud Posse

terraform-aws-cloudwatch-flow-logs Build Status Latest Release Slack Community

Terraform module for enabling flow logs for vpc and subnets.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

Terraform Open Source Modules

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

module "flow_logs" {
  source    = "git::https://github.com/cloudposse/terraform-aws-cloudwatch-flow-logs.git?ref=master"
  vpc_id    = var.vpc_id
  namespace = var.namespace
  stage     = var.stage
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. policy or role) list <list> no
delimiter Delimiter to be used between name, namespace, stage, etc. string - no
enabled Set to false to prevent the module from creating anything string true no
encryption_type GUID for the customer-managed KMS key to use for encryption. The only acceptable values are NONE or KMS string NONE no
eni_ids IDs of ENIs list <list> no
filter_pattern Valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events string [version, account, eni, source, destination, srcport, destport, protocol, packets, bytes, windowstart, windowend, action, flowlogstatus] no
kms_key_id ID of KMS key string `` no
name Name (e.g. bastion or db) string `` no
namespace Namespace (e.g. cp or cloudposse) string - yes
region AWS region string `` no
retention_in_days Number of days you want to retain log events in the log group string 30 no
retention_period Length of time data records are accessible after they are added to the stream string 48 no
shard_count Number of shards that the stream will use string 1 no
shard_level_metrics List of shard-level CloudWatch metrics which can be enabled for the stream string <list> no
stage Stage (e.g. prod, dev, staging) string - yes
subnet_ids IDs of subnets list <list> no
tags Additional tags (e.g. map(BusinessUnit,XYZ) map <map> no
traffic_type Type of traffic to capture. Valid values: ACCEPT,REJECT, ALL string ALL no
vpc_id ID of VPC string - yes

Outputs

Name Description
eni_flow_ids Flow Log IDs of ENIs
kinesis_arn ARN of Stream
kinesis_id Stream ID
kinesis_name Stream name
kinesis_shard_count Count of Shards for Stream
log_group_arn ARN of the log group
subnet_flow_ids Flow Log IDs of subnets
vpc_flow_id Flow Log IDs of VPCs

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

README Commercial Support

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

E-Mail

  • Questions. We'll use a Shared Slack channel between your team and ours.
  • Troubleshooting. We'll help you triage why things aren't working.
  • Code Reviews. We'll review your Pull Requests and provide constructive feedback.
  • Bug Fixes. We'll rapidly work to fix any bugs in our projects.
  • Build New Terraform Modules. We'll develop original modules to provision infrastructure.
  • Cloud Architecture. We'll assist with your cloud strategy and design.
  • Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Newsletter

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

Copyright © 2017-2018 Cloud Posse, LLC

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

Cloud Posse

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Vladimir
Vladimir

README Footer Beacon