Package software.amazon.awscdk.services.ecs

Class FargateService

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.ecs.BaseService
software.amazon.awscdk.services.ecs.FargateService
All Implemented Interfaces:
IResource, IConnectable, IBaseService, IFargateService, IService, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:01.096Z") @Stability(Stable) public class FargateService extends BaseService implements IFargateService
This creates a service using the Fargate launch type on an ECS cluster.

Example: 

 import software.amazon.awscdk.services.cloudwatch.*;
 Cluster cluster;
 TaskDefinition taskDefinition;
 Alarm elbAlarm;
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .deploymentAlarms(DeploymentAlarmConfig.builder()
                 .alarmNames(List.of(elbAlarm.getAlarmName()))
                 .behavior(AlarmBehavior.ROLLBACK_ON_ALARM)
                 .build())
         .build();
 // Defining a deployment alarm after the service has been created
 String cpuAlarmName = "MyCpuMetricAlarm";
 Alarm.Builder.create(this, "CPUAlarm")
         .alarmName(cpuAlarmName)
         .metric(service.metricCpuUtilization())
         .evaluationPeriods(2)
         .threshold(80)
         .build();
 service.enableDeploymentAlarms(List.of(cpuAlarmName), DeploymentAlarmOptions.builder()
         .behavior(AlarmBehavior.FAIL_ON_ALARM)
         .build());

  • Constructor Details

    • FargateService

      protected FargateService(software.amazon.jsii.JsiiObjectRef objRef)

    • FargateService

      protected FargateService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • FargateService

      @Stability(Stable) public FargateService(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull FargateServiceProps props)
      Constructs a new instance of the FargateService class.

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

  • Method Details

    • fromFargateServiceArn

      @Stability(Stable) @NotNull public static IFargateService fromFargateServiceArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String fargateServiceArn)
      Imports from the specified service ARN.

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

    • fromFargateServiceAttributes

      @Stability(Stable) @NotNull public static IBaseService fromFargateServiceAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull FargateServiceAttributes attrs)
      Imports from the specified service attributes.

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