terraform-aws-cloudtrail

Terraform module to provision an AWS CloudTrail.

The module accepts an encrypted S3 bucket with versioning to store CloudTrail logs.

The bucket could be from the same AWS account or from a different account.

This is useful if an organization uses a number of separate AWS accounts to isolate the Audit environment from other environments (production, staging, development).

In this case, you create CloudTrail in the production environment (production AWS account), while the S3 bucket to store the CloudTrail logs is created in the Audit AWS account, restricting access to the logs only to the users/groups from the Audit account.

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

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

Usage

module "cloudtrail" {
  source                        = "git::https://github.com/cloudposse/terraform-aws-cloudtrail.git?ref=master"
  namespace                     = "cp"
  stage                         = "dev"
  name                          = "cluster"
  enable_log_file_validation    = "true"
  include_global_service_events = "true"
  is_multi_region_trail         = "false"
  enable_logging                = "true"
  s3_bucket_name                = "my-cloudtrail-logs-bucket"
}

NOTE: To create an S3 bucket for CloudTrail logs, use terraform-aws-cloudtrail-s3-bucket module. It creates an S3 bucket and an IAM policy to allow CloudTrail logs.

module "cloudtrail" {
  source                        = "git::https://github.com/cloudposse/terraform-aws-cloudtrail.git?ref=master"
  namespace                     = "cp"
  stage                         = "dev"
  name                          = "cluster"
  enable_log_file_validation    = "true"
  include_global_service_events = "true"
  is_multi_region_trail         = "false"
  enable_logging                = "true"
  s3_bucket_name                = "${module.cloudtrail_s3_bucket.bucket_id}"
}

module "cloudtrail_s3_bucket" {
  source    = "git::https://github.com/cloudposse/terraform-aws-cloudtrail-s3-bucket.git?ref=master"
  namespace = "cp"
  stage     = "dev"
  name      = "cluster"
  region    = "us-east-1"
}

For a complete example, see examples/complete.

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. `logs`)	list	`<list>`	no
cloud_watch_logs_group_arn	Specifies a log group name using an Amazon Resource Name (ARN), that represents the log group to which CloudTrail logs will be delivered	string	``	no
cloud_watch_logs_role_arn	Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group	string	``	no
delimiter	Delimiter to be used between `namespace`, `stage`, `name` and `attributes`	string	`-`	no
enable_log_file_validation	Specifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logs	string	`true`	no
enable_logging	Enable logging for the trail	string	`true`	no
event_selector	Specifies an event selector for enabling data event logging, It needs to be a list of map values. See: https://www.terraform.io/docs/providers/aws/r/cloudtrail.html for details on this map variable	list	`<list>`	no
include_global_service_events	Specifies whether the trail is publishing events from global services such as IAM to the log files	string	`false`	no
is_multi_region_trail	Specifies whether the trail is created in the current region or in all regions	string	`false`	no
is_organization_trail	The trail is an AWS Organizations trail	string	`"false"`	no
kms_key_id	Specifies the KMS key ARN to use to encrypt the logs delivered by CloudTrail	string	``	no
name	Name (e.g. `app` or `cluster`)	string	-	yes
namespace	Namespace (e.g. `cp` or `cloudposse`)	string	-	yes
s3_bucket_name	S3 bucket name for CloudTrail logs	string	-	yes
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	-	yes
tags	Additional tags (e.g. map('BusinessUnit`,`XYZ`)	map	`<map>`	no

Outputs

Name	Description
cloudtrail_arn	The Amazon Resource Name of the trail
cloudtrail_home_region	The region in which the trail was created
cloudtrail_id	The name of the trail

Related Projects

Check out these related projects.

terraform-aws-cloudtrail-cloudwatch-alarms - Terraform module for creating alarms for tracking important changes and occurances from cloudtrail.
terraform-aws-cloudtrail-s3-bucket - S3 bucket with built in IAM policy to allow CloudTrail logs
terraform-aws-s3-log-storage - This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail

Help

Got a question?

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

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.

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.

Community Forum

Get access to our Open Source Community Forum on Slack. It's FREE to join 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 sweet infrastructure.

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.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
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

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 at [email protected]

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

We offer paid support on all of our projects.

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

Contributors

Andriy Knysh	Sergey Vasilyev	Valeriy	Jamie Nelson

sagansystems / terraform-aws-cloudtrail Goto Github PK