interface BaseServiceOptions

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.BaseServiceOptions`
Java	`software.amazon.awscdk.services.ecs.BaseServiceOptions`
Python	`aws_cdk.aws_ecs.BaseServiceOptions`
TypeScript (source)	`@aws-cdk/aws-ecs` » `BaseServiceOptions`

The properties for the base Ec2Service or FargateService service.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
import * as servicediscovery from '@aws-cdk/aws-servicediscovery';
import * as cdk from '@aws-cdk/core';

declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const namespace: servicediscovery.INamespace;
const baseServiceOptions: ecs.BaseServiceOptions = {
  cluster: cluster,

  // the properties below are optional
  capacityProviderStrategies: [{
    capacityProvider: 'capacityProvider',

    // the properties below are optional
    base: 123,
    weight: 123,
  }],
  circuitBreaker: {
    rollback: false,
  },
  cloudMapOptions: {
    cloudMapNamespace: namespace,
    container: containerDefinition,
    containerPort: 123,
    dnsRecordType: servicediscovery.DnsRecordType.A,
    dnsTtl: cdk.Duration.minutes(30),
    failureThreshold: 123,
    name: 'name',
  },
  deploymentController: {
    type: ecs.DeploymentControllerType.ECS,
  },
  desiredCount: 123,
  enableECSManagedTags: false,
  enableExecuteCommand: false,
  healthCheckGracePeriod: cdk.Duration.minutes(30),
  maxHealthyPercent: 123,
  minHealthyPercent: 123,
  propagateTags: ecs.PropagatedTagSource.SERVICE,
  propagateTaskTagsFrom: ecs.PropagatedTagSource.SERVICE,
  serviceName: 'serviceName',
};

Properties

Name	Type	Description
cluster	`ICluster`	The name of the cluster that hosts the service.
capacityProviderStrategies?	`CapacityProviderStrategy[]`	A list of Capacity Provider strategies used to place a service.
circuitBreaker?	`DeploymentCircuitBreaker`	Whether to enable the deployment circuit breaker.
cloudMapOptions?	`CloudMapOptions`	The options for configuring an Amazon ECS service to use service discovery.
deploymentController?	`DeploymentController`	Specifies which deployment controller to use for the service.
desiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?	`boolean`	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
enableExecuteCommand?	`boolean`	Whether to enable the ability to execute into a container.
healthCheckGracePeriod?	`Duration`	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.
maxHealthyPercent?	`number`	The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
minHealthyPercent?	`number`	The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
propagateTags?	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
propagateTaskTagsFrom?⚠️	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
serviceName?	`string`	The name of the service.

cluster

Type: ICluster

The name of the cluster that hosts the service.

capacityProviderStrategies?

Type: CapacityProviderStrategy[] (optional, default: undefined)

A list of Capacity Provider strategies used to place a service.

circuitBreaker?

Type: DeploymentCircuitBreaker (optional, default: disabled)

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

cloudMapOptions?

Type: CloudMapOptions (optional, default: AWS Cloud Map service discovery is not enabled.)

The options for configuring an Amazon ECS service to use service discovery.

deploymentController?

Type: DeploymentController (optional, default: Rolling update (ECS))

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

desiredCount?

Type: number (optional, default: When creating the service, default is 1; when updating the service, default uses the current task number.)

The desired number of instantiations of the task definition to keep running on the service.

enableECSManagedTags?

Type: boolean (optional, default: false)

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

For more information, see Tagging Your Amazon ECS Resources

enableExecuteCommand?

Type: boolean (optional, default: undefined)

Whether to enable the ability to execute into a container.

healthCheckGracePeriod?

Type: Duration (optional, default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set)

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.

maxHealthyPercent?

Type: number (optional, default: 100 if daemon, otherwise 200)

The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

minHealthyPercent?

Type: number (optional, default: 0 if daemon, otherwise 50)

The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

propagateTags?

Type: PropagatedTagSource (optional, default: PropagatedTagSource.NONE)

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE

propagateTaskTagsFrom?⚠️

⚠️ Deprecated: Use propagateTags instead.

Type: PropagatedTagSource (optional, default: PropagatedTagSource.NONE)

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Tags can only be propagated to the tasks within the service during service creation.

serviceName?

Type: string (optional, default: CloudFormation-generated name.)

The name of the service.