deployment_groups

Creates, updates, deletes, gets or lists a deployment_groups resource.

Overview

Name	deployment_groups
Type	Resource
Id	aws.codedeploy.deployment_groups

Fields

The following fields are returned by SELECT queries:

batch_get_deployment_groups

Name	Datatype	Description
deployment_groups_info	array	Information about the deployment groups.
error_message	string	Information about errors that might have occurred during the API call.

get_deployment_group

Name	Datatype	Description
alarm_configuration	object	A list of alarms associated with the deployment group.
application_name	string	The application name.
auto_rollback_configuration	object	Information about the automatic rollback configuration associated with the deployment group.
auto_scaling_groups	array	A list of associated Auto Scaling groups.
blue_green_deployment_configuration	object	Information about blue/green deployment options for a deployment group.
compute_platform	string	The destination platform type for the deployment (Lambda, Server, or ECS). (Server, Lambda, ECS)
deployment_config_name	string	The deployment configuration name.
deployment_group_id	string	The deployment group ID.
deployment_group_name	string	The deployment group name.
deployment_style	object	Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.
ec_2_tag_filters	array	The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.
ec_2_tag_set	object	Information about groups of tags applied to an Amazon EC2 instance. The deployment group includes only Amazon EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
ecs_services	array	The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.
last_attempted_deployment	object	Information about the most recent attempted deployment to the deployment group.
last_successful_deployment	object	Information about the most recent successful deployment to the deployment group.
load_balancer_info	object	Information about the load balancer to use in a deployment.
on_premises_instance_tag_filters	array	The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.
on_premises_tag_set	object	Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
outdated_instances_strategy	string	Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions. (UPDATE, IGNORE)
service_role_arn	string	A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to Amazon Web Services services on your behalf. For more information, see Create a Service Role for CodeDeploy in the CodeDeploy User Guide.
target_revision	object	Information about the location of an application revision.
termination_hook_enabled	boolean	Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. For more information about the termination hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.
trigger_configurations	array	Information about triggers associated with the deployment group.

list_deployment_groups

Name	Datatype	Description
deployment_group	string	A list of deployment group names.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_deployment_groups	select	region		Gets information about one or more deployment groups.
get_deployment_group	select	region		Gets information about a deployment group.
list_deployment_groups	select	region		Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.
create_deployment_group	insert	region, applicationName, deploymentGroupName, serviceRoleArn		Creates a deployment group to which application revisions are deployed.
update_deployment_group	update	region, applicationName, currentDeploymentGroupName		Changes information about a deployment group.
delete_deployment_group	delete	region		Deletes a deployment group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_deployment_groups

Gets information about one or more deployment groups.

SELECT
deployment_groups_info,
error_message
FROM aws.codedeploy.deployment_groups
WHERE region = '{{ region }}' -- required
;

get_deployment_group

Gets information about a deployment group.

SELECT
alarm_configuration,
application_name,
auto_rollback_configuration,
auto_scaling_groups,
blue_green_deployment_configuration,
compute_platform,
deployment_config_name,
deployment_group_id,
deployment_group_name,
deployment_style,
ec_2_tag_filters,
ec_2_tag_set,
ecs_services,
last_attempted_deployment,
last_successful_deployment,
load_balancer_info,
on_premises_instance_tag_filters,
on_premises_tag_set,
outdated_instances_strategy,
service_role_arn,
target_revision,
termination_hook_enabled,
trigger_configurations
FROM aws.codedeploy.deployment_groups
WHERE region = '{{ region }}' -- required
;

list_deployment_groups

Lists the deployment groups for an application registered with the Amazon Web Services user or Amazon Web Services account.

SELECT
deployment_group
FROM aws.codedeploy.deployment_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_deployment_group

Creates a deployment group to which application revisions are deployed.

