CodeDeploy / Client / update_deployment_group

update_deployment_group#

CodeDeploy.Client.update_deployment_group(**kwargs)#

Changes information about a deployment group.

Request Syntax

response = client.update_deployment_group(
    applicationName='string',
    currentDeploymentGroupName='string',
    newDeploymentGroupName='string',
    deploymentConfigName='string',
    ec2TagFilters=[
        {
            'Key': 'string',
            'Value': 'string',
            'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
        },
    ],
    onPremisesInstanceTagFilters=[
        {
            'Key': 'string',
            'Value': 'string',
            'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
        },
    ],
    autoScalingGroups=[
        'string',
    ],
    serviceRoleArn='string',
    triggerConfigurations=[
        {
            'triggerName': 'string',
            'triggerTargetArn': 'string',
            'triggerEvents': [
                'DeploymentStart'|'DeploymentSuccess'|'DeploymentFailure'|'DeploymentStop'|'DeploymentRollback'|'DeploymentReady'|'InstanceStart'|'InstanceSuccess'|'InstanceFailure'|'InstanceReady',
            ]
        },
    ],
    alarmConfiguration={
        'enabled': True|False,
        'ignorePollAlarmFailure': True|False,
        'alarms': [
            {
                'name': 'string'
            },
        ]
    },
    autoRollbackConfiguration={
        'enabled': True|False,
        'events': [
            'DEPLOYMENT_FAILURE'|'DEPLOYMENT_STOP_ON_ALARM'|'DEPLOYMENT_STOP_ON_REQUEST',
        ]
    },
    outdatedInstancesStrategy='UPDATE'|'IGNORE',
    deploymentStyle={
        'deploymentType': 'IN_PLACE'|'BLUE_GREEN',
        'deploymentOption': 'WITH_TRAFFIC_CONTROL'|'WITHOUT_TRAFFIC_CONTROL'
    },
    blueGreenDeploymentConfiguration={
        'terminateBlueInstancesOnDeploymentSuccess': {
            'action': 'TERMINATE'|'KEEP_ALIVE',
            'terminationWaitTimeInMinutes': 123
        },
        'deploymentReadyOption': {
            'actionOnTimeout': 'CONTINUE_DEPLOYMENT'|'STOP_DEPLOYMENT',
            'waitTimeInMinutes': 123
        },
        'greenFleetProvisioningOption': {
            'action': 'DISCOVER_EXISTING'|'COPY_AUTO_SCALING_GROUP'
        }
    },
    loadBalancerInfo={
        'elbInfoList': [
            {
                'name': 'string'
            },
        ],
        'targetGroupInfoList': [
            {
                'name': 'string'
            },
        ],
        'targetGroupPairInfoList': [
            {
                'targetGroups': [
                    {
                        'name': 'string'
                    },
                ],
                'prodTrafficRoute': {
                    'listenerArns': [
                        'string',
                    ]
                },
                'testTrafficRoute': {
                    'listenerArns': [
                        'string',
                    ]
                }
            },
        ]
    },
    ec2TagSet={
        'ec2TagSetList': [
            [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
                },
            ],
        ]
    },
    ecsServices=[
        {
            'serviceName': 'string',
            'clusterName': 'string'
        },
    ],
    onPremisesTagSet={
        'onPremisesTagSetList': [
            [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'Type': 'KEY_ONLY'|'VALUE_ONLY'|'KEY_AND_VALUE'
                },
            ],
        ]
    },
    terminationHookEnabled=True|False
)

Parameters:

applicationName (string) –
[REQUIRED]

The application name that corresponds to the deployment group to update.
currentDeploymentGroupName (string) –
[REQUIRED]

The current name of the deployment group.
newDeploymentGroupName (string) – The new name of the deployment group, if you want to change it.
deploymentConfigName (string) – The replacement deployment configuration name to use, if you want to change it.
ec2TagFilters (list) –
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.
- (dict) –
  
  Information about an EC2 tag filter.
  - Key (string) –
    
    The tag filter key.
  - Value (string) –
    
    The tag filter value.
  - Type (string) –
    
    The tag filter type:
    - KEY_ONLY: Key only.
    - VALUE_ONLY: Value only.
    - KEY_AND_VALUE: Key and value.
