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

Interface ApplicationLoadBalancedCodeDeployedFargateServiceProps

  • All Superinterfaces:
    software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateServiceProps, software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps, software.amazon.awscdk.services.ecs.patterns.FargateServiceBaseProps, software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    ApplicationLoadBalancedCodeDeployedFargateServiceProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-06T18:16:19.060Z")
@Stability(Experimental)
public interface ApplicationLoadBalancedCodeDeployedFargateServiceProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateServiceProps
    (experimental) The properties for the ApplicationLoadBalancedCodeDeployedFargateService service.

    • Method Summary

      All Methods Static Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      static ApplicationLoadBalancedCodeDeployedFargateServiceProps.Builder builder()  
      default software.amazon.awscdk.services.s3.IBucket getAccessLogBucket()
      (experimental) The bucket to use for access logs from the Application Load Balancer.
      default String getAccessLogPrefix()
      (experimental) The prefix to use for access logs from the Application Load Balancer.
      default software.amazon.awscdk.Duration getApiCanarySchedule()
      (experimental) The frequency for running the api canaries.
      default Number getApiCanaryThreadCount()
      (experimental) The number of threads to run concurrently for the synthetic test.
      default software.amazon.awscdk.Duration getApiCanaryTimeout()
      (experimental) The threshold for how long a api canary can take to run.
      default List<ApiTestStep> getApiTestSteps()
      (experimental) The steps to run in the canary.
      default String getApplicationName()
      (experimental) The physical, human-readable name of the CodeDeploy Application.
      default software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig getDeploymentConfig()
      (experimental) The deployment configuration to use for the deployment group.
      default String getDeploymentGroupName()
      (experimental) The physical, human-readable name of the CodeDeploy Deployment Group.
      default software.amazon.awscdk.Duration getDeploymentTimeout()
      (experimental) The timeout for a CodeDeploy deployment.
      default software.amazon.awscdk.Duration getDeregistrationDelay()
      (experimental) The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.
      default AppSpecHooks getHooks()
      (experimental) Optional lifecycle hooks.
      default software.amazon.awscdk.Duration getResponseTimeAlarmThreshold()
      (experimental) The threshold for response time alarm.
      default software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck getTargetHealthCheck()
      (experimental) The healthcheck to configure on the Application Load Balancer target groups.
      default software.amazon.awscdk.Duration getTerminationWaitTime()
      (experimental) The time to wait before terminating the original (blue) task set.
      default Number getTestPort()
      (experimental) The port to use for test traffic on the listener.

      • Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedFargateServiceProps

        getAssignPublicIp, getHealthCheck, getSecurityGroups, getTaskSubnets

      • Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedServiceBaseProps

        getCapacityProviderStrategies, getCertificate, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentController, getDesiredCount, getDomainName, getDomainZone, getEnableECSManagedTags, getEnableExecuteCommand, getHealthCheckGracePeriod, getIdleTimeout, getListenerPort, getLoadBalancer, getLoadBalancerName, getMaxHealthyPercent, getMinHealthyPercent, getOpenListener, getPropagateTags, getProtocol, getProtocolVersion, getPublicLoadBalancer, getRecordType, getRedirectHTTP, getServiceName, getSslPolicy, getTargetProtocol, getTaskImageOptions, getVpc

      • Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.FargateServiceBaseProps

        getCpu, getEphemeralStorageGiB, getMemoryLimitMiB, getPlatformVersion, getRuntimePlatform, getTaskDefinition

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

        $jsii$toJson

    • Method Detail

      • getAccessLogBucket

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.s3.IBucket getAccessLogBucket()
        (experimental) The bucket to use for access logs from the Application Load Balancer.

        Default: - a new S3 bucket will be created

      • getAccessLogPrefix

        @Stability(Experimental)
@Nullable
default String getAccessLogPrefix()
        (experimental) The prefix to use for access logs from the Application Load Balancer.

        Default: - none

      • getApiCanarySchedule

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getApiCanarySchedule()
        (experimental) The frequency for running the api canaries.

        Default: - 5 minutes

      • getApiCanaryThreadCount

        @Stability(Experimental)
@Nullable
default Number getApiCanaryThreadCount()
        (experimental) The number of threads to run concurrently for the synthetic test.

        Default: - 20

      • getApiCanaryTimeout

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getApiCanaryTimeout()
        (experimental) The threshold for how long a api canary can take to run.

        Default: - no alarm is created for test duration

      • getApiTestSteps

        @Stability(Experimental)
@Nullable
default List<ApiTestStep> getApiTestSteps()
        (experimental) The steps to run in the canary.

        Default: - no synthetic test will be created

      • getApplicationName

        @Stability(Experimental)
@Nullable
default String getApplicationName()
        (experimental) The physical, human-readable name of the CodeDeploy Application.

        Default: an auto-generated name will be used

      • getDeploymentConfig

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.codedeploy.IEcsDeploymentConfig getDeploymentConfig()
        (experimental) The deployment configuration to use for the deployment group.

        Default: - EcsDeploymentConfig.ALL_AT_ONCE

      • getDeploymentGroupName

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

        Default: An auto-generated name will be used.

      • getDeploymentTimeout

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getDeploymentTimeout()
        (experimental) The timeout for a CodeDeploy deployment.

        Default: - 60 minutes

      • getDeregistrationDelay

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getDeregistrationDelay()
        (experimental) The amount of time for ELB to wait before changing the state of a deregistering target from 'draining' to 'unused'.

        Default: - 300 seconds

      • getHooks

        @Stability(Experimental)
@Nullable
default AppSpecHooks getHooks()
        (experimental) Optional lifecycle hooks.

        Default: - no lifecycle hooks

      • getResponseTimeAlarmThreshold

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getResponseTimeAlarmThreshold()
        (experimental) The threshold for response time alarm.

        Default: - no alarm will be created

      • getTargetHealthCheck

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.services.elasticloadbalancingv2.HealthCheck getTargetHealthCheck()
        (experimental) The healthcheck to configure on the Application Load Balancer target groups.

        Default: - no health check is configured

      • getTerminationWaitTime

        @Stability(Experimental)
@Nullable
default software.amazon.awscdk.Duration getTerminationWaitTime()
        (experimental) The time to wait before terminating the original (blue) task set.

        Default: - 10 minutes

      • getTestPort

        @Stability(Experimental)
@Nullable
default Number getTestPort()
        (experimental) The port to use for test traffic on the listener.

        Default: - listenerPort + 1