software.amazon.awscdk.services.ecs

Interface Ec2ServiceProps

All Superinterfaces:

BaseServiceOptions

All Known Implementing Classes:

Ec2ServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-21T22:31:09.662Z")
public interface Ec2ServiceProps
extends BaseServiceOptions

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

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 Vpc vpc;
 Ec2Service service = Ec2Service.Builder.create(this, "Service").cluster(cluster).taskDefinition(taskDefinition).build();
 LoadBalancer lb = LoadBalancer.Builder.create(this, "LB").vpc(vpc).build();
 lb.addListener(LoadBalancerListener.builder().externalPort(80).build());
 lb.addTarget(service.loadBalancerTarget(LoadBalancerTargetOptions.builder()
         .containerName("MyContainer")
         .containerPort(80)
         .build()));
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static Ec2ServiceProps.Builder	builder()
default java.lang.Boolean	getAssignPublicIp() Specifies whether the task's elastic network interface receives a public IP address.
default java.lang.Boolean	getDaemon() Specifies whether the service will use the daemon scheduling strategy.
default java.util.List<PlacementConstraint>	getPlacementConstraints() The placement constraints to use for tasks in the service.
default java.util.List<PlacementStrategy>	getPlacementStrategies() The placement strategies to use for tasks in the service.
default ISecurityGroup	getSecurityGroup() Deprecated. use securityGroups instead.
default java.util.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

Method Detail

getTaskDefinition

TaskDefinition getTaskDefinition()

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

getAssignPublicIp

default java.lang.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.

This property is only used for tasks that use the awsvpc network mode.

Default: false

getDaemon

default java.lang.Boolean getDaemon()

Specifies whether the service will use the daemon scheduling strategy.

If true, the service scheduler deploys exactly one task on each container instance in your cluster.

When you are using this strategy, do not specify a desired number of tasks orany task placement strategies.

Default: false

getPlacementConstraints

default java.util.List<PlacementConstraint> getPlacementConstraints()

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Default: - No constraints.

getPlacementStrategies

default java.util.List<PlacementStrategy> getPlacementStrategies()

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Default: - No strategies.

getSecurityGroup

@Deprecated
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.

This property is only used for tasks that use the awsvpc network mode.

Default: - A new security group is created.

getSecurityGroups

default java.util.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.

This property is only used for tasks that use the awsvpc network mode.

Default: - A new security group is created.

getVpcSubnets

default SubnetSelection getVpcSubnets()

The subnets to associate with the service.

This property is only used for tasks that use the awsvpc network mode.

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

builder

static Ec2ServiceProps.Builder builder()

Specified by:

builder in interface BaseServiceOptions

Returns:

a Ec2ServiceProps.Builder of Ec2ServiceProps