Skip to main content
Sponsor @cloudposse

Module: code-deploy

Terraform module to provision AWS Code Deploy app and group.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "example" {
  source = "cloudposse/code-deploy/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
}

Examples​

Here is an example of using this module:

Variables​

Required Variables​

Optional Variables​

alarm_configuration optional

Configuration of deployment to stop when a CloudWatch alarm detects that a metric has fallen below or exceeded a defined threshold.
alarms:
A list of alarms configured for the deployment group.
ignore_poll_alarm_failure:
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from CloudWatch.



Type:

object({
alarms                    = list(string)
ignore_poll_alarm_failure = bool
})

Default value: null

auto_rollback_configuration_events (string) optional

The event type or types that trigger a rollback. Supported types are DEPLOYMENT_FAILURE and DEPLOYMENT_STOP_ON_ALARM.


Default value: "DEPLOYMENT_FAILURE"

autoscaling_groups (list(string)) optional

A list of Autoscaling Groups associated with the deployment group.


Default value: [ ]

blue_green_deployment_config (any) optional

Configuration block of the blue/green deployment options for a deployment group,
see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codedeploy_deployment_group#blue_green_deployment_config



Default value: null

compute_platform (string) optional

The compute platform can either be ECS, Lambda, or Server


Default value: "ECS"

create_default_service_role (bool) optional

Whether to create default IAM role ARN that allows deployments.


Default value: true

create_default_sns_topic (bool) optional

Whether to create default SNS topic through which notifications are sent.


Default value: true

deployment_style optional

Configuration of the type of deployment, either in-place or blue/green,
you want to run and whether to route deployment traffic behind a load balancer.


deployment_option:
Indicates whether to route deployment traffic behind a load balancer.
Possible values: WITH_TRAFFIC_CONTROL, WITHOUT_TRAFFIC_CONTROL.
deployment_type:
Indicates whether to run an in-place deployment or a blue/green deployment.
Possible values: IN_PLACE, BLUE_GREEN.



Type:

object({
deployment_option = string
deployment_type   = string
})

Default value: null

ec2_tag_filter optional

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
Cannot be used in the same call as ec2TagSet.



Type:

set(object({
key   = string
type  = string
value = string
}))

Default value: [ ]

ec2_tag_set optional

A list of sets of tag filters. If multiple tag groups are specified,
any instance that matches to at least one tag filter of every tag group is selected.


key:
The key of the tag filter.
type:
The type of the tag filter, either KEY_ONLY, VALUE_ONLY, or KEY_AND_VALUE.
value:
The value of the tag filter.



Type:

set(object(
{
  ec2_tag_filter = set(object(
    {
      key   = string
      type  = string
      value = string
    }
  ))
}
))

Default value: [ ]

ecs_service optional

Configuration block(s) of the ECS services for a deployment group.


cluster_name:
The name of the ECS cluster.
service_name:
The name of the ECS service.



Type:

list(object({
cluster_name = string
service_name = string
}))

Default value: null

load_balancer_info (map(any)) optional

Single configuration block of the load balancer to use in a blue/green deployment,
see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codedeploy_deployment_group#load_balancer_info



Default value: null

minimum_healthy_hosts optional

type:
The type can either be FLEET_PERCENT or HOST_COUNT.
value:
The value when the type is FLEET_PERCENT represents the minimum number of healthy instances
as a percentage of the total number of instances in the deployment.
When the type is HOST_COUNT, the value represents the minimum number of healthy instances as an absolute value.



Type:

object({
type  = string
value = number
})

Default value: null

service_role_arn (string) optional

The service IAM role ARN that allows deployments.


Default value: null

sns_topic_arn (string) optional

The ARN of the SNS topic through which notifications are sent.


Default value: null

traffic_routing_config optional

type:
Type of traffic routing config. One of TimeBasedCanary, TimeBasedLinear, AllAtOnce.
interval:
The number of minutes between the first and second traffic shifts of a deployment.
percentage:
The percentage of traffic to shift in the first increment of a deployment.



Type:

object({
type       = string
interval   = number
percentage = number
})

Default value: null

trigger_events (list(string)) optional

The event type or types for which notifications are triggered.
Some values that are supported:
DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop,
DeploymentRollback, InstanceStart, InstanceSuccess, InstanceFailure.
See the CodeDeploy documentation for all possible values.
http://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-sns-event-notifications-create-trigger.html



Default value:

[
  "DeploymentFailure"
]

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.


Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.


Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.


Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.


Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.


Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.


Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.


Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.


Required: No

Default value:

[
  "default"
]
name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

deployment_config_id

The deployment config ID.

deployment_config_name

The deployment group's config name.

group_id

The application group ID.

id

The application ID.

name

The application's name.

Dependencies​

Requirements​

  • terraform, version: >= 1.0
  • aws, version: >= 2.0
  • local, version: >= 1.2

Providers​

  • aws, version: >= 2.0

Modules​

NameVersionSourceDescription
sns_topic0.21.0cloudposse/sns-topic/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: