ServerDeploymentGroupProps

All Known Implementing Classes:: ServerDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.866Z")
public interface ServerDeploymentGroupProps

Construction properties for ServerDeploymentGroup.

Example:

 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 ApplicationLoadBalancer alb;
 ApplicationListener listener = alb.addListener("Listener", BaseApplicationListenerProps.builder().port(80).build());
 ApplicationTargetGroup targetGroup = listener.addTargets("Fleet", AddApplicationTargetsProps.builder().port(80).build());
 ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "DeploymentGroup")
         .loadBalancer(LoadBalancer.application(targetGroup))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ServerDeploymentGroupProps.Builder` A builder for `ServerDeploymentGroupProps`
`static class`	`ServerDeploymentGroupProps.Jsii$Proxy` An implementation for `ServerDeploymentGroupProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static ServerDeploymentGroupProps.Builder`	`builder()`
`default java.util.List<IAlarm>`	`getAlarms()` The CloudWatch alarms associated with this Deployment Group.
`default IServerApplication`	`getApplication()` The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.
`default AutoRollbackConfig`	`getAutoRollback()` The auto-rollback configuration for this Deployment Group.
`default java.util.List<IAutoScalingGroup>`	`getAutoScalingGroups()` The auto-scaling groups belonging to this Deployment Group.
`default IServerDeploymentConfig`	`getDeploymentConfig()` The EC2/on-premise Deployment Configuration to use for this Deployment Group.
`default java.lang.String`	`getDeploymentGroupName()` The physical, human-readable name of the CodeDeploy Deployment Group.
`default InstanceTagSet`	`getEc2InstanceTags()` All EC2 instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
`default java.lang.Boolean`	`getIgnorePollAlarmsFailure()` Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
`default java.lang.Boolean`	`getInstallAgent()` 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 LoadBalancer`	`getLoadBalancer()` The load balancer to place in front of this Deployment Group.
`default InstanceTagSet`	`getOnPremiseInstanceTags()` All on-premise instances matching the given set of tags when a deployment occurs will be added to this Deployment Group.
`default IRole`	`getRole()` The service Role of this Deployment Group.

- Method Detail
  - getAlarms
```
default java.util.List<IAlarm> getAlarms()
```
    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: []
    
    See Also:
    
    https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html
  - getApplication
```
default IServerApplication getApplication()
```
    The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.
    Default: - A new Application will be created.
  - getAutoRollback
```
default AutoRollbackConfig getAutoRollback()
```
    The auto-rollback configuration for this Deployment Group.
    Default: - default AutoRollbackConfig.
  - getAutoScalingGroups
```
default java.util.List<IAutoScalingGroup> getAutoScalingGroups()
```
    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: []
  - getDeploymentConfig
```
default IServerDeploymentConfig getDeploymentConfig()
```
    The EC2/on-premise Deployment Configuration to use for this Deployment Group.
    Default: ServerDeploymentConfig#OneAtATime
  - getDeploymentGroupName
```
default java.lang.String getDeploymentGroupName()
```
    The physical, human-readable name of the CodeDeploy Deployment Group.
    Default: - An auto-generated name will be used.
  - getEc2InstanceTags
```
default InstanceTagSet getEc2InstanceTags()
```
    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.
  - getIgnorePollAlarmsFailure
```
default java.lang.Boolean getIgnorePollAlarmsFailure()
```
    Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
    Default: false
  - getInstallAgent
```
default java.lang.Boolean getInstallAgent()
```
    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 Also:
    
    https://docs.aws.amazon.com/codedeploy/latest/userguide/codedeploy-agent-operations-install.html
  - getLoadBalancer
```
default LoadBalancer getLoadBalancer()
```
    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.
  - getOnPremiseInstanceTags
```
default InstanceTagSet getOnPremiseInstanceTags()
```
    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.
  - getRole
```
default IRole getRole()
```
    The service Role of this Deployment Group.
    Default: - A new Role will be created.
  - builder
```
static ServerDeploymentGroupProps.Builder builder()
```
    Returns:
    
    a ServerDeploymentGroupProps.Builder of ServerDeploymentGroupProps

Interface ServerDeploymentGroupProps

Nested Class Summary

Method Summary

Method Detail

getAlarms

getApplication

getAutoRollback

getAutoScalingGroups

getDeploymentConfig

getDeploymentGroupName

getEc2InstanceTags

getIgnorePollAlarmsFailure

getInstallAgent

getLoadBalancer

getOnPremiseInstanceTags

getRole

builder