INSERT INTO aws.codedeploy.deployment_groups (
applicationName,
deploymentGroupName,
deploymentConfigName,
ec2TagFilters,
onPremisesInstanceTagFilters,
autoScalingGroups,
serviceRoleArn,
triggerConfigurations,
alarmConfiguration,
autoRollbackConfiguration,
outdatedInstancesStrategy,
deploymentStyle,
blueGreenDeploymentConfiguration,
loadBalancerInfo,
ec2TagSet,
ecsServices,
onPremisesTagSet,
tags,
terminationHookEnabled,
region
)
SELECT 
'{{ applicationName }}' /* required */,
'{{ deploymentGroupName }}' /* required */,
'{{ deploymentConfigName }}',
'{{ ec2TagFilters }}',
'{{ onPremisesInstanceTagFilters }}',
'{{ autoScalingGroups }}',
'{{ serviceRoleArn }}' /* required */,
'{{ triggerConfigurations }}',
'{{ alarmConfiguration }}',
'{{ autoRollbackConfiguration }}',
'{{ outdatedInstancesStrategy }}',
'{{ deploymentStyle }}',
'{{ blueGreenDeploymentConfiguration }}',
'{{ loadBalancerInfo }}',
'{{ ec2TagSet }}',
'{{ ecsServices }}',
'{{ onPremisesTagSet }}',
'{{ tags }}',
{{ terminationHookEnabled }},
'{{ region }}'
RETURNING
deployment_group_id
;

Manifest

# Description fields are for documentation purposes
- name: deployment_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the deployment_groups resource.
  - name: applicationName
    value: "{{ applicationName }}"
    description: |
      The name of an CodeDeploy application associated with the user or Amazon Web Services account.
  - name: deploymentGroupName
    value: "{{ deploymentGroupName }}"
    description: |
      The name of a new deployment group for the specified application.
  - name: deploymentConfigName
    value: "{{ deploymentConfigName }}"
    description: |
      If specified, the deployment configuration name can be either one of the predefined configurations provided with CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation. CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group. For more information about the predefined deployment configurations in CodeDeploy, see Working with Deployment Configurations in CodeDeploy in the CodeDeploy User Guide.
  - name: ec2TagFilters
    description: |
      The Amazon EC2 tags on which to filter. The deployment group includes Amazon EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        Type: "{{ Type }}"
  - name: onPremisesInstanceTagFilters
    description: |
      The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        Type: "{{ Type }}"
  - name: autoScalingGroups
    value:
      - "{{ autoScalingGroups }}"
    description: |
      A list of associated Amazon EC2 Auto Scaling groups.
  - name: serviceRoleArn
    value: "{{ serviceRoleArn }}"
    description: |
      A service role Amazon Resource Name (ARN) that allows CodeDeploy to act on the user's behalf when interacting with Amazon Web Services services.
  - name: triggerConfigurations
    description: |
      Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an CodeDeploy Event in the CodeDeploy User Guide.
    value:
      - triggerName: "{{ triggerName }}"
        triggerTargetArn: "{{ triggerTargetArn }}"
        triggerEvents: "{{ triggerEvents }}"
  - name: alarmConfiguration
    description: |
      Information about alarms associated with a deployment or deployment group.
    value:
      enabled: {{ enabled }}
      ignorePollAlarmFailure: {{ ignorePollAlarmFailure }}
      alarms:
        - name: "{{ name }}"
  - name: autoRollbackConfiguration
    description: |
      Configuration information for an automatic rollback that is added when a deployment group is created.
    value:
      enabled: {{ enabled }}
      events:
        - "{{ events }}"
  - name: outdatedInstancesStrategy
    value: "{{ outdatedInstancesStrategy }}"
    description: |
      Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision. If this option is set to UPDATE or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new Amazon EC2 instances. If this option is set to IGNORE, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.
    valid_values: ['UPDATE', 'IGNORE']
  - name: deploymentStyle
    description: |
      Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.
    value:
      deploymentType: "{{ deploymentType }}"
      deploymentOption: "{{ deploymentOption }}"
  - name: blueGreenDeploymentConfiguration
    description: |
      Information about blue/green deployment options for a deployment group.
    value:
      terminateBlueInstancesOnDeploymentSuccess:
        action: "{{ action }}"
        terminationWaitTimeInMinutes: {{ terminationWaitTimeInMinutes }}
      deploymentReadyOption:
        actionOnTimeout: "{{ actionOnTimeout }}"
        waitTimeInMinutes: {{ waitTimeInMinutes }}
      greenFleetProvisioningOption:
        action: "{{ action }}"
  - name: loadBalancerInfo
    description: |
      Information about the load balancer used in a deployment.
    value:
      elbInfoList:
        - name: "{{ name }}"
      targetGroupInfoList:
        - name: "{{ name }}"
      targetGroupPairInfoList:
        - targetGroups: "{{ targetGroups }}"
          prodTrafficRoute:
            listenerArns:
              - "{{ listenerArns }}"
          testTrafficRoute:
            listenerArns:
              - "{{ listenerArns }}"
  - name: ec2TagSet
    description: |
      Information about groups of tags applied to Amazon EC2 instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
    value:
      ec2TagSetList:
        - "{{ ec2TagSetList }}"
  - name: ecsServices
    description: |
      The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format `<clustername>`:`<servicename>`.
    value:
      - serviceName: "{{ serviceName }}"
        clusterName: "{{ clusterName }}"
  - name: onPremisesTagSet
    description: |
      Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
    value:
      onPremisesTagSetList:
        - "{{ onPremisesTagSetList }}"
  - name: tags
    description: |
      The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: terminationHookEnabled
    value: {{ terminationHookEnabled }}
    description: |
      This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see Integrating CodeDeploy with Amazon EC2 Auto Scaling in the CodeDeploy User Guide. Set terminationHookEnabled to true to have CodeDeploy install a termination hook into your Auto Scaling group when you create a deployment group. When this hook is installed, CodeDeploy will perform termination deployments. For information about termination deployments, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide. For more information about Auto Scaling scale-in events, see the Scale in topic in the Amazon EC2 Auto Scaling User Guide.