onPremisesInstanceTagFilters (list) –
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.
- (dict) –
  
  Information about an on-premises instance tag filter.
  - Key (string) –
    
    The on-premises instance tag filter key.
  - Value (string) –
    
    The on-premises instance tag filter value.
  - Type (string) –
    
    The on-premises instance tag filter type:
    - KEY_ONLY: Key only.
    - VALUE_ONLY: Value only.
    - KEY_AND_VALUE: Key and value.
autoScalingGroups (list) –
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.
- (string) –
serviceRoleArn (string) – A replacement ARN for the service role, if you want to change it.
triggerConfigurations (list) –
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.
- (dict) –
  
  Information about notification triggers for the deployment group.
  - triggerName (string) –
    
    The name of the notification trigger.
  - triggerTargetArn (string) –
    
    The Amazon Resource Name (ARN) of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
  - triggerEvents (list) –
    
    The event type or types for which notifications are triggered.
    - (string) –
alarmConfiguration (dict) –
Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
- enabled (boolean) –
  
  Indicates whether the alarm configuration is enabled.
- ignorePollAlarmFailure (boolean) –
  
  Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.
  - true: The deployment proceeds even if alarm status information can’t be retrieved from Amazon CloudWatch.
  - false: The deployment stops if alarm status information can’t be retrieved from Amazon CloudWatch.
- alarms (list) –
  
  A list of alarms configured for the deployment or deployment group. A maximum of 10 alarms can be added.
  - (dict) –
    
    Information about an alarm.
    - name (string) –
      
      The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.
autoRollbackConfiguration (dict) –
Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
- enabled (boolean) –
  
  Indicates whether a defined automatic rollback configuration is currently enabled.
- events (list) –
  
  The event type or types that trigger a rollback.
  - (string) –
