Method: Aws::CodeDeploy::Client#update_deployment_group

Defined in:

lib/aws-sdk-codedeploy/client.rb

#update_deployment_group(params = {}) ⇒ Types::UpdateDeploymentGroupOutput

Changes information about a deployment group.

Examples:

Request syntax with placeholder values

resp = client.update_deployment_group({
  application_name: "ApplicationName", # required
  current_deployment_group_name: "DeploymentGroupName", # required
  new_deployment_group_name: "DeploymentGroupName",
  deployment_config_name: "DeploymentConfigName",
  ec2_tag_filters: [
    {
      key: "Key",
      value: "Value",
      type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
    },
  ],
  on_premises_instance_tag_filters: [
    {
      key: "Key",
      value: "Value",
      type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
    },
  ],
  auto_scaling_groups: ["AutoScalingGroupName"],
  service_role_arn: "Role",
  trigger_configurations: [
    {
      trigger_name: "TriggerName",
      trigger_target_arn: "TriggerTargetArn",
      trigger_events: ["DeploymentStart"], # accepts DeploymentStart, DeploymentSuccess, DeploymentFailure, DeploymentStop, DeploymentRollback, DeploymentReady, InstanceStart, InstanceSuccess, InstanceFailure, InstanceReady
    },
  ],
  alarm_configuration: {
    enabled: false,
    ignore_poll_alarm_failure: false,
    alarms: [
      {
        name: "AlarmName",
      },
    ],
  },
  auto_rollback_configuration: {
    enabled: false,
    events: ["DEPLOYMENT_FAILURE"], # accepts DEPLOYMENT_FAILURE, DEPLOYMENT_STOP_ON_ALARM, DEPLOYMENT_STOP_ON_REQUEST
  },
  outdated_instances_strategy: "UPDATE", # accepts UPDATE, IGNORE
  deployment_style: {
    deployment_type: "IN_PLACE", # accepts IN_PLACE, BLUE_GREEN
    deployment_option: "WITH_TRAFFIC_CONTROL", # accepts WITH_TRAFFIC_CONTROL, WITHOUT_TRAFFIC_CONTROL
  },
  blue_green_deployment_configuration: {
    terminate_blue_instances_on_deployment_success: {
      action: "TERMINATE", # accepts TERMINATE, KEEP_ALIVE
      termination_wait_time_in_minutes: 1,
    },
    deployment_ready_option: {
      action_on_timeout: "CONTINUE_DEPLOYMENT", # accepts CONTINUE_DEPLOYMENT, STOP_DEPLOYMENT
      wait_time_in_minutes: 1,
    },
    green_fleet_provisioning_option: {
      action: "DISCOVER_EXISTING", # accepts DISCOVER_EXISTING, COPY_AUTO_SCALING_GROUP
    },
  },
  load_balancer_info: {
    elb_info_list: [
      {
        name: "ELBName",
      },
    ],
    target_group_info_list: [
      {
        name: "TargetGroupName",
      },
    ],
    target_group_pair_info_list: [
      {
        target_groups: [
          {
            name: "TargetGroupName",
          },
        ],
        prod_traffic_route: {
          listener_arns: ["ListenerArn"],
        },
        test_traffic_route: {
          listener_arns: ["ListenerArn"],
        },
      },
    ],
  },
  ec2_tag_set: {
    ec2_tag_set_list: [
      [
        {
          key: "Key",
          value: "Value",
          type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
        },
      ],
    ],
  },
  ecs_services: [
    {
      service_name: "ECSServiceName",
      cluster_name: "ECSClusterName",
    },
  ],
  on_premises_tag_set: {
    on_premises_tag_set_list: [
      [
        {
          key: "Key",
          value: "Value",
          type: "KEY_ONLY", # accepts KEY_ONLY, VALUE_ONLY, KEY_AND_VALUE
        },
      ],
    ],
  },
  termination_hook_enabled: false,
})

Response structure

resp.hooks_not_cleaned_up #=> Array
resp.hooks_not_cleaned_up[0].name #=> String
resp.hooks_not_cleaned_up[0].hook #=> String
resp.hooks_not_cleaned_up[0].termination_hook #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :application_name (required, String) —

  The application name that corresponds to the deployment group to update.

• :current_deployment_group_name (required, String) —

  The current name of the deployment group.

• :new_deployment_group_name (String) —

  The new name of the deployment group, if you want to change it.

• :deployment_config_name (String) —

  The replacement deployment configuration name to use, if you want to change it.

• :ec2_tag_filters (Array<Types::EC2TagFilter>) —

  The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

• :on_premises_instance_tag_filters (Array<Types::TagFilter>) —

  The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

• :auto_scaling_groups (Array<String>) —

  The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.

  • To keep the Auto Scaling groups, enter their names or do not specify this parameter.

  • To remove Auto Scaling groups, specify a non-null empty list of Auto Scaling group names to detach all CodeDeploy-managed Auto Scaling lifecycle hooks. For examples, see [Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error “Heartbeat Timeout“] in the *CodeDeploy User Guide*.

  [1]: docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat

• :service_role_arn (String) —

  A replacement ARN for the service role, if you want to change it.

• :trigger_configurations (Array<Types::TriggerConfig>) —

  Information about triggers to change when the deployment group is updated. For examples, see [Edit a Trigger in a CodeDeploy Deployment Group] in the *CodeDeploy User Guide*.

  [1]: docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html

• :alarm_configuration (Types::AlarmConfiguration) —

  Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

• :auto_rollback_configuration (Types::AutoRollbackConfiguration) —

  Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

• :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.

• :deployment_style (Types::DeploymentStyle) —

  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.

• :blue_green_deployment_configuration (Types::BlueGreenDeploymentConfiguration) —

  Information about blue/green deployment options for a deployment group.

• :load_balancer_info (Types::LoadBalancerInfo) —

  Information about the load balancer used in a deployment.

• :ec2_tag_set (Types::EC2TagSet) —

  Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.

• :ecs_services (Array<Types::ECSService>) —

  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>`.

• :on_premises_tag_set (Types::OnPremisesTagSet) —

  Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

• :termination_hook_enabled (Boolean) —

  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 update 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][3

  topic in the *Amazon EC2 Auto Scaling User Guide*.

  [1]: docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html [2]: docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable [3]: docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in

Returns:

• (Types::UpdateDeploymentGroupOutput) —

  Returns a response object which responds to the following methods:

  • #hooks_not_cleaned_up => Array&lt;Types::AutoScalingGroup&gt;

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-codedeploy/client.rb', line 3644

def update_deployment_group(params = {}, options = {})
  req = build_request(:update_deployment_group, params)
  req.send_request(options)
end