software.amazon.awscdk.services.codedeploy

Interface ServerDeploymentGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServerDeploymentGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:56.593Z")
 @Stability(value=Experimental)
public interface ServerDeploymentGroupProps
extends software.amazon.jsii.JsiiSerializable

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAlarms

@Stability(value=Experimental)
 @Nullable
default List<IAlarm> getAlarms()

(experimental) 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

@Stability(value=Experimental)
 @Nullable
default IServerApplication getApplication()

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

Default: - A new Application will be created.

getAutoRollback

@Stability(value=Experimental)
 @Nullable
default AutoRollbackConfig getAutoRollback()

(experimental) The auto-rollback configuration for this Deployment Group.

Default: - default AutoRollbackConfig.

getAutoScalingGroups

@Stability(value=Experimental)
 @Nullable
default List<IAutoScalingGroup> getAutoScalingGroups()

(experimental) 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

@Stability(value=Experimental)
 @Nullable
default IServerDeploymentConfig getDeploymentConfig()

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

Default: ServerDeploymentConfig#OneAtATime

getDeploymentGroupName

@Stability(value=Experimental)
 @Nullable
default String getDeploymentGroupName()

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

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

getEc2InstanceTags

@Stability(value=Experimental)
 @Nullable
default InstanceTagSet getEc2InstanceTags()

(experimental) 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=Experimental)
 @Nullable
default Boolean getIgnorePollAlarmsFailure()

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

Default: false

getInstallAgent

@Stability(value=Experimental)
 @Nullable
default Boolean getInstallAgent()

(experimental) 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=Experimental)
 @Nullable
default LoadBalancer getLoadBalancer()

(experimental) 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=Experimental)
 @Nullable
default InstanceTagSet getOnPremiseInstanceTags()

(experimental) 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=Experimental)
 @Nullable
default IRole getRole()

(experimental) The service Role of this Deployment Group.

Default: - A new Role will be created.

builder

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

Returns:

a ServerDeploymentGroupProps.Builder of ServerDeploymentGroupProps