Interface CfnTaskSetProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTaskSetProps.Jsii$Proxy
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) .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())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTaskSetProps
static final class
An implementation forCfnTaskSetProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnTaskSetProps.Builder
builder()
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.default String
An optional non-unique tag that identifies this task set in external systems.default String
The launch type that new tasks in the task set uses.default Object
A load balancer object representing the load balancer to use with the task set.default Object
The network configuration for the task set.default String
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.The short name or full Amazon Resource Name (ARN) of the service to create the task set in.default Object
The details of the service discovery registries to assign to this task set.getTags()
The metadata that you apply to the task set to help you categorize and organize them.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
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.- See Also:
-
getService
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.- See Also:
-
getTaskDefinition
The task definition for the tasks in the task set to use.If a revision isn't specified, the latest
ACTIVE
revision is used.- See Also:
-
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.- See Also:
-
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, thecapacityProviderStrategy
parameter must be omitted.- See Also:
-
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.
- See Also:
-
getNetworkConfiguration
The network configuration for the task set.- See Also:
-
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.- See Also:
-
getScale
A floating-point percentage of your desired number of tasks to place and keep running in the task set.- See Also:
-
getServiceRegistries
The details of the service discovery registries to assign to this task set.For more information, see Service discovery .
- See Also:
-
getTags
The metadata that you apply to the task set to help you categorize and organize them.Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
- See Also:
-
builder
- Returns:
- a
CfnTaskSetProps.Builder
ofCfnTaskSetProps
-