Class ServerDeploymentGroupProps
Construction properties for ServerDeploymentGroup
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ServerDeploymentGroupProps : Object, IServerDeploymentGroupProps
Syntax (vb)
Public Class ServerDeploymentGroupProps
Inherits Object
Implements IServerDeploymentGroupProps
Remarks
ExampleMetadata: infused
Examples
ApplicationLoadBalancer alb;
var listener = alb.AddListener("Listener", new BaseApplicationListenerProps { Port = 80 });
var targetGroup = listener.AddTargets("Fleet", new AddApplicationTargetsProps { Port = 80 });
var deploymentGroup = new ServerDeploymentGroup(this, "DeploymentGroup", new ServerDeploymentGroupProps {
LoadBalancer = LoadBalancer.Application(targetGroup)
});
Synopsis
Constructors
ServerDeploymentGroupProps() |
Properties
Alarms | The CloudWatch alarms associated with this Deployment Group. |
Application | The CodeDeploy EC2/on-premise Application this Deployment Group belongs to. |
AutoRollback | The auto-rollback configuration for this Deployment Group. |
AutoScalingGroups | The auto-scaling groups belonging to this Deployment Group. |
DeploymentConfig | The EC2/on-premise Deployment Configuration to use for this Deployment Group. |
DeploymentGroupName | The physical, human-readable name of the CodeDeploy Deployment Group. |
Ec2InstanceTags | All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. |
IgnoreAlarmConfiguration | Whether to skip the step of checking CloudWatch alarms during the deployment process. |
IgnorePollAlarmsFailure | Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. |
InstallAgent | If you've provided any auto-scaling groups with the |
LoadBalancer | (deprecated) The load balancer to place in front of this Deployment Group. |
LoadBalancers | CodeDeploy supports the deployment to multiple load balancers. |
OnPremiseInstanceTags | All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group. |
Role | The service Role of this Deployment Group. |
Constructors
ServerDeploymentGroupProps()
public ServerDeploymentGroupProps()
Properties
Alarms
The CloudWatch alarms associated with this Deployment Group.
public IAlarm[] Alarms { get; set; }
Property Value
IAlarm[]
Remarks
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.
public IServerApplication Application { get; set; }
Property Value
Remarks
Default: - A new Application will be created.
AutoRollback
The auto-rollback configuration for this Deployment Group.
public IAutoRollbackConfig AutoRollback { get; set; }
Property Value
Remarks
Default: - default AutoRollbackConfig.
AutoScalingGroups
The auto-scaling groups belonging to this Deployment Group.
public IAutoScalingGroup[] AutoScalingGroups { get; set; }
Property Value
Remarks
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: []
DeploymentConfig
The EC2/on-premise Deployment Configuration to use for this Deployment Group.
public IServerDeploymentConfig DeploymentConfig { get; set; }
Property Value
Remarks
Default: ServerDeploymentConfig#OneAtATime
DeploymentGroupName
The physical, human-readable name of the CodeDeploy Deployment Group.
public string DeploymentGroupName { get; set; }
Property Value
System.String
Remarks
Default: - An auto-generated name will be used.
Ec2InstanceTags
All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
public InstanceTagSet Ec2InstanceTags { get; set; }
Property Value
Remarks
Default: - No additional EC2 instances will be added to the Deployment Group.
IgnoreAlarmConfiguration
Whether to skip the step of checking CloudWatch alarms during the deployment process.
public Nullable<bool> IgnoreAlarmConfiguration { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - false
IgnorePollAlarmsFailure
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
public Nullable<bool> IgnorePollAlarmsFailure { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
InstallAgent
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.
public Nullable<bool> InstallAgent { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
LoadBalancer
(deprecated) The load balancer to place in front of this Deployment Group.
public LoadBalancer LoadBalancer { get; set; }
Property Value
Remarks
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.
Stability: Deprecated
LoadBalancers
CodeDeploy supports the deployment to multiple load balancers.
public LoadBalancer[] LoadBalancers { get; set; }
Property Value
Remarks
Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups.
Default: - Deployment Group will not have load balancers defined.
OnPremiseInstanceTags
All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
public InstanceTagSet OnPremiseInstanceTags { get; set; }
Property Value
Remarks
Default: - No additional on-premise instances will be added to the Deployment Group.
Role
The service Role of this Deployment Group.
public IRole Role { get; set; }
Property Value
Remarks
Default: - A new Role will be created.