software.amazon.awscdk.services.codedeploy

Interface ServerDeploymentGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServerDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.19.0 (build 7c562bc)",
           date="2019-10-15T12:37:28.462Z")
 @Stability(value=Stable)
public interface ServerDeploymentGroupProps
extends software.amazon.jsii.JsiiSerializable

Construction properties for ServerDeploymentGroup.

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

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlarms

@Stability(value=Stable)
List<software.amazon.awscdk.services.cloudwatch.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 #addAlarm method. Default: []

See Also:

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

getApplication

@Stability(value=Stable)
IServerApplication getApplication()

The CodeDeploy EC2/on-premise Application this Deployment Group belongs to. Default: - A new Application will be created.

getAutoRollback

@Stability(value=Stable)
AutoRollbackConfig getAutoRollback()

The auto-rollback configuration for this Deployment Group. Default: - default AutoRollbackConfig.

getAutoScalingGroups

@Stability(value=Stable)
List<software.amazon.awscdk.services.autoscaling.AutoScalingGroup> 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 #addAutoScalingGroup method. [disable-awslint:ref-via-interface] is needed because we update userdata for ASGs to install the codedeploy agent. Default: []

getDeploymentConfig

@Stability(value=Stable)
IServerDeploymentConfig getDeploymentConfig()

The EC2/on-premise Deployment Configuration to use for this Deployment Group. Default: ServerDeploymentConfig#OneAtATime

getDeploymentGroupName

@Stability(value=Stable)
String getDeploymentGroupName()

The physical, human-readable name of the CodeDeploy Deployment Group. Default: - An auto-generated name will be used.

getEc2InstanceTags

@Stability(value=Stable)
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

@Stability(value=Stable)
Boolean getIgnorePollAlarmsFailure()

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

getInstallAgent

@Stability(value=Stable)
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

@Stability(value=Stable)
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

@Stability(value=Stable)
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

@Stability(value=Stable)
software.amazon.awscdk.services.iam.IRole getRole()

The service Role of this Deployment Group. Default: - A new Role will be created.

builder

@Stability(value=Stable)
static ServerDeploymentGroupProps.Builder builder()

Returns:

a ServerDeploymentGroupProps.Builder of ServerDeploymentGroupProps