Package 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.104.0 (build e79254c)", date="2024-11-22T02:23:58.807Z") @Stability(Stable) public interface ServerDeploymentGroupProps extends software.amazon.jsii.JsiiSerializable
Construction properties for ServerDeploymentGroup.

Example: 

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

  • Method Details

    • getAlarms

      @Stability(Stable) @Nullable default 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 #addAlarm method.

      Default: []

      See Also:

    • getApplication

      @Stability(Stable) @Nullable default IServerApplication getApplication()
      The CodeDeploy EC2/on-premise Application this Deployment Group belongs to.

      Default: - A new Application will be created.

    • getAutoRollback

      @Stability(Stable) @Nullable default AutoRollbackConfig getAutoRollback()
      The auto-rollback configuration for this Deployment Group.

      Default: - default AutoRollbackConfig.

    • getAutoScalingGroups

      @Stability(Stable) @Nullable default 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 #addAutoScalingGroup method.

      [disable-awslint:ref-via-interface] is needed because we update userdata for ASGs to install the codedeploy agent.

      Default: []

    • getDeploymentConfig

      @Stability(Stable) @Nullable default IServerDeploymentConfig getDeploymentConfig()
      The EC2/on-premise Deployment Configuration to use for this Deployment Group.

      Default: ServerDeploymentConfig#OneAtATime

    • getDeploymentGroupName

      @Stability(Stable) @Nullable default String getDeploymentGroupName()
      The physical, human-readable name of the CodeDeploy Deployment Group.

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

    • getEc2InstanceTags

      @Stability(Stable) @Nullable 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.

    • getIgnoreAlarmConfiguration

      @Stability(Stable) @Nullable default Boolean getIgnoreAlarmConfiguration()
      Whether to skip the step of checking CloudWatch alarms during the deployment process.

      Default: - false

    • getIgnorePollAlarmsFailure

      @Stability(Stable) @Nullable default Boolean getIgnorePollAlarmsFailure()
      Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

      Default: false

    • getInstallAgent

      @Stability(Stable) @Nullable default 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:

    • getLoadBalancer

      @Stability(Deprecated) @Deprecated @Nullable default LoadBalancer getLoadBalancer()
      Deprecated.
      • Use loadBalancers instead.
      (deprecated) 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.

    • getLoadBalancers

      @Stability(Stable) @Nullable default List<LoadBalancer> getLoadBalancers()
      CodeDeploy supports the deployment to multiple load balancers.

      Specify either multiple Classic Load Balancers, or Application Load Balancers / Network Load Balancers Target Groups.

      Default: - Deployment Group will not have load balancers defined.

    • getOnPremiseInstanceTags

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

      @Stability(Stable) @Nullable default IRole getRole()
      The service Role of this Deployment Group.

      Default: - A new Role will be created.

    • getTerminationHook

      @Stability(Stable) @Nullable default Boolean getTerminationHook()
      Indicates whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group.

      Default: - false

      See Also:

    • builder

      @Stability(Stable) static ServerDeploymentGroupProps.Builder builder()
      Returns:
      a ServerDeploymentGroupProps.Builder of ServerDeploymentGroupProps