outdatedInstancesStrategy (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.
deploymentStyle (dict) –
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.
- deploymentType (string) –
  
  Indicates whether to run an in-place deployment or a blue/green deployment.
- deploymentOption (string) –
  
  Indicates whether to route deployment traffic behind a load balancer.
blueGreenDeploymentConfiguration (dict) –
Information about blue/green deployment options for a deployment group.
- terminateBlueInstancesOnDeploymentSuccess (dict) –
  
  Information about whether to terminate instances in the original fleet during a blue/green deployment.
  - action (string) –
    
    The action to take on instances in the original environment after a successful blue/green deployment.
    - TERMINATE: Instances are terminated after a specified wait time.
    - KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.
  - terminationWaitTimeInMinutes (integer) –
    
    For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.
    
    For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.
    
    The maximum setting is 2880 minutes (2 days).
- deploymentReadyOption (dict) –
  
  Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.
  - actionOnTimeout (string) –
    
    Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.
    - CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.
    - STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.
  - waitTimeInMinutes (integer) –
    
    The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout.
- greenFleetProvisioningOption (dict) –
  
  Information about how instances are provisioned for a replacement environment in a blue/green deployment.
  - action (string) –
    
    The method used to add instances to a replacement environment.
    - DISCOVER_EXISTING: Use instances that already exist or will be created manually.
    - COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.
loadBalancerInfo (dict) –
Information about the load balancer used in a deployment.
- elbInfoList (list) –
  
  An array that contains information about the load balancers to use for load balancing in a deployment. If you’re using Classic Load Balancers, specify those load balancers in this array.
  
  Note
  You can add up to 10 load balancers to the array.
  
  Note
  If you’re using Application Load Balancers or Network Load Balancers, use the targetGroupInfoList array instead of this one.
  - (dict) –
    
    Information about a Classic Load Balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.
    - name (string) –
      
      For blue/green deployments, the name of the Classic Load Balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the Classic Load Balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
- targetGroupInfoList (list) –
  
  An array that contains information about the target groups to use for load balancing in a deployment. If you’re using Application Load Balancers and Network Load Balancers, specify their associated target groups in this array.
  
  Note
  You can add up to 10 target groups to the array.
  
  Note
  If you’re using Classic Load Balancers, use the elbInfoList array instead of this one.
  - (dict) –
    
    Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.
    - name (string) –
      
      For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
- targetGroupPairInfoList (list) –
  
  The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.
  - (dict) –
    
    Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.
    - targetGroups (list) –
      
      One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.
      - (dict) –
        
        Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.
        
        name (string) –
        
        For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.
    - prodTrafficRoute (dict) –
      
      The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
      - listenerArns (list) –
        
        The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.
        
        (string) –
    - testTrafficRoute (dict) –
      
      An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.
      - listenerArns (list) –
        
        The Amazon Resource Name (ARN) of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.
        
        (string) –
ec2TagSet (dict) –
Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.
- ec2TagSetList (list) –
  
  A list that contains other lists of Amazon EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
  - (list) –
    - (dict) –
      
      Information about an EC2 tag filter.
      - Key (string) –
        
        The tag filter key.
      - Value (string) –
        
        The tag filter value.
      - Type (string) –
        
        The tag filter type:
        
        KEY_ONLY: Key only.
        
        VALUE_ONLY: Value only.
        
        KEY_AND_VALUE: Key and value.
ecsServices (list) –
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>.
- (dict) –
  
  Contains the service and cluster names used to identify an Amazon ECS deployment’s target.
  - serviceName (string) –
    
    The name of the target Amazon ECS service.
  - clusterName (string) –
    
    The name of the cluster that the Amazon ECS service is associated with.
onPremisesTagSet (dict) –
Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.
- onPremisesTagSetList (list) –
  
  A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.
  - (list) –
    - (dict) –
      
      Information about an on-premises instance tag filter.
      - Key (string) –
        
        The on-premises instance tag filter key.
      - Value (string) –
        
        The on-premises instance tag filter value.
      - Type (string) –
        
        The on-premises instance tag filter type:
        
        KEY_ONLY: Key only.
        
        VALUE_ONLY: Value only.
        
        KEY_AND_VALUE: Key and value.
terminationHookEnabled (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 topic in the Amazon EC2 Auto Scaling User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'hooksNotCleanedUp': [
        {
            'name': 'string',
            'hook': 'string',
            'terminationHook': 'string'
        },
    ]
}

Response Structure

(dict) –

Represents the output of an UpdateDeploymentGroup operation.
- hooksNotCleanedUp (list) –
  
  If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon Web Services account. If the output contains data, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon Web Services account.
  - (dict) –
    
    Information about an Auto Scaling group.
    - name (string) –
      
      The Auto Scaling group name.
    - hook (string) –
      
      The name of the launch hook that CodeDeploy installed into the Auto Scaling group.
      
      For more information about the launch hook, see How Amazon EC2 Auto Scaling works with CodeDeploy in the CodeDeploy User Guide.
    - terminationHook (string) –
      
      The name of the termination hook that CodeDeploy installed into the Auto Scaling group.
      
      For more information about the termination hook, see Enabling termination deployments during Auto Scaling scale-in events in the CodeDeploy User Guide.

Exceptions

CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.ApplicationDoesNotExistException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.DeploymentGroupAlreadyExistsException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException
CodeDeploy.Client.exceptions.InvalidEC2TagException
CodeDeploy.Client.exceptions.InvalidTagException
CodeDeploy.Client.exceptions.InvalidAutoScalingGroupException
CodeDeploy.Client.exceptions.InvalidDeploymentConfigNameException
CodeDeploy.Client.exceptions.DeploymentConfigDoesNotExistException
CodeDeploy.Client.exceptions.InvalidRoleException
CodeDeploy.Client.exceptions.LifecycleHookLimitExceededException
CodeDeploy.Client.exceptions.InvalidTriggerConfigException
CodeDeploy.Client.exceptions.TriggerTargetsLimitExceededException
CodeDeploy.Client.exceptions.InvalidAlarmConfigException
CodeDeploy.Client.exceptions.AlarmsLimitExceededException
CodeDeploy.Client.exceptions.InvalidAutoRollbackConfigException
CodeDeploy.Client.exceptions.InvalidLoadBalancerInfoException
CodeDeploy.Client.exceptions.InvalidDeploymentStyleException
CodeDeploy.Client.exceptions.InvalidBlueGreenDeploymentConfigurationException
CodeDeploy.Client.exceptions.InvalidEC2TagCombinationException
CodeDeploy.Client.exceptions.InvalidOnPremisesTagCombinationException
CodeDeploy.Client.exceptions.TagSetListLimitExceededException
CodeDeploy.Client.exceptions.InvalidInputException
CodeDeploy.Client.exceptions.ThrottlingException
CodeDeploy.Client.exceptions.InvalidECSServiceException
CodeDeploy.Client.exceptions.InvalidTargetGroupPairException
CodeDeploy.Client.exceptions.ECSServiceMappingLimitExceededException
CodeDeploy.Client.exceptions.InvalidTrafficRoutingConfigurationException