Package software.amazon.awscdk.services.ecs

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:07.340Z")
@Stability(Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnService.

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.*;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .base(123)
                 .capacityProvider("capacityProvider")
                 .weight(123)
                 .build()))
         .cluster("cluster")
         .deploymentConfiguration(DeploymentConfigurationProperty.builder()
                 .alarms(DeploymentAlarmsProperty.builder()
                         .alarmNames(List.of("alarmNames"))
                         .enable(false)
                         .rollback(false)
                         .build())
                 .deploymentCircuitBreaker(DeploymentCircuitBreakerProperty.builder()
                         .enable(false)
                         .rollback(false)
                         .build())
                 .maximumPercent(123)
                 .minimumHealthyPercent(123)
                 .build())
         .deploymentController(DeploymentControllerProperty.builder()
                 .type("type")
                 .build())
         .desiredCount(123)
         .enableEcsManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriodSeconds(123)
         .launchType("launchType")
         .loadBalancers(List.of(LoadBalancerProperty.builder()
                 .containerPort(123)
                 // the properties below are optional
                 .containerName("containerName")
                 .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())
         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .expression("expression")
                 .build()))
         .placementStrategies(List.of(PlacementStrategyProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .field("field")
                 .build()))
         .platformVersion("platformVersion")
         .propagateTags("propagateTags")
         .role("role")
         .schedulingStrategy("schedulingStrategy")
         .serviceConnectConfiguration(ServiceConnectConfigurationProperty.builder()
                 .enabled(false)
                 // the properties below are optional
                 .logConfiguration(LogConfigurationProperty.builder()
                         .logDriver("logDriver")
                         .options(Map.of(
                                 "optionsKey", "options"))
                         .secretOptions(List.of(SecretProperty.builder()
                                 .name("name")
                                 .valueFrom("valueFrom")
                                 .build()))
                         .build())
                 .namespace("namespace")
                 .services(List.of(ServiceConnectServiceProperty.builder()
                         .portName("portName")
                         // the properties below are optional
                         .clientAliases(List.of(ServiceConnectClientAliasProperty.builder()
                                 .port(123)
                                 // the properties below are optional
                                 .dnsName("dnsName")
                                 .build()))
                         .discoveryName("discoveryName")
                         .ingressPortOverride(123)
                         .build()))
                 .build())
         .serviceName("serviceName")
         .serviceRegistries(List.of(ServiceRegistryProperty.builder()
                 .containerName("containerName")
                 .containerPort(123)
                 .port(123)
                 .registryArn("registryArn")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskDefinition("taskDefinition")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServiceProps.Builder	builder()
default Object	getCapacityProviderStrategy()	The capacity provider strategy to use for the service.
default String	getCluster()	The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
default Object	getDeploymentConfiguration()	Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
default Object	getDeploymentController()	The deployment controller to use for the service.
default Number	getDesiredCount()	The number of instantiations of the specified task definition to place and keep running in your service.
default Object	getEnableEcsManagedTags()	Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
default Object	getEnableExecuteCommand()	Determines whether the execute command functionality is turned on for the service.
default Number	getHealthCheckGracePeriodSeconds()	The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
default String	getLaunchType()	The launch type on which to run your service.
default Object	getLoadBalancers()	A list of load balancer objects to associate with the service.
default Object	getNetworkConfiguration()	The network configuration for the service.
default Object	getPlacementConstraints()	An array of placement constraint objects to use for tasks in your service.
default Object	getPlacementStrategies()	The placement strategy objects to use for tasks in your service.
default String	getPlatformVersion()	The platform version that your tasks in the service are running on.
default String	getPropagateTags()	Specifies whether to propagate the tags from the task definition to the task.
default String	getRole()	The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf.
default String	getSchedulingStrategy()	The scheduling strategy to use for the service.
default Object	getServiceConnectConfiguration()	The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
default String	getServiceName()	The name of your service.
default Object	getServiceRegistries()	The details of the service discovery registry to associate with this service.
default List<CfnTag>	getTags()	The metadata that you apply to the service to help you categorize and organize them.
default String	getTaskDefinition()	The family and revision ( family:revision ) or full ARN of the task definition to run in your service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCapacityProviderStrategy

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

The capacity provider strategy to use for the service.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

A capacity provider strategy may contain a maximum of 6 capacity providers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy

getCluster

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

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.

If you do not specify a cluster, the default cluster is assumed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-cluster

getDeploymentConfiguration

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

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentconfiguration

getDeploymentController

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

The deployment controller to use for the service.

If no deployment controller is specified, the default value of ECS is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-deploymentcontroller

getDesiredCount

@Stability(Stable)
@Nullable
default Number getDesiredCount()

The number of instantiations of the specified task definition to place and keep running in your service.

For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.

For existing services, if a desired count is not specified, it is omitted from the operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-desiredcount

getEnableEcsManagedTags

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

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide .

When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableecsmanagedtags

getEnableExecuteCommand

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

Determines whether the execute command functionality is turned on for the service.

If true , the execute command functionality is turned on for all containers in tasks as part of the service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-enableexecutecommand

getHealthCheckGracePeriodSeconds

@Stability(Stable)
@Nullable
default Number getHealthCheckGracePeriodSeconds()

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.

If you do not use an Elastic Load Balancing, we recommend that you use the startPeriod in the task definition health check parameters. For more information, see Health check .

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-healthcheckgraceperiodseconds

getLaunchType

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

The launch type on which to run your service.

For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-launchtype

getLoadBalancers

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

A list of load balancer objects to associate with the service.

If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-loadbalancers

getNetworkConfiguration

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

The network configuration for the service.

This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-networkconfiguration

getPlacementConstraints

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

An array of placement constraint objects to use for tasks in your service.

You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementconstraints

getPlacementStrategies

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

The placement strategy objects to use for tasks in your service.

You can specify a maximum of 5 strategy rules for each service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-placementstrategies

getPlatformVersion

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

The platform version that your tasks in the service are running on.

A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .

Default: - "LATEST"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-platformversion

getPropagateTags

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

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

The default is NONE .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-propagatetags

getRole

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

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf.

This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .

If your specified role has a path other than / , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-role

getSchedulingStrategy

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

The scheduling strategy to use for the service. For more information, see Services .

There are two service scheduler strategies available:

• REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
• DAEMON -The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-schedulingstrategy

getServiceConnectConfiguration

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

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceconnectconfiguration

getServiceName

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

The name of your service.

Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-servicename

getServiceRegistries

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

The details of the service discovery registry to associate with this service. For more information, see Service discovery .

Each service may be associated with one service registry. Multiple service registries for each service isn't supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-serviceregistries

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The metadata that you apply to the service to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-tags

getTaskDefinition

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

The family and revision ( family:revision ) or full ARN of the task definition to run in your service.

If a revision isn't specified, the latest ACTIVE revision is used.

A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.

For more information about deployment types, see Amazon ECS deployment types .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-taskdefinition

builder

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

Returns:

a CfnServiceProps.Builder of CfnServiceProps