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_poll_alarms_failure=None, install_agent=None, load_balancer=None, on_premise_instance_tags=None, role=None)

Bases: object

__init__(*, alarms=None, application=None, auto_rollback=None, auto_scaling_groups=None, deployment_config=None, deployment_group_name=None, ec2_instance_tags=None, ignore_poll_alarms_failure=None, install_agent=None, load_balancer=None, on_premise_instance_tags=None, role=None)

Construction properties for {@link ServerDeploymentGroup}.

Parameters
  • alarms (Optional[List[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 {@link #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 (Optional[AutoRollbackConfig]) – The auto-rollback configuration for this Deployment Group. Default: - default AutoRollbackConfig.

  • auto_scaling_groups (Optional[List[AutoScalingGroup]]) – The auto-scaling groups belonging to this Deployment Group. Auto-scaling groups can also be added after the Deployment Group is created using the {@link #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_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 {@link #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]) – 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.

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

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 {@link #addAlarm} method.

default :default: []

see :see: https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html

Return type

Optional[List[IAlarm]]

application

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

default :default: - A new Application will be created.

Return type

Optional[IServerApplication]

auto_rollback

The auto-rollback configuration for this Deployment Group.

default :default: - default AutoRollbackConfig.

Return type

Optional[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 {@link #addAutoScalingGroup} method.

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

default :default: []

Return type

Optional[List[AutoScalingGroup]]

deployment_config

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

default :default: ServerDeploymentConfig#OneAtATime

Return type

Optional[IServerDeploymentConfig]

deployment_group_name

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

default :default: - An auto-generated name will be used.

Return type

Optional[str]

ec2_instance_tags

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

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

Return type

Optional[InstanceTagSet]

ignore_poll_alarms_failure

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

default :default: false

Return type

Optional[bool]

install_agent

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

default :default: true

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

Return type

Optional[bool]

load_balancer

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 :default: - Deployment Group will not have a load balancer defined.

Return type

Optional[LoadBalancer]

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 :default: - No additional on-premise instances will be added to the Deployment Group.

Return type

Optional[InstanceTagSet]

role

The service Role of this Deployment Group.

default :default: - A new Role will be created.

Return type

Optional[IRole]