Git Product home page Git Product logo

terraform-aws-cloudtrail's Introduction

Terraform AWS Cloudtrail

Terraform module to provision an AWS CloudTrail with encrypted S3 bucket. This bucket is used to store CloudTrail logs.

Terraform Licence tfsec


We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.

Prerequisites

This module has a few dependencies:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple Example

Here is an example of how you can use this module in your inventory structure:

    module "cloudtrail" {
      source                        = "clouddrove/cloudtrail/aws"
      version                       = "1.3.0"

      name                          = "cloudtrail"
      environment                   = "security"
      label_order                   = ["name", "environment"]
      s3_bucket_name                = "s3-logs"
      enable_logging                = true
      enable_log_file_validation    = true
      include_global_service_events = true
      is_multi_region_trail         = false
      log_retention_days            = 90
    }

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. 1). list(string) [] 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
cloudwatch_log_group_name The name of the CloudWatch Log Group that receives CloudTrail events. string "cloudtrail-events" no
data_resource Specify if you want your event selector to include management events for your trail. bool true no
data_resource_type The resource type in which you want to log data events. You can specify only the following value: AWS::S3::Object AWS::Lambda::Function. string "AWS::S3::Object" no
data_resource_values 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(string) [] no
enable_log_file_validation Specifies whether log file integrity validation is enabled. Creates signed digest for validated contents of logs. bool true no
enable_logging Enable logging for the trail. bool true no
enabled_cloudtrail If true, deploy the resources for the module. bool true no
environment Environment (e.g. prod, dev, staging). string "" no
event_selector Specifies an event selector for enabling data event logging. Fields documented below. Please note the CloudTrail limits when configuring these. bool true no
event_selector_data_resource Specifies logging data events. Fields documented below. bool false no
iam_role_name Name for the CloudTrail IAM role string "cloudtrail-cloudwatch-logs-role" no
include_global_service_events Specifies whether the trail is publishing events from global services such as IAM to the log files. bool true no
include_management_events Specify if you want your event selector to include management events for your trail. bool true no
is_organization_trail The trail is an AWS Organizations trail. bool false no
key_deletion_window_in_days Duration in days after which the key is deleted after destruction of the resource, must be 7-30 days. Default 30 days. string 30 no
kms_key_id Specifies the KMS key ARN to use to encrypt the logs delivered by CloudTrail. string "" no
label_order Label order, e.g. name,application. list(any) [] no
log_retention_days Number of days to keep AWS logs around in specific log group. string 90 no
managedby ManagedBy, eg 'CloudDrove'. string "[email protected]" no
name Name (e.g. app or cluster). string n/a yes
read_write_type Specify if you want your trail to log read-only events, write-only events, or all. By default, the value is All. string "All" no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-cloudtrail" no
s3_bucket_name S3 bucket name for CloudTrail log. string n/a yes
sns_topic_name Specifies the name of the Amazon SNS topic defined for notification of log file delivery. string null no
tags Additional tags (e.g. map(BusinessUnit,XYZ). map(string) {} no

Outputs

Name Description
arn The Amazon Resource Name of the trail.
home_region The region in which the trail was created.
id The name of the trail.
tags A mapping of tags to assign to the resource.

Testing

In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at [email protected].

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.

We are The Cloud Experts!


We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.

terraform-aws-cloudtrail's People

Contributors

anmolnagpal avatar clouddrove-ci avatar dhyanio avatar h1manshu98 avatar harmanjyotkaur avatar himanshu-uniyal avatar nileshgadgi avatar omsharma07 avatar sohanyadav avatar tanveer143s avatar theprashantyadav avatar vaibhav7797 avatar yadavprakash avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

terraform-aws-cloudtrail's Issues

cloudtrail Name is provided

I have set the name in module for the cloudtrail but still getting this error:

Error: Error creating CloudTrail: InvalidTrailNameException: Trail name cannot be blank!

I have tried different versions of module and upgraded my terraform version but no success.

Not using the event_selector variable

When is passed the Event selector variable with a list of maps, the module doesn't even use the values, and the trail is not created for all lambda resources and/or s3 objects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.