azavea / terraform-aws-cloudtrail

A Terraform module to create an Amazon Web Services (AWS) CloudTrail Trail.

terraform-aws-cloudtrail

A Terraform module to create an Amazon Web Services (AWS) CloudTrail trail.

Usage

This module creates a trail that logs to an S3 bucket. The module can be configured to log to an existing S3 bucket, or to make a new one for you automatically.

module "cloudtrail" {
  source = "github.com/azavea/terraform-aws-cloudtrail?ref=0.1.0"

  region           = "us-east-1"
  create_s3_bucket = true
  s3_bucket_name   = "mysite-logs"
  s3_key_prefix    = "cloudtrail"

  enable_s3_bucket_expiration  = false
  s3_bucket_days_to_expiration = 90

  enable_s3_bucket_transition        = true
  s3_bucket_days_to_transition       = 90
  s3_bucket_transition_storage_class = "ONEZONE_IA"

  enable_logging             = true
  enable_log_file_validation = false

  include_global_service_events = true
  is_multi_region_trail         = false
  is_organization_trail         = false

  project     = "My Site"
  environment = "Production"
}

Variables

• region - Name of the region where the trail should be created (default: us-east-1)
• create_s3_bucket - Whether or not to create a new S3 bucket. When false, you must provide a valid bucket to s3_bucket_name (default: true)
• s3_bucket_name - Name of the S3 bucket to store logs in (required)
• s3_key_prefix - Specifies the S3 key prefix that precedes the name of the bucket you have designated for log file delivery (Optional)
• enable_s3_bucket_expiration - Specifies whether to enable an expiration policy for the log stora ge bucket (default: false)
• s3_bucket_days_to_expiration - How many days to store logs before they will be deleted. Only applies if enable_s3_bucket_expiration is true (default: 90)
• enable_s3_bucket_transition - Specifies whether to enable a storage class transition for the S3 bucket (default: true)
• s3_bucket_days_to_transition - How many days to store logs before they will be transitioned to a new storage class. Only applies if enable_s3_bucket_transition is true (default: 90)
• s3_bucket_transition_storage_class - Specifies the S3 storage class to which logs will transiti on for archival. Only applies if enable_s3_bucket_transition is true (default: ONEZONE_IA)
• enable_logging - Specifies whether to enable logging for the trail (default: true)
• include_global_service_events - Specifies whether the trail is publishing events from global services such as IAM (default: true)
• is_multi_region_trail - Specifies whether the trail is created in the current region or in all regions (default: false)
• enable_log_file_validation - Specifies whether log file integrity validation is enabled (default: false)
• is_organization_trail - Specifies whether the trail is an AWS Organizations trail, which must be created in the organization master account (default: false)
• project - Project name, used for tagging and naming the trail (default: Unknown)
• environment - Name of the environment this trail is targeting (default: Unkown)

Outputs

• id - The name of the trail.
• home_region - The region in which the trail was created.
• arn - The Amazon Resource Name of the trail.
• bucket_id - The name of the log bucket, if one was created -- otherwise, an empty string.
• bucket_arn - The Amazon Resource Name of the log bucket, if one was created -- otherwise, an empty string.