Class CfnService

A CloudFormation AWS::ECS::Service.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnService
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class CfnService : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnService
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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.

The stack update fails if you change any properties that require replacement and at least one Amazon ECS Service Connect ServiceConnectService is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace. > Starting April 15, 2023, AWS ; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS , or Amazon EC2 . However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.

CloudformationResource: AWS::ECS::Service

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

var cfnService = new CfnService(this, "MyCfnService", new CfnServiceProps {
    CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
        Base = 123,
        CapacityProvider = "capacityProvider",
        Weight = 123
    } },
    Cluster = "cluster",
    DeploymentConfiguration = new DeploymentConfigurationProperty {
        Alarms = new DeploymentAlarmsProperty {
            AlarmNames = new [] { "alarmNames" },
            Enable = false,
            Rollback = false
        },
        DeploymentCircuitBreaker = new DeploymentCircuitBreakerProperty {
            Enable = false,
            Rollback = false
        },
        MaximumPercent = 123,
        MinimumHealthyPercent = 123
    },
    DeploymentController = new DeploymentControllerProperty {
        Type = "type"
    },
    DesiredCount = 123,
    EnableEcsManagedTags = false,
    EnableExecuteCommand = false,
    HealthCheckGracePeriodSeconds = 123,
    LaunchType = "launchType",
    LoadBalancers = new [] { new LoadBalancerProperty {
        ContainerPort = 123,

        // the properties below are optional
        ContainerName = "containerName",
        LoadBalancerName = "loadBalancerName",
        TargetGroupArn = "targetGroupArn"
    } },
    NetworkConfiguration = new NetworkConfigurationProperty {
        AwsvpcConfiguration = new AwsVpcConfigurationProperty {
            Subnets = new [] { "subnets" },

            // the properties below are optional
            AssignPublicIp = "assignPublicIp",
            SecurityGroups = new [] { "securityGroups" }
        }
    },
    PlacementConstraints = new [] { new PlacementConstraintProperty {
        Type = "type",

        // the properties below are optional
        Expression = "expression"
    } },
    PlacementStrategies = new [] { new PlacementStrategyProperty {
        Type = "type",

        // the properties below are optional
        Field = "field"
    } },
    PlatformVersion = "platformVersion",
    PropagateTags = "propagateTags",
    Role = "role",
    SchedulingStrategy = "schedulingStrategy",
    ServiceConnectConfiguration = new ServiceConnectConfigurationProperty {
        Enabled = false,

        // the properties below are optional
        LogConfiguration = new LogConfigurationProperty {
            LogDriver = "logDriver",
            Options = new Dictionary<string, string> {
                { "optionsKey", "options" }
            },
            SecretOptions = new [] { new SecretProperty {
                Name = "name",
                ValueFrom = "valueFrom"
            } }
        },
        Namespace = "namespace",
        Services = new [] { new ServiceConnectServiceProperty {
            PortName = "portName",

            // the properties below are optional
            ClientAliases = new [] { new ServiceConnectClientAliasProperty {
                Port = 123,

                // the properties below are optional
                DnsName = "dnsName"
            } },
            DiscoveryName = "discoveryName",
            IngressPortOverride = 123
        } }
    },
    ServiceName = "serviceName",
    ServiceRegistries = new [] { new ServiceRegistryProperty {
        ContainerName = "containerName",
        ContainerPort = 123,
        Port = 123,
        RegistryArn = "registryArn"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TaskDefinition = "taskDefinition"
});

Synopsis

Constructors

CfnService(Construct, String, ICfnServiceProps)

