Interface IServerDeploymentGroupProps
Construction properties for ServerDeploymentGroup.
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IServerDeploymentGroupPropsSyntax (vb)
Public Interface IServerDeploymentGroupPropsRemarks
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
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. |
| TerminationHook | Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group. |
Properties
Alarms
The CloudWatch alarms associated with this Deployment Group.
IAlarmRef[]? Alarms { get; }Property Value
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.
IApplicationRef? Application { get; }Property Value
Remarks
Default: - A new Application will be created.
AutoRollback
The auto-rollback configuration for this Deployment Group.
IAutoRollbackConfig? AutoRollback { get; }Property Value
Remarks
Default: - default AutoRollbackConfig.
AutoScalingGroups
The auto-scaling groups belonging to this Deployment Group.
IAutoScalingGroup[]? AutoScalingGroups { get; }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.
IDeploymentConfigRef? DeploymentConfig { get; }Property Value
Remarks
Default: ServerDeploymentConfig#OneAtATime
DeploymentGroupName
The physical, human-readable name of the CodeDeploy Deployment Group.
string? DeploymentGroupName { get; }Property Value
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.
InstanceTagSet? Ec2InstanceTags { get; }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.
bool? IgnoreAlarmConfiguration { get; }Property Value
bool?
Remarks
Default: - false
IgnorePollAlarmsFailure
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
bool? IgnorePollAlarmsFailure { get; }Property Value
bool?
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.
bool? InstallAgent { get; }Property Value
bool?
Remarks
LoadBalancer
(deprecated) The load balancer to place in front of this Deployment Group.
[Obsolete("- Use `loadBalancers` instead.")]
LoadBalancer? LoadBalancer { get; }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.
LoadBalancer[]? LoadBalancers { get; }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.
InstanceTagSet? OnPremiseInstanceTags { get; }Property Value
Remarks
Default: - No additional on-premise instances will be added to the Deployment Group.
Role
The service Role of this Deployment Group.
IRole? Role { get; }Property Value
Remarks
Default: - A new Role will be created.
TerminationHook
Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.
bool? TerminationHook { get; }Property Value
bool?