Package software.amazon.awscdk.services.ecs

Interface CfnTaskSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTaskSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.237Z")
@Stability(Stable)
public interface CfnTaskSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTaskSet.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 CfnTaskSetProps cfnTaskSetProps = CfnTaskSetProps.builder()
         .cluster("cluster")
         .service("service")
         .taskDefinition("taskDefinition")
         // the properties below are optional
         .externalId("externalId")
         .launchType("launchType")
         .loadBalancers(List.of(LoadBalancerProperty.builder()
                 .containerName("containerName")
                 .containerPort(123)
                 .loadBalancerName("loadBalancerName")
                 .targetGroupArn("targetGroupArn")
                 .build()))
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .awsVpcConfiguration(AwsVpcConfigurationProperty.builder()
                         .subnets(List.of("subnets"))
                         // the properties below are optional
                         .assignPublicIp("assignPublicIp")
                         .securityGroups(List.of("securityGroups"))
                         .build())
                 .build())
         .platformVersion("platformVersion")
         .scale(ScaleProperty.builder()
                 .unit("unit")
                 .value(123)
                 .build())
         .serviceRegistries(List.of(ServiceRegistryProperty.builder()
                 .containerName("containerName")
                 .containerPort(123)
                 .port(123)
                 .registryArn("registryArn")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTaskSetProps.Builder	builder()
String	getCluster()	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
default String	getExternalId()	An optional non-unique tag that identifies this task set in external systems.
default String	getLaunchType()	The launch type that new tasks in the task set uses.
default Object	getLoadBalancers()	A load balancer object representing the load balancer to use with the task set.
default Object	getNetworkConfiguration()	The network configuration for the task set.
default String	getPlatformVersion()	The platform version that the tasks in the task set uses.
default Object	getScale()	A floating-point percentage of your desired number of tasks to place and keep running in the task set.
String	getService()	The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
default Object	getServiceRegistries()	The details of the service discovery registries to assign to this task set.
String	getTaskDefinition()	The task definition for the tasks in the task set to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCluster

@Stability(Stable)
@NotNull
String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

getService

@Stability(Stable)
@NotNull
String getService()

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

getTaskDefinition

@Stability(Stable)
@NotNull
String getTaskDefinition()

The task definition for the tasks in the task set to use.

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

An optional non-unique tag that identifies this task set in external systems.

If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

getLaunchType

@Stability(Stable)
@Nullable
default String getLaunchType()

The launch type that new tasks in the task set uses.

For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

getLoadBalancers

@Stability(Stable)
@Nullable
default Object getLoadBalancers()

A load balancer object representing the load balancer to use with the task set.

The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

getNetworkConfiguration

@Stability(Stable)
@Nullable
default Object getNetworkConfiguration()

The network configuration for the task set.

getPlatformVersion

@Stability(Stable)
@Nullable
default String getPlatformVersion()

The platform version that the tasks in the task set uses.

A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

getScale

@Stability(Stable)
@Nullable
default Object getScale()

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

getServiceRegistries

@Stability(Stable)
@Nullable
default Object getServiceRegistries()

The details of the service discovery registries to assign to this task set.

For more information, see Service discovery .

builder

@Stability(Stable)
static CfnTaskSetProps.Builder builder()

Returns:

a CfnTaskSetProps.Builder of CfnTaskSetProps