UPDATE examples

update_deployment_group

Changes information about a deployment group.

UPDATE aws.codedeploy.deployment_groups
SET 
applicationName = '{{ applicationName }}',
currentDeploymentGroupName = '{{ currentDeploymentGroupName }}',
newDeploymentGroupName = '{{ newDeploymentGroupName }}',
deploymentConfigName = '{{ deploymentConfigName }}',
ec2TagFilters = '{{ ec2TagFilters }}',
onPremisesInstanceTagFilters = '{{ onPremisesInstanceTagFilters }}',
autoScalingGroups = '{{ autoScalingGroups }}',
serviceRoleArn = '{{ serviceRoleArn }}',
triggerConfigurations = '{{ triggerConfigurations }}',
alarmConfiguration = '{{ alarmConfiguration }}',
autoRollbackConfiguration = '{{ autoRollbackConfiguration }}',
outdatedInstancesStrategy = '{{ outdatedInstancesStrategy }}',
deploymentStyle = '{{ deploymentStyle }}',
blueGreenDeploymentConfiguration = '{{ blueGreenDeploymentConfiguration }}',
loadBalancerInfo = '{{ loadBalancerInfo }}',
ec2TagSet = '{{ ec2TagSet }}',
ecsServices = '{{ ecsServices }}',
onPremisesTagSet = '{{ onPremisesTagSet }}',
terminationHookEnabled = {{ terminationHookEnabled }}
WHERE 
region = '{{ region }}' --required
AND applicationName = '{{ applicationName }}' --required
AND currentDeploymentGroupName = '{{ currentDeploymentGroupName }}' --required
RETURNING
hooks_not_cleaned_up;

DELETE examples

delete_deployment_group

Deletes a deployment group.

DELETE FROM aws.codedeploy.deployment_groups
WHERE region = '{{ region }}' --required
;