Skip to content

DeploymentGroupInfo

Source code in docs_src/capo_codedeploy/types/deployment_group_info.py
class DeploymentGroupInfo(TypedDict, closed=True):
    application_name: NotRequired[
        "capo_codedeploy.types.application_name.ApplicationName"
    ]
    """<p>The application name.</p>"""
    deployment_group_id: NotRequired[
        "capo_codedeploy.types.deployment_group_id.DeploymentGroupId"
    ]
    """<p>The deployment group ID.</p>"""
    deployment_group_name: NotRequired[
        "capo_codedeploy.types.deployment_group_name.DeploymentGroupName"
    ]
    """<p>The deployment group name.</p>"""
    deployment_config_name: NotRequired[
        "capo_codedeploy.types.deployment_config_name.DeploymentConfigName"
    ]
    """<p>The deployment configuration name.</p>"""
    ec2_tag_filters: NotRequired[
        "capo_codedeploy.types.ec2_tag_filter_list.EC2TagFilterList"
    ]
    """<p>The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.</p>"""
    on_premises_instance_tag_filters: NotRequired[
        "capo_codedeploy.types.tag_filter_list.TagFilterList"
    ]
    """<p>The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.</p>"""
    auto_scaling_groups: NotRequired[
        "capo_codedeploy.types.auto_scaling_group_list.AutoScalingGroupList"
    ]
    """<p>A list of associated Auto Scaling groups.</p>"""
    service_role_arn: NotRequired["capo_codedeploy.types.role.Role"]
    """<p>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 <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/getting-started-create-service-role.html">Create a Service Role for CodeDeploy</a> in the <i>CodeDeploy User Guide</i>.</p>"""
    target_revision: NotRequired[
        "capo_codedeploy.types.revision_location.RevisionLocation"
    ]
    """<p>Information about the deployment group's target revision, including type and location.</p>"""
    trigger_configurations: NotRequired[
        "capo_codedeploy.types.trigger_config_list.TriggerConfigList"
    ]
    """<p>Information about triggers associated with the deployment group.</p>"""
    alarm_configuration: NotRequired[
        "capo_codedeploy.types.alarm_configuration.AlarmConfiguration"
    ]
    """<p>A list of alarms associated with the deployment group.</p>"""
    auto_rollback_configuration: NotRequired[
        "capo_codedeploy.types.auto_rollback_configuration.AutoRollbackConfiguration"
    ]
    """<p>Information about the automatic rollback configuration associated with the deployment group.</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>"""
    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>"""
    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 to use in a deployment.</p>"""
    last_successful_deployment: NotRequired[
        "capo_codedeploy.types.last_deployment_info.LastDeploymentInfo"
    ]
    """<p>Information about the most recent successful deployment to the deployment group.</p>"""
    last_attempted_deployment: NotRequired[
        "capo_codedeploy.types.last_deployment_info.LastDeploymentInfo"
    ]
    """<p>Information about the most recent attempted deployment to the deployment group.</p>"""
    ec2_tag_set: NotRequired["capo_codedeploy.types.ec2_tag_set.EC2TagSet"]
    """<p>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.</p>"""
    on_premises_tag_set: NotRequired[
        "capo_codedeploy.types.on_premises_tag_set.OnPremisesTagSet"
    ]
    """<p>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.</p>"""
    compute_platform: NotRequired[
        "capo_codedeploy.types.compute_platform.ComputePlatform"
    ]
    """<p>The destination platform type for the deployment (<code>Lambda</code>, <code>Server</code>, or <code>ECS</code>).</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>"""
    termination_hook_enabled: "capo_codedeploy.types.boolean.Boolean"
    """<p>Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.</p> <p>For more information about the termination hook, see <a href="https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors">How Amazon EC2 Auto Scaling works with CodeDeploy</a> in the <i>CodeDeploy User Guide</i>.</p>"""

alarm_configuration instance-attribute

alarm_configuration: NotRequired[AlarmConfiguration]

A list of alarms associated with the deployment group.

application_name instance-attribute

application_name: NotRequired[ApplicationName]

The application name.

auto_rollback_configuration instance-attribute

auto_rollback_configuration: NotRequired[AutoRollbackConfiguration]

Information about the automatic rollback configuration associated with the deployment group.

auto_scaling_groups instance-attribute

auto_scaling_groups: NotRequired[AutoScalingGroupList]

A list of associated Auto Scaling groups.

blue_green_deployment_configuration instance-attribute

blue_green_deployment_configuration: NotRequired[BlueGreenDeploymentConfiguration]

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

compute_platform instance-attribute

compute_platform: NotRequired[ComputePlatform]

The destination platform type for the deployment (Lambda, Server, or ECS).

deployment_config_name instance-attribute

deployment_config_name: NotRequired[DeploymentConfigName]

The deployment configuration name.

deployment_group_id instance-attribute

deployment_group_id: NotRequired[DeploymentGroupId]

The deployment group ID.

deployment_group_name instance-attribute

deployment_group_name: NotRequired[DeploymentGroupName]

The deployment group name.

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 Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

ec2_tag_set instance-attribute

ec2_tag_set: NotRequired[EC2TagSet]

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

last_attempted_deployment instance-attribute

last_attempted_deployment: NotRequired[LastDeploymentInfo]

Information about the most recent attempted deployment to the deployment group.

last_successful_deployment instance-attribute

last_successful_deployment: NotRequired[LastDeploymentInfo]

Information about the most recent successful deployment to the deployment group.

load_balancer_info instance-attribute

load_balancer_info: NotRequired[LoadBalancerInfo]

Information about the load balancer to use in a deployment.

on_premises_instance_tag_filters instance-attribute

on_premises_instance_tag_filters: NotRequired[TagFilterList]

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 instance-attribute

on_premises_tag_set: NotRequired[OnPremisesTagSet]

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 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 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 instance-attribute

target_revision: NotRequired[RevisionLocation]

Information about the deployment group's target revision, including type and location.

termination_hook_enabled instance-attribute

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 instance-attribute

trigger_configurations: NotRequired[TriggerConfigList]

Information about triggers associated with the deployment group.