software.amazon.awscdk.services.ecs

Interface FargateServiceProps

All Superinterfaces:

BaseServiceOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:33.809Z")
 @Stability(value=Stable)
public interface FargateServiceProps
extends software.amazon.jsii.JsiiSerializable, BaseServiceOptions

The properties for defining a service using the Fargate launch type.

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 Vpc vpc;
 FargateService service = FargateService.Builder.create(this, "Service").cluster(cluster).taskDefinition(taskDefinition).build();
 ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "LB").vpc(vpc).internetFacing(true).build();
 ApplicationListener listener = lb.addListener("Listener", BaseApplicationListenerProps.builder().port(80).build());
 service.registerLoadBalancerTargets(EcsTarget.builder()
         .containerName("web")
         .containerPort(80)
         .newTargetGroupId("ECS")
         .listener(ListenerConfig.applicationListener(listener, AddApplicationTargetsProps.builder()
                 .protocol(ApplicationProtocol.HTTPS)
                 .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FargateServiceProps.Builder A builder for FargateServiceProps
static class	FargateServiceProps.Jsii$Proxy An implementation for FargateServiceProps

Method Summary

Modifier and Type	Method and Description
static FargateServiceProps.Builder	builder()
default Boolean	getAssignPublicIp() Specifies whether the task's elastic network interface receives a public IP address.
default FargatePlatformVersion	getPlatformVersion() The platform version on which to run your service.
default ISecurityGroup	getSecurityGroup() Deprecated. use securityGroups instead.
default List<ISecurityGroup>	getSecurityGroups() The security groups to associate with the service.
TaskDefinition	getTaskDefinition() The task definition to use for tasks in the service.
default SubnetSelection	getVpcSubnets() The subnets to associate with the service.

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseServiceOptions

getCapacityProviderStrategies, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentController, getDesiredCount, getEnableECSManagedTags, getEnableExecuteCommand, getHealthCheckGracePeriod, getMaxHealthyPercent, getMinHealthyPercent, getPropagateTags, getPropagateTaskTagsFrom, getServiceName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTaskDefinition

@Stability(value=Stable)
 @NotNull
TaskDefinition getTaskDefinition()

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

getAssignPublicIp

@Stability(value=Stable)
 @Nullable
default Boolean getAssignPublicIp()

Specifies whether the task's elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

Default: false

getPlatformVersion

@Stability(value=Stable)
 @Nullable
default FargatePlatformVersion getPlatformVersion()

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Default: Latest

getSecurityGroup

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default ISecurityGroup getSecurityGroup()

Deprecated. use securityGroups instead.

(deprecated) The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

Default: - A new security group is created.

getSecurityGroups

@Stability(value=Stable)
 @Nullable
default List<ISecurityGroup> getSecurityGroups()

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

Default: - A new security group is created.

getVpcSubnets

@Stability(value=Stable)
 @Nullable
default SubnetSelection getVpcSubnets()

The subnets to associate with the service.

Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

builder

@Stability(value=Stable)
static FargateServiceProps.Builder builder()

Specified by:

builder in interface BaseServiceOptions

Returns:

a FargateServiceProps.Builder of FargateServiceProps