Package io.github.cdklabs.cdk.ecs.codedeploy

Class ApplicationLoadBalancedCodeDeployedFargateService

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:18.999Z")
@Stability(Experimental)
public class ApplicationLoadBalancedCodeDeployedFargateService
extends software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateService
    (experimental) A Fargate service running on an ECS cluster fronted by an application load balancer and deployed by CodeDeploy.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addServiceAsTarget​(software.amazon.awscdk.services.ecs.BaseService service)
      (experimental) Adds service as a target of the target group.
      software.amazon.awscdk.services.s3.IBucket getAccessLogBucket()
      (experimental) S3 Bucket used for access logs.
      ApiCanary getApiCanary()
      (experimental) API Canary for the service.
      software.amazon.awscdk.services.codedeploy.EcsApplication getApplication()
      (experimental) CodeDeploy application for this service.
      EcsDeployment getDeployment()
      (experimental) CodeDeploy deployment for this service.
      software.amazon.awscdk.services.codedeploy.EcsDeploymentGroup getDeploymentGroup()
      (experimental) CodeDeploy deployment group for this service.
      software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup getGreenTargetGroup()
      (experimental) Test target group to use for CodeDeploy deployments.
      software.amazon.awscdk.services.cloudwatch.IAlarm getHealthAlarm()
      (experimental) Composite alarm for monitoring health of service.
      software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener getTestListener()
      (experimental) Test listener to use for CodeDeploy deployments.
      void setAccessLogBucket​(software.amazon.awscdk.services.s3.IBucket value)
      (experimental) S3 Bucket used for access logs.
      void setApiCanary​(ApiCanary value)
      (experimental) API Canary for the service.
      void setApplication​(software.amazon.awscdk.services.codedeploy.EcsApplication value)
      (experimental) CodeDeploy application for this service.
      void setDeployment​(EcsDeployment value)
      (experimental) CodeDeploy deployment for this service.
      void setDeploymentGroup​(software.amazon.awscdk.services.codedeploy.EcsDeploymentGroup value)
      (experimental) CodeDeploy deployment group for this service.
      void setGreenTargetGroup​(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup value)
      (experimental) Test target group to use for CodeDeploy deployments.
      void setHealthAlarm​(software.amazon.awscdk.services.cloudwatch.IAlarm value)
      (experimental) Composite alarm for monitoring health of service.
      void setTestListener​(software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener value)
      (experimental) Test listener to use for CodeDeploy deployments.

      • Methods inherited from class software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateService

        getAssignPublicIp, getService, getTaskDefinition

      • Methods inherited from class software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBase

        createAWSLogDriver, getCertificate, getCluster, getDefaultCluster, getDefaultCluster, getInternalDesiredCount, getListener, getLoadBalancer, getRedirectListener, getTargetGroup

      • Methods inherited from class software.constructs.Construct

        getNode, isConstruct, toString

      • Methods inherited from class software.amazon.jsii.JsiiObject

        jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • ApplicationLoadBalancedCodeDeployedFargateService

        protected ApplicationLoadBalancedCodeDeployedFargateService​(software.amazon.jsii.JsiiObjectRef objRef)

      • ApplicationLoadBalancedCodeDeployedFargateService

        protected ApplicationLoadBalancedCodeDeployedFargateService​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • ApplicationLoadBalancedCodeDeployedFargateService

        @Stability(Experimental)
public ApplicationLoadBalancedCodeDeployedFargateService​(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         ApplicationLoadBalancedCodeDeployedFargateServiceProps props)
        (experimental) Constructs a new instance of the ApplicationLoadBalancedCodeDeployedFargateService class.

        Parameters:
        scope - This parameter is required.
        id - This parameter is required.
        props - This parameter is required.

    • Method Detail

      • addServiceAsTarget

        @Stability(Experimental)
protected void addServiceAsTarget​(@NotNull
                                  software.amazon.awscdk.services.ecs.BaseService service)
        (experimental) Adds service as a target of the target group.

        Overrides:
        addServiceAsTarget in class software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBase
        Parameters:
        service - This parameter is required.

      • getAccessLogBucket

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.s3.IBucket getAccessLogBucket()
        (experimental) S3 Bucket used for access logs.

      • setAccessLogBucket

        @Stability(Experimental)
public void setAccessLogBucket​(@NotNull
                               software.amazon.awscdk.services.s3.IBucket value)
        (experimental) S3 Bucket used for access logs.

      • getApplication

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.codedeploy.EcsApplication getApplication()
        (experimental) CodeDeploy application for this service.

      • setApplication

        @Stability(Experimental)
public void setApplication​(@NotNull
                           software.amazon.awscdk.services.codedeploy.EcsApplication value)
        (experimental) CodeDeploy application for this service.

      • getDeployment

        @Stability(Experimental)
@NotNull
public EcsDeployment getDeployment()
        (experimental) CodeDeploy deployment for this service.

      • setDeployment

        @Stability(Experimental)
public void setDeployment​(@NotNull
                          EcsDeployment value)
        (experimental) CodeDeploy deployment for this service.

      • getDeploymentGroup

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.codedeploy.EcsDeploymentGroup getDeploymentGroup()
        (experimental) CodeDeploy deployment group for this service.

      • setDeploymentGroup

        @Stability(Experimental)
public void setDeploymentGroup​(@NotNull
                               software.amazon.awscdk.services.codedeploy.EcsDeploymentGroup value)
        (experimental) CodeDeploy deployment group for this service.

      • getGreenTargetGroup

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup getGreenTargetGroup()
        (experimental) Test target group to use for CodeDeploy deployments.

      • setGreenTargetGroup

        @Stability(Experimental)
public void setGreenTargetGroup​(@NotNull
                                software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationTargetGroup value)
        (experimental) Test target group to use for CodeDeploy deployments.

      • getTestListener

        @Stability(Experimental)
@NotNull
public software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener getTestListener()
        (experimental) Test listener to use for CodeDeploy deployments.

      • setTestListener

        @Stability(Experimental)
public void setTestListener​(@NotNull
                            software.amazon.awscdk.services.elasticloadbalancingv2.ApplicationListener value)
        (experimental) Test listener to use for CodeDeploy deployments.

      • getApiCanary

        @Stability(Experimental)
@Nullable
public ApiCanary getApiCanary()
        (experimental) API Canary for the service.

      • setApiCanary

        @Stability(Experimental)
public void setApiCanary​(@Nullable
                         ApiCanary value)
        (experimental) API Canary for the service.

      • getHealthAlarm

        @Stability(Experimental)
@Nullable
public software.amazon.awscdk.services.cloudwatch.IAlarm getHealthAlarm()
        (experimental) Composite alarm for monitoring health of service.

      • setHealthAlarm

        @Stability(Experimental)
public void setHealthAlarm​(@Nullable
                           software.amazon.awscdk.services.cloudwatch.IAlarm value)
        (experimental) Composite alarm for monitoring health of service.