Skip to content

UpdateDeploymentGroupInput

Source code in docs_src/capo_codedeploy/types/update_deployment_group_input.py
class UpdateDeploymentGroupInput(TypedDict, closed=True):
    application_name: "capo_codedeploy.types.application_name.ApplicationName"
    """<p>The application name that corresponds to the deployment group to update.</p>"""
    current_deployment_group_name: (
        "capo_codedeploy.types.deployment_group_name.DeploymentGroupName"
    )
    """<p>The current name of the deployment group.</p>"""
    new_deployment_group_name: NotRequired[
        "capo_codedeploy.types.deployment_group_name.DeploymentGroupName"
    ]
    """<p>The new name of the deployment group, if you want to change it.</p>"""
    deployment_config_name: NotRequired[
        "capo_codedeploy.types.deployment_config_name.DeploymentConfigName"
    ]
    """<p>The replacement deployment configuration name to use, if you want to change it.</p>"""
    ec2_tag_filters: NotRequired[
        "capo_codedeploy.types.ec2_tag_filter_list.EC2TagFilterList"
    ]
    """<p>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.</p>"""
    on_premises_instance_tag_filters: NotRequired[
        "capo_codedeploy.types.tag_filter_list.TagFilterList"
    ]
    """<p>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.</p>"""
    auto_scaling_groups: NotRequired[
        "capo_codedeploy.types.auto_scaling_group_name_list.AutoScalingGroupNameList"
    ]
    """<p>The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.</p> <ul> <li> <p>To keep the Auto Scaling groups, enter their names or do not specify this parameter. </p> </li> <li> <p>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 <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/troubleshooting-auto-scaling.html#troubleshooting-auto-scaling-heartbeat">Amazon EC2 instances in an Amazon EC2 Auto Scaling group fail to launch and receive the error "Heartbeat Timeout"</a> in the <i>CodeDeploy User Guide</i>.</p> </li> </ul>"""
    service_role_arn: NotRequired["capo_codedeploy.types.role.Role"]
    """<p>A replacement ARN for the service role, if you want to change it.</p>"""
    trigger_configurations: NotRequired[
        "capo_codedeploy.types.trigger_config_list.TriggerConfigList"
    ]
    """<p>Information about triggers to change when the deployment group is updated. For examples, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-notify-edit.html">Edit a Trigger in a CodeDeploy Deployment Group</a> in the <i>CodeDeploy User Guide</i>.</p>"""
    alarm_configuration: NotRequired[
        "capo_codedeploy.types.alarm_configuration.AlarmConfiguration"
    ]
    """<p>Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.</p>"""
    auto_rollback_configuration: NotRequired[
        "capo_codedeploy.types.auto_rollback_configuration.AutoRollbackConfiguration"
    ]
    """<p>Information for an automatic rollback configuration that is added or changed when a deployment group is updated.</p>"""
    outdated_instances_strategy: NotRequired[
        "capo_codedeploy.types.outdated_instances_strategy.OutdatedInstancesStrategy"
    ]
    """<p>Indicates what happens when new Amazon EC2 instances are launched mid-deployment and do not receive the deployed application revision.</p> <p>If this option is set to <code>UPDATE</code> 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.</p> <p>If this option is set to <code>IGNORE</code>, CodeDeploy does not initiate a deployment to update the new Amazon EC2 instances. This may result in instances having different revisions.</p>"""
    deployment_style: NotRequired[
        "capo_codedeploy.types.deployment_style.DeploymentStyle"
    ]
    """<p>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.</p>"""
    blue_green_deployment_configuration: NotRequired[
        "capo_codedeploy.types.blue_green_deployment_configuration.BlueGreenDeploymentConfiguration"
    ]
    """<p>Information about blue/green deployment options for a deployment group.</p>"""
    load_balancer_info: NotRequired[
        "capo_codedeploy.types.load_balancer_info.LoadBalancerInfo"
    ]
    """<p>Information about the load balancer used in a deployment.</p>"""
    ec2_tag_set: NotRequired["capo_codedeploy.types.ec2_tag_set.EC2TagSet"]
    """<p>Information about groups of tags applied to on-premises instances. The deployment group includes only Amazon EC2 instances identified by all the tag groups.</p>"""
    ecs_services: NotRequired["capo_codedeploy.types.ecs_service_list.ECSServiceList"]
    """<p> 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 <code><clustername>:<servicename></code>. </p>"""
    on_premises_tag_set: NotRequired[
        "capo_codedeploy.types.on_premises_tag_set.OnPremisesTagSet"
    ]
    """<p>Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.</p>"""
    termination_hook_enabled: NotRequired[
        "capo_codedeploy.types.nullable_boolean.NullableBoolean"
    ]
    """<p>This parameter only applies if you are using CodeDeploy with Amazon EC2 Auto Scaling. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html">Integrating CodeDeploy with Amazon EC2 Auto Scaling</a> in the <i>CodeDeploy User Guide</i>.</p> <p>Set <code>terminationHookEnabled</code> to <code>true</code> 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.</p> <p>For information about termination deployments, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors-hook-enable">Enabling termination deployments during Auto Scaling scale-in events</a> in the <i>CodeDeploy User Guide</i>.</p> <p>For more information about Auto Scaling scale-in events, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-lifecycle.html#as-lifecycle-scale-in">Scale in</a> topic in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"""

alarm_configuration instance-attribute

alarm_configuration: NotRequired[AlarmConfiguration]

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

application_name instance-attribute

application_name: ApplicationName

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

auto_rollback_configuration instance-attribute

auto_rollback_configuration: NotRequired[AutoRollbackConfiguration]

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

auto_scaling_groups instance-attribute

auto_scaling_groups: NotRequired[AutoScalingGroupNameList]

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

blue_green_deployment_configuration instance-attribute

blue_green_deployment_configuration: NotRequired[BlueGreenDeploymentConfiguration]

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

current_deployment_group_name instance-attribute

current_deployment_group_name: DeploymentGroupName

The current name of the deployment group.

deployment_config_name instance-attribute

deployment_config_name: NotRequired[DeploymentConfigName]

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

deployment_style instance-attribute

deployment_style: NotRequired[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.

ec2_tag_filters instance-attribute

ec2_tag_filters: NotRequired[EC2TagFilterList]

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.

ec2_tag_set instance-attribute

ec2_tag_set: NotRequired[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 instance-attribute

ecs_services: NotRequired[ECSServiceList]

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

load_balancer_info instance-attribute

load_balancer_info: NotRequired[LoadBalancerInfo]

Information about the load balancer used in a deployment.

new_deployment_group_name instance-attribute

new_deployment_group_name: NotRequired[DeploymentGroupName]

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

on_premises_instance_tag_filters instance-attribute

on_premises_instance_tag_filters: NotRequired[TagFilterList]

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.

on_premises_tag_set instance-attribute

on_premises_tag_set: NotRequired[OnPremisesTagSet]

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

outdated_instances_strategy instance-attribute

outdated_instances_strategy: NotRequired[OutdatedInstancesStrategy]

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.

service_role_arn instance-attribute

service_role_arn: NotRequired[Role]

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

termination_hook_enabled instance-attribute

termination_hook_enabled: NotRequired[NullableBoolean]

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.

trigger_configurations instance-attribute

trigger_configurations: NotRequired[TriggerConfigList]

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.