software.amazon.awscdk.services.ecs

Class CfnTaskSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ecs.CfnTaskSet

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.668Z")
 @Stability(value=Stable)
public class CfnTaskSet
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ECS::TaskSet`.

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide .

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.*;
 CfnTaskSet cfnTaskSet = CfnTaskSet.Builder.create(this, "MyCfnTaskSet")
         .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	Class and Description
static interface	CfnTaskSet.AwsVpcConfigurationProperty The networking details for a task.
static class	CfnTaskSet.Builder A fluent builder for CfnTaskSet.
static interface	CfnTaskSet.LoadBalancerProperty Details on the load balancer or load balancers to use with a task set.
static interface	CfnTaskSet.NetworkConfigurationProperty The network configuration for a task.
static interface	CfnTaskSet.ScaleProperty A floating-point percentage of the desired number of tasks to place and keep running in the task set.
static interface	CfnTaskSet.ServiceRegistryProperty The details for the service registry.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTaskSet(software.constructs.Construct scope, String id, CfnTaskSetProps props) Create a new `AWS::ECS::TaskSet`.
protected	CfnTaskSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTaskSet(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID of the task set.
protected Map<String,Object>	getCfnProperties()
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
String	getExternalId() An optional non-unique tag that identifies this task set in external systems.
String	getLaunchType() The launch type that new tasks in the task set uses.
Object	getLoadBalancers() A load balancer object representing the load balancer to use with the task set.
Object	getNetworkConfiguration() The network configuration for the task set.
String	getPlatformVersion() The platform version that the tasks in the task set uses.
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.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCluster(String value) The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
void	setExternalId(String value) An optional non-unique tag that identifies this task set in external systems.
void	setLaunchType(String value) The launch type that new tasks in the task set uses.
void	setLoadBalancers(IResolvable value) A load balancer object representing the load balancer to use with the task set.
void	setLoadBalancers(List<Object> value) A load balancer object representing the load balancer to use with the task set.
void	setNetworkConfiguration(CfnTaskSet.NetworkConfigurationProperty value) The network configuration for the task set.
void	setNetworkConfiguration(IResolvable value) The network configuration for the task set.
void	setPlatformVersion(String value) The platform version that the tasks in the task set uses.
void	setScale(CfnTaskSet.ScaleProperty value) A floating-point percentage of your desired number of tasks to place and keep running in the task set.
void	setScale(IResolvable value) A floating-point percentage of your desired number of tasks to place and keep running in the task set.
void	setService(String value) The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
void	setServiceRegistries(IResolvable value) The details of the service discovery registries to assign to this task set.
void	setServiceRegistries(List<Object> value) The details of the service discovery registries to assign to this task set.
void	setTaskDefinition(String value) The task definition for the tasks in the task set to use.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTaskSet

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

CfnTaskSet

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

CfnTaskSet

@Stability(value=Stable)
public CfnTaskSet(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnTaskSetProps props)

Create a new `AWS::ECS::TaskSet`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the task set.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCluster

@Stability(value=Stable)
 @NotNull
public String getCluster()

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

setCluster

@Stability(value=Stable)
public void setCluster(@NotNull
                                                String value)

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

getService

@Stability(value=Stable)
 @NotNull
public String getService()

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

setService

@Stability(value=Stable)
public void setService(@NotNull
                                                String value)

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

getTaskDefinition

@Stability(value=Stable)
 @NotNull
public String getTaskDefinition()

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

setTaskDefinition

@Stability(value=Stable)
public void setTaskDefinition(@NotNull
                                                       String value)

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

getExternalId

@Stability(value=Stable)
 @Nullable
public 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.

setExternalId

@Stability(value=Stable)
public void setExternalId(@Nullable
                                                   String value)

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(value=Stable)
 @Nullable
public 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.

setLaunchType

@Stability(value=Stable)
public void setLaunchType(@Nullable
                                                   String value)

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(value=Stable)
 @Nullable
public 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.

setLoadBalancers

@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      IResolvable value)

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.

setLoadBalancers

@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      List<Object> value)

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(value=Stable)
 @Nullable
public Object getNetworkConfiguration()

The network configuration for the task set.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             CfnTaskSet.NetworkConfigurationProperty value)

The network configuration for the task set.

setNetworkConfiguration

@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             IResolvable value)

The network configuration for the task set.

getPlatformVersion

@Stability(value=Stable)
 @Nullable
public 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.

setPlatformVersion

@Stability(value=Stable)
public void setPlatformVersion(@Nullable
                                                        String value)

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(value=Stable)
 @Nullable
public Object getScale()

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

setScale

@Stability(value=Stable)
public void setScale(@Nullable
                                              CfnTaskSet.ScaleProperty value)

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

setScale

@Stability(value=Stable)
public void setScale(@Nullable
                                              IResolvable value)

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

getServiceRegistries

@Stability(value=Stable)
 @Nullable
public Object getServiceRegistries()

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

For more information, see Service discovery .

setServiceRegistries

@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          IResolvable value)

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

For more information, see Service discovery .

setServiceRegistries

@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          List<Object> value)

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

For more information, see Service discovery .