ServerDeploymentGroupProps

class aws_cdk.aws_codedeploy.ServerDeploymentGroupProps(*, alarms=None, application=None, auto_rollback=None, auto_scaling_groups=None, deployment_config=None, deployment_group_name=None, ec2_instance_tags=None, ignore_alarm_configuration=None, ignore_poll_alarms_failure=None, install_agent=None, load_balancer=None, load_balancers=None, on_premise_instance_tags=None, role=None, termination_hook=None)

Bases: object

Construction properties for ServerDeploymentGroup.

Parameters:

alarms (Optional[Sequence[IAlarm]]) – The CloudWatch alarms associated with this Deployment Group. CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger. Alarms can also be added after the Deployment Group is created using the #addAlarm method. Default: []
application (Optional[IServerApplication]) – The CodeDeploy EC2/on-premise Application this Deployment Group belongs to. Default: - A new Application will be created.
auto_rollback (Union[AutoRollbackConfig, Dict[str, Any], None]) – The auto-rollback configuration for this Deployment Group. Default: - default AutoRollbackConfig.
auto_scaling_groups (Optional[Sequence[IAutoScalingGroup]]) – The auto-scaling groups belonging to this Deployment Group. Auto-scaling groups can also be added after the Deployment Group is created using the #addAutoScalingGroup method. [disable-awslint:ref-via-interface] is needed because we update userdata for ASGs to install the codedeploy agent. Default: []
deployment_config (Optional[IServerDeploymentConfig]) – The EC2/on-premise Deployment Configuration to use for this Deployment Group. Default: ServerDeploymentConfig#OneAtATime
deployment_group_name (Optional[str]) – The physical, human-readable name of the CodeDeploy Deployment Group. Default: - An auto-generated name will be used.
ec2_instance_tags (Optional[InstanceTagSet]) – All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. Default: - No additional EC2 instances will be added to the Deployment Group.
ignore_alarm_configuration (Optional[bool]) – Whether to skip the step of checking CloudWatch alarms during the deployment process. Default: - false
ignore_poll_alarms_failure (Optional[bool]) – Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. Default: false
install_agent (Optional[bool]) – If you’ve provided any auto-scaling groups with the #autoScalingGroups property, you can set this property to add User Data that installs the CodeDeploy agent on the instances. Default: true
load_balancer (Optional[LoadBalancer]) – (deprecated) The load balancer to place in front of this Deployment Group. Can be created from either a classic Elastic Load Balancer, or an Application Load Balancer / Network Load Balancer Target Group. Default: - Deployment Group will not have a load balancer defined.
load_balancers (Optional[Sequence[LoadBalancer]]) – CodeDeploy supports the deployment to multiple load balancers. Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups. Default: - Deployment Group will not have load balancers defined.
on_premise_instance_tags (Optional[InstanceTagSet]) – All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. Default: - No additional on-premise instances will be added to the Deployment Group.
role (Optional[IRole]) – The service Role of this Deployment Group. Default: - A new Role will be created.
termination_hook (Optional[bool]) – Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. Default: - false

ExampleMetadata:

infused

Example:

# alb: elbv2.ApplicationLoadBalancer

listener = alb.add_listener("Listener", port=80)
target_group = listener.add_targets("Fleet", port=80)

deployment_group = codedeploy.ServerDeploymentGroup(self, "DeploymentGroup",
    load_balancer=codedeploy.LoadBalancer.application(target_group)
)

Attributes

alarms

The CloudWatch alarms associated with this Deployment Group.

CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.

Alarms can also be added after the Deployment Group is created using the #addAlarm method.

Default:: []
See:: https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html

application

The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.

Default:

A new Application will be created.

auto_rollback

The auto-rollback configuration for this Deployment Group.

Default:

default AutoRollbackConfig.

auto_scaling_groups

The auto-scaling groups belonging to this Deployment Group.

Auto-scaling groups can also be added after the Deployment Group is created using the #addAutoScalingGroup method.

[disable-awslint:ref-via-interface] is needed because we update userdata for ASGs to install the codedeploy agent.

Default:: []

deployment_config

The EC2/on-premise Deployment Configuration to use for this Deployment Group.

Default:: ServerDeploymentConfig#OneAtATime

deployment_group_name

The physical, human-readable name of the CodeDeploy Deployment Group.

Default:

An auto-generated name will be used.

ec2_instance_tags

All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.

Default:

No additional EC2 instances will be added to the Deployment Group.

ignore_alarm_configuration

Whether to skip the step of checking CloudWatch alarms during the deployment process.

Default:

false

ignore_poll_alarms_failure

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

Default:: false

install_agent

If you’ve provided any auto-scaling groups with the #autoScalingGroups property, you can set this property to add User Data that installs the CodeDeploy agent on the instances.

Default:: true
See:: https://docs.aws.amazon.com/codedeploy/latest/userguide/codedeploy-agent-operations-install.html

load_balancer

(deprecated) The load balancer to place in front of this Deployment Group.

Can be created from either a classic Elastic Load Balancer, or an Application Load Balancer / Network Load Balancer Target Group.

Default:

Deployment Group will not have a load balancer defined.

Deprecated:

Use loadBalancers instead.

Stability:

deprecated

load_balancers

CodeDeploy supports the deployment to multiple load balancers.

Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups.

Default:

Deployment Group will not have load balancers defined.

on_premise_instance_tags

All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.

Default:

No additional on-premise instances will be added to the Deployment Group.

role

The service Role of this Deployment Group.

Default:

A new Role will be created.

termination_hook

Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

Default:

false

See:

https://docs.aws.amazon.com/codedeploy/latest/userguide/integrations-aws-auto-scaling.html#integrations-aws-auto-scaling-behaviors