Create a new AWS::ECS::Service.
CfnService(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnService(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrName

The name of the Amazon ECS service, such as sample-webapp .
AttrServiceArn

Not currently supported in AWS CloudFormation .
CapacityProviderStrategy

The capacity provider strategy to use for the service.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Cluster

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

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

The deployment controller to use for the service.
DesiredCount

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

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

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

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

The launch type on which to run your service.
LoadBalancers

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

The network configuration for the service.
PlacementConstraints

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

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

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

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

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

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

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

The name of your service.
ServiceRegistries

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

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

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnService(Construct, String, ICfnServiceProps)

Create a new AWS::ECS::Service.

public CfnService(Construct scope, string id, ICfnServiceProps props = null)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnServiceProps
  • resource properties.

CfnService(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnService(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnService(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnService(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrName

The name of the Amazon ECS service, such as sample-webapp .

public virtual string AttrName { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Name

AttrServiceArn

Not currently supported in AWS CloudFormation .

public virtual string AttrServiceArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ServiceArn

CapacityProviderStrategy

The capacity provider strategy to use for the service.

public virtual object CapacityProviderStrategy { get; set; }
Property Value

System.Object

Remarks

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.

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Cluster

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

public virtual string Cluster { get; set; }
Property Value

System.String

Remarks

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

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

DeploymentConfiguration

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

public virtual object DeploymentConfiguration { get; set; }
Property Value

System.Object

Remarks

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

DeploymentController

The deployment controller to use for the service.

public virtual object DeploymentController { get; set; }
Property Value

System.Object

Remarks

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

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

DesiredCount

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

public virtual Nullable<double> DesiredCount { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

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

EnableEcsManagedTags

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

public virtual object EnableEcsManagedTags { get; set; }
Property Value

System.Object

Remarks

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.

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

EnableExecuteCommand

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

public virtual object EnableExecuteCommand { get; set; }
Property Value

System.Object

Remarks

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

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

HealthCheckGracePeriodSeconds

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.

public virtual Nullable<double> HealthCheckGracePeriodSeconds { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

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

LaunchType

The launch type on which to run your service.

public virtual string LaunchType { get; set; }
Property Value

System.String

Remarks

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

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

LoadBalancers

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

public virtual object LoadBalancers { get; set; }
Property Value

System.Object

Remarks

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 .

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

NetworkConfiguration

The network configuration for the service.

public virtual object NetworkConfiguration { get; set; }
Property Value

System.Object

Remarks

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 .

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

PlacementConstraints

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

public virtual object PlacementConstraints { get; set; }
Property Value

System.Object

Remarks

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

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

PlacementStrategies

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

public virtual object PlacementStrategies { get; set; }
Property Value

System.Object

Remarks

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

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

PlatformVersion

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

public virtual string PlatformVersion { get; set; }
Property Value

System.String

Remarks

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 .

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

PropagateTags

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

public virtual string PropagateTags { get; set; }
Property Value

System.String

Remarks

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 .

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

Role

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.

public virtual string Role { get; set; }
Property Value

System.String

Remarks

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 .

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

SchedulingStrategy

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

public virtual string SchedulingStrategy { get; set; }
Property Value

System.String

Remarks

There are two service scheduler strategies available:

    Tasks using the Fargate launch type or the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code> deployment controller types don&apos;t support the <code>DAEMON</code> scheduling strategy.

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

    ServiceConnectConfiguration

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

    public virtual object ServiceConnectConfiguration { get; set; }
    Property Value

    System.Object

    Remarks

    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 .

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

    ServiceName

    The name of your service.

    public virtual string ServiceName { get; set; }
    Property Value

    System.String

    Remarks

    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.

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

    ServiceRegistries

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

    public virtual object ServiceRegistries { get; set; }
    Property Value

    System.Object

    Remarks

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

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

    Tags

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

    public virtual TagManager Tags { get; }
    Property Value

    TagManager

    Remarks

    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:

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

      TaskDefinition

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

      public virtual string TaskDefinition { get; set; }
      Property Value

      System.String

      Remarks

      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 .

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

      Methods

      Inspect(TreeInspector)

      Examines the CloudFormation resource and discloses attributes.

      public virtual void Inspect(TreeInspector inspector)
      Parameters
      inspector TreeInspector
      • tree inspector to collect and process attributes.

      RenderProperties(IDictionary<String, Object>)

      protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
      Parameters
      props System.Collections.Generic.IDictionary<System.String, System.Object>
      Returns

      System.Collections.Generic.IDictionary<System.String, System.Object>

      Overrides

      Implements

      Constructs.IConstruct