CfnService (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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.CfnService

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.604Z")
 @Stability(value=Stable)
public class CfnService
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ECS::Service`.

The AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.

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.*;
 CfnService cfnService = CfnService.Builder.create(this, "MyCfnService")
         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .base(123)
                 .capacityProvider("capacityProvider")
                 .weight(123)
                 .build()))
         .cluster("cluster")
         .deploymentConfiguration(DeploymentConfigurationProperty.builder()
                 .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")
         .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnService.AwsVpcConfigurationProperty` An object representing the networking details for a task or service.
`static class`	`CfnService.Builder` A fluent builder for `CfnService`.
`static interface`	`CfnService.CapacityProviderStrategyItemProperty` The details of a capacity provider strategy.
`static interface`	`CfnService.DeploymentCircuitBreakerProperty` > The deployment circuit breaker can only be used for services using the rolling update ( `ECS` ) deployment type.
`static interface`	`CfnService.DeploymentConfigurationProperty` The `DeploymentConfiguration` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`static interface`	`CfnService.DeploymentControllerProperty` The deployment controller to use for the service.
`static interface`	`CfnService.LoadBalancerProperty` The `LoadBalancer` property specifies details on a load balancer that is used with a service.
`static interface`	`CfnService.NetworkConfigurationProperty` The `NetworkConfiguration` property specifies an object representing the network configuration for a task or service.
`static interface`	`CfnService.PlacementConstraintProperty` The `PlacementConstraint` property specifies an object representing a constraint on task placement in the task definition.
`static interface`	`CfnService.PlacementStrategyProperty` The `PlacementStrategy` property specifies the task placement strategy for a task or service.
`static interface`	`CfnService.ServiceRegistryProperty` The `ServiceRegistry` property specifies details of 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.

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
	`CfnService(software.constructs.Construct scope, String id)` Create a new `AWS::ECS::Service`.
	`CfnService(software.constructs.Construct scope, String id, CfnServiceProps props)` Create a new `AWS::ECS::Service`.
`protected`	`CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnService(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrName()` The name of the Amazon ECS service, such as `sample-webapp` .
`String`	`getAttrServiceArn()` Not currently supported in AWS CloudFormation .
`Object`	`getCapacityProviderStrategy()` The capacity provider strategy to use for the service.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getCluster()` The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
`Object`	`getDeploymentConfiguration()` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`Object`	`getDeploymentController()` The deployment controller to use for the service.
`Number`	`getDesiredCount()` The number of instantiations of the specified task definition to place and keep running on your cluster.
`Object`	`getEnableEcsManagedTags()` Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
`Object`	`getEnableExecuteCommand()` Determines whether the execute command functionality is enabled for the service.
`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.
`String`	`getLaunchType()` The launch type on which to run your service.
`Object`	`getLoadBalancers()` A list of load balancer objects to associate with the service.
`Object`	`getNetworkConfiguration()` The network configuration for the service.
`Object`	`getPlacementConstraints()` An array of placement constraint objects to use for tasks in your service.
`Object`	`getPlacementStrategies()` The placement strategy objects to use for tasks in your service.
`String`	`getPlatformVersion()` The platform version that your tasks in the service are running on.
`String`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`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.
`String`	`getSchedulingStrategy()` The scheduling strategy to use for the service.
`String`	`getServiceName()` The name of your service.
`Object`	`getServiceRegistries()` The details of the service discovery registry to associate with this service.
`TagManager`	`getTags()` The metadata that you apply to the service to help you categorize and organize them.
`String`	`getTaskDefinition()` The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setCapacityProviderStrategy(IResolvable value)` The capacity provider strategy to use for the service.
`void`	`setCapacityProviderStrategy(List<Object> value)` The capacity provider strategy to use for the service.
`void`	`setCluster(String value)` The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
`void`	`setDeploymentConfiguration(CfnService.DeploymentConfigurationProperty value)` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`void`	`setDeploymentConfiguration(IResolvable value)` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`void`	`setDeploymentController(CfnService.DeploymentControllerProperty value)` The deployment controller to use for the service.
`void`	`setDeploymentController(IResolvable value)` The deployment controller to use for the service.
`void`	`setDesiredCount(Number value)` The number of instantiations of the specified task definition to place and keep running on your cluster.
`void`	`setEnableEcsManagedTags(Boolean value)` Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
`void`	`setEnableEcsManagedTags(IResolvable value)` Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
`void`	`setEnableExecuteCommand(Boolean value)` Determines whether the execute command functionality is enabled for the service.
`void`	`setEnableExecuteCommand(IResolvable value)` Determines whether the execute command functionality is enabled for the service.
`void`	`setHealthCheckGracePeriodSeconds(Number value)` 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.
`void`	`setLaunchType(String value)` The launch type on which to run your service.
`void`	`setLoadBalancers(IResolvable value)` A list of load balancer objects to associate with the service.
`void`	`setLoadBalancers(List<Object> value)` A list of load balancer objects to associate with the service.
`void`	`setNetworkConfiguration(CfnService.NetworkConfigurationProperty value)` The network configuration for the service.
`void`	`setNetworkConfiguration(IResolvable value)` The network configuration for the service.
`void`	`setPlacementConstraints(IResolvable value)` An array of placement constraint objects to use for tasks in your service.
`void`	`setPlacementConstraints(List<Object> value)` An array of placement constraint objects to use for tasks in your service.
`void`	`setPlacementStrategies(IResolvable value)` The placement strategy objects to use for tasks in your service.
`void`	`setPlacementStrategies(List<Object> value)` The placement strategy objects to use for tasks in your service.
`void`	`setPlatformVersion(String value)` The platform version that your tasks in the service are running on.
`void`	`setPropagateTags(String value)` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`void`	`setRole(String value)` 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.
`void`	`setSchedulingStrategy(String value)` The scheduling strategy to use for the service.
`void`	`setServiceName(String value)` The name of your service.
`void`	`setServiceRegistries(IResolvable value)` The details of the service discovery registry to associate with this service.
`void`	`setServiceRegistries(List<Object> value)` The details of the service discovery registry to associate with this service.
`void`	`setTaskDefinition(String value)` The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service.

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
  - CfnService
```
protected CfnService(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnService
```
protected CfnService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnService
```
@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @Nullable
                                           CfnServiceProps props)
```
    Create a new `AWS::ECS::Service`.
    
    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.
  - CfnService
```
@Stability(value=Stable)
public CfnService(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id)
```
    Create a new `AWS::ECS::Service`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. 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.
  - getAttrName
```
@Stability(value=Stable)
 @NotNull
public String getAttrName()
```
    The name of the Amazon ECS service, such as `sample-webapp` .
  - getAttrServiceArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrServiceArn()
```
    Not currently supported in AWS CloudFormation .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager 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: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
  - getCapacityProviderStrategy
```
@Stability(value=Stable)
 @Nullable
public Object getCapacityProviderStrategy()
```
    The capacity provider strategy to use for the service.
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide.
    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.
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    To use an AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - setCapacityProviderStrategy
```
@Stability(value=Stable)
public void setCapacityProviderStrategy(@Nullable
                                                                 IResolvable value)
```
    The capacity provider strategy to use for the service.
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide.
    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.
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    To use an AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - setCapacityProviderStrategy
```
@Stability(value=Stable)
public void setCapacityProviderStrategy(@Nullable
                                                                 List<Object> value)
```
    The capacity provider strategy to use for the service.
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide.
    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.
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    To use an AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
  - getCluster
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setCluster
```
@Stability(value=Stable)
public void setCluster(@Nullable
                                                String value)
```
    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.
  - getDeploymentConfiguration
```
@Stability(value=Stable)
 @Nullable
public Object getDeploymentConfiguration()
```
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
  - setDeploymentConfiguration
```
@Stability(value=Stable)
public void setDeploymentConfiguration(@Nullable
                                                                CfnService.DeploymentConfigurationProperty value)
```
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
  - setDeploymentConfiguration
```
@Stability(value=Stable)
public void setDeploymentConfiguration(@Nullable
                                                                IResolvable value)
```
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
  - getDeploymentController
```
@Stability(value=Stable)
 @Nullable
public Object getDeploymentController()
```
    The deployment controller to use for the service.
    If no deployment controller is specified, the default value of ECS is used.
  - setDeploymentController
```
@Stability(value=Stable)
public void setDeploymentController(@Nullable
                                                             CfnService.DeploymentControllerProperty value)
```
    The deployment controller to use for the service.
    If no deployment controller is specified, the default value of ECS is used.
  - setDeploymentController
```
@Stability(value=Stable)
public void setDeploymentController(@Nullable
                                                             IResolvable value)
```
    The deployment controller to use for the service.
    If no deployment controller is specified, the default value of ECS is used.
  - getDesiredCount
```
@Stability(value=Stable)
 @Nullable
public Number getDesiredCount()
```
    The number of instantiations of the specified task definition to place and keep running on your cluster.
    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.
  - setDesiredCount
```
@Stability(value=Stable)
public void setDesiredCount(@Nullable
                                                     Number value)
```
    The number of instantiations of the specified task definition to place and keep running on your cluster.
    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.
  - getEnableEcsManagedTags
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setEnableEcsManagedTags
```
@Stability(value=Stable)
public void setEnableEcsManagedTags(@Nullable
                                                             Boolean value)
```
    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 .
  - setEnableEcsManagedTags
```
@Stability(value=Stable)
public void setEnableEcsManagedTags(@Nullable
                                                             IResolvable value)
```
    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 .
  - getEnableExecuteCommand
```
@Stability(value=Stable)
 @Nullable
public Object getEnableExecuteCommand()
```
    Determines whether the execute command functionality is enabled for the service.
    If true , the execute command functionality is enabled for all containers in tasks as part of the service.
  - setEnableExecuteCommand
```
@Stability(value=Stable)
public void setEnableExecuteCommand(@Nullable
                                                             Boolean value)
```
    Determines whether the execute command functionality is enabled for the service.
    If true , the execute command functionality is enabled for all containers in tasks as part of the service.
  - setEnableExecuteCommand
```
@Stability(value=Stable)
public void setEnableExecuteCommand(@Nullable
                                                             IResolvable value)
```
    Determines whether the execute command functionality is enabled for the service.
    If true , the execute command functionality is enabled for all containers in tasks as part of the service.
  - getHealthCheckGracePeriodSeconds
```
@Stability(value=Stable)
 @Nullable
public 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 recomend that you use the startPeriod in the task definition healtch 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.
  - setHealthCheckGracePeriodSeconds
```
@Stability(value=Stable)
public void setHealthCheckGracePeriodSeconds(@Nullable
                                                                      Number value)
```
    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 recomend that you use the startPeriod in the task definition healtch 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.
  - getLaunchType
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setLaunchType
```
@Stability(value=Stable)
public void setLaunchType(@Nullable
                                                   String value)
```
    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 .
  - getLoadBalancers
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setLoadBalancers
```
@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      IResolvable value)
```
    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 .
  - setLoadBalancers
```
@Stability(value=Stable)
public void setLoadBalancers(@Nullable
                                                      List<Object> value)
```
    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 .
  - getNetworkConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setNetworkConfiguration
```
@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             CfnService.NetworkConfigurationProperty value)
```
    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 .
  - setNetworkConfiguration
```
@Stability(value=Stable)
public void setNetworkConfiguration(@Nullable
                                                             IResolvable value)
```
    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 .
  - getPlacementConstraints
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setPlacementConstraints
```
@Stability(value=Stable)
public void setPlacementConstraints(@Nullable
                                                             IResolvable value)
```
    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.
  - setPlacementConstraints
```
@Stability(value=Stable)
public void setPlacementConstraints(@Nullable
                                                             List<Object> value)
```
    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.
  - getPlacementStrategies
```
@Stability(value=Stable)
 @Nullable
public Object getPlacementStrategies()
```
    The placement strategy objects to use for tasks in your service.
    You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
  - setPlacementStrategies
```
@Stability(value=Stable)
public void setPlacementStrategies(@Nullable
                                                            IResolvable value)
```
    The placement strategy objects to use for tasks in your service.
    You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
  - setPlacementStrategies
```
@Stability(value=Stable)
public void setPlacementStrategies(@Nullable
                                                            List<Object> value)
```
    The placement strategy objects to use for tasks in your service.
    You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
  - getPlatformVersion
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setPlatformVersion
```
@Stability(value=Stable)
public void setPlatformVersion(@Nullable
                                                        String value)
```
    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 .
  - getPropagateTags
```
@Stability(value=Stable)
 @Nullable
public String getPropagateTags()
```
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
  - setPropagateTags
```
@Stability(value=Stable)
public void setPropagateTags(@Nullable
                                                      String value)
```
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
  - getRole
```
@Stability(value=Stable)
 @Nullable
public 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 .
  - setRole
```
@Stability(value=Stable)
public void setRole(@Nullable
                                             String value)
```
    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 .
  - getSchedulingStrategy
```
@Stability(value=Stable)
 @Nullable
public String getSchedulingStrategy()
```
    The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) .
    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.
  - setSchedulingStrategy
```
@Stability(value=Stable)
public void setSchedulingStrategy(@Nullable
                                                           String value)
```
    The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) .
    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.
  - getServiceName
```
@Stability(value=Stable)
 @Nullable
public 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.
  - setServiceName
```
@Stability(value=Stable)
public void setServiceName(@Nullable
                                                    String value)
```
    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.
  - getServiceRegistries
```
@Stability(value=Stable)
 @Nullable
public Object getServiceRegistries()
```
    The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .
    
    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
  - setServiceRegistries
```
@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          IResolvable value)
```
    The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .
    
    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
  - setServiceRegistries
```
@Stability(value=Stable)
public void setServiceRegistries(@Nullable
                                                          List<Object> value)
```
    The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .
    
    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
  - getTaskDefinition
```
@Stability(value=Stable)
 @Nullable
public String getTaskDefinition()
```
    The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service.
    The revision is required in order for the resource to stabilize.
    A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.
  - setTaskDefinition
```
@Stability(value=Stable)
public void setTaskDefinition(@Nullable
                                                       String value)
```
    The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service.
    The revision is required in order for the resource to stabilize.
    A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.

Class CfnService

Nested Class Summary

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

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnService

CfnService

CfnService

CfnService

Method Detail

inspect

renderProperties

getAttrName

getAttrServiceArn

getCfnProperties

getTags

getCapacityProviderStrategy

setCapacityProviderStrategy

setCapacityProviderStrategy

getCluster

setCluster

getDeploymentConfiguration

setDeploymentConfiguration

setDeploymentConfiguration

getDeploymentController

setDeploymentController

setDeploymentController

getDesiredCount

setDesiredCount

getEnableEcsManagedTags

setEnableEcsManagedTags

setEnableEcsManagedTags

getEnableExecuteCommand

setEnableExecuteCommand

setEnableExecuteCommand

getHealthCheckGracePeriodSeconds

setHealthCheckGracePeriodSeconds

getLaunchType

setLaunchType

getLoadBalancers

setLoadBalancers

setLoadBalancers

getNetworkConfiguration

setNetworkConfiguration

setNetworkConfiguration

getPlacementConstraints

setPlacementConstraints

setPlacementConstraints

getPlacementStrategies

setPlacementStrategies

setPlacementStrategies

getPlatformVersion

setPlatformVersion

getPropagateTags

setPropagateTags

getRole

setRole

getSchedulingStrategy

setSchedulingStrategy

getServiceName

setServiceName

getServiceRegistries

setServiceRegistries

setServiceRegistries

getTaskDefinition

setTaskDefinition