Module ecs

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Functions

getCluster
getContainerDefinition
getService
getTaskDefinition

Others

Resources

Resource CapacityProvider

class CapacityProvider extends CustomResource

Provides an ECS cluster capacity provider. More information can be found on the ECS Developer Guide.

NOTE: The AWS API does not currently support deleting ECS cluster capacity providers. Removing this resource will only remove the state for it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.ecs.CapacityProvider("test", {auto_scaling_group_provider: {
    autoScalingGroupArn: aws_autoscaling_group.test.arn,
    managedTerminationProtection: "ENABLED",
    managed_scaling: {
        maximumScalingStepSize: 1000,
        minimumScalingStepSize: 1,
        status: "ENABLED",
        targetCapacity: 10,
    },
}});

constructor

new CapacityProvider(name: string, args: CapacityProviderArgs, opts?: pulumi.CustomResourceOptions)

Create a CapacityProvider resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CapacityProviderState, opts?: pulumi.CustomResourceOptions): CapacityProvider

Get an existing CapacityProvider resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CapacityProvider

Returns true if the given object is an instance of CapacityProvider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) that identifies the capacity provider.

property autoScalingGroupProvider

public autoScalingGroupProvider: pulumi.Output<CapacityProviderAutoScalingGroupProvider>;

Nested argument defining the provider for the ECS auto scaling group. Defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the capacity provider.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Cluster

class Cluster extends CustomResource

Provides an ECS cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = new aws.ecs.Cluster("foo", {});

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) that identifies the cluster

property capacityProviders

public capacityProviders: pulumi.Output<string[] | undefined>;

List of short names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE_SPOT.

property defaultCapacityProviderStrategies

public defaultCapacityProviderStrategies: pulumi.Output<ClusterDefaultCapacityProviderStrategy[] | undefined>;

The capacity provider strategy to use by default for the cluster. Can be one or more. Defined below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the cluster (up to 255 letters, numbers, hyphens, and underscores)

property settings

public settings: pulumi.Output<ClusterSetting[]>;

Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Defined below.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

Note: To prevent a race condition during service deletion, make sure to set dependsOn to the related aws.iam.RolePolicy; otherwise, the policy may be destroyed too soon and the ECS service will then get stuck in the DRAINING state.

Provides an ECS service - effectively a task that is expected to run until an error occurs or a user terminates it (typically a webserver or a database).

See ECS Services section in AWS developer guide.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const mongo = new aws.ecs.Service("mongo", {
    cluster: aws_ecs_cluster.foo.id,
    taskDefinition: aws_ecs_task_definition.mongo.arn,
    desiredCount: 3,
    iamRole: aws_iam_role.foo.arn,
    ordered_placement_strategy: [{
        type: "binpack",
        field: "cpu",
    }],
    load_balancer: [{
        targetGroupArn: aws_lb_target_group.foo.arn,
        containerName: "mongo",
        containerPort: 8080,
    }],
    placement_constraints: [{
        type: "memberOf",
        expression: "attribute:ecs.availability-zone in [us-west-2a, us-west-2b]",
    }],
});

Ignoring Changes to Desired Count

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ecs.Service("example", {
    // Example: Create service with 2 instances to start
    desiredCount: 2,
}, { ignoreChanges: ["desiredCount"] });

Daemon Scheduling Strategy

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const bar = new aws.ecs.Service("bar", {
    cluster: aws_ecs_cluster_foo.id,
    schedulingStrategy: "DAEMON",
    taskDefinition: aws_ecs_task_definition_bar.arn,
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property capacityProviderStrategies

public capacityProviderStrategies: pulumi.Output<ServiceCapacityProviderStrategy[] | undefined>;

The capacity provider strategy to use for the service. Can be one or more. Defined below.

property cluster

public cluster: pulumi.Output<string>;

ARN of an ECS cluster

property deploymentController

public deploymentController: pulumi.Output<ServiceDeploymentController | undefined>;

Configuration block containing deployment controller configuration. Defined below.

property deploymentMaximumPercent

public deploymentMaximumPercent: pulumi.Output<number | undefined>;

The upper limit (as a percentage of the service’s desiredCount) of the number of running tasks that can be running in a service during a deployment. Not valid when using the DAEMON scheduling strategy.

property deploymentMinimumHealthyPercent

public deploymentMinimumHealthyPercent: pulumi.Output<number | undefined>;

The lower limit (as a percentage of the service’s desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment.

property desiredCount

public desiredCount: pulumi.Output<number | undefined>;

The number of instances of the task definition to place and keep running. Defaults to 0. Do not specify if using the DAEMON scheduling strategy.

property enableEcsManagedTags

public enableEcsManagedTags: pulumi.Output<boolean | undefined>;

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

property forceNewDeployment

public forceNewDeployment: pulumi.Output<boolean | undefined>;

Enable to force a new task deployment of the service. This can be used to update tasks to use a newer Docker image with same image/tag combination (e.g. myimage:latest), roll Fargate tasks onto a newer platform version, or immediately deploy orderedPlacementStrategy and placementConstraints updates.

property healthCheckGracePeriodSeconds

public healthCheckGracePeriodSeconds: pulumi.Output<number | undefined>;

Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 2147483647. Only valid for services configured to use load balancers.

property iamRole

public iamRole: pulumi.Output<string>;

ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service, but only if your task definition does not use the awsvpc network mode. If using awsvpc network mode, do not specify this role. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property launchType

public launchType: pulumi.Output<string>;

The launch type on which to run your service. The valid values are EC2 and FARGATE. Defaults to EC2.

property loadBalancers

public loadBalancers: pulumi.Output<ServiceLoadBalancer[] | undefined>;

A load balancer block. Load balancers documented below.

property name

public name: pulumi.Output<string>;

The name of the service (up to 255 letters, numbers, hyphens, and underscores)

property networkConfiguration

public networkConfiguration: pulumi.Output<ServiceNetworkConfiguration | undefined>;

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.

property orderedPlacementStrategies

public orderedPlacementStrategies: pulumi.Output<ServiceOrderedPlacementStrategy[] | undefined>;

Service level strategy rules that are taken into consideration during task placement. List from top to bottom in order of precedence. Updates to this configuration will take effect next task deployment unless forceNewDeployment is enabled. The maximum number of orderedPlacementStrategy blocks is 5. Defined below.

property placementConstraints

public placementConstraints: pulumi.Output<ServicePlacementConstraint[] | undefined>;

rules that are taken into consideration during task placement. Updates to this configuration will take effect next task deployment unless forceNewDeployment is enabled. Maximum number of placementConstraints is 10. Defined below.

property platformVersion

public platformVersion: pulumi.Output<string>;

The platform version on which to run your service. Only applicable for launchType set to FARGATE. Defaults to LATEST. More information about Fargate platform versions can be found in the AWS ECS User Guide.

property propagateTags

public propagateTags: pulumi.Output<string | undefined>;

Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION.

property schedulingStrategy

public schedulingStrategy: pulumi.Output<string | undefined>;

The scheduling strategy to use for the service. The valid values are REPLICA and DAEMON. Defaults to REPLICA. Note that Fargate tasks do not support the DAEMON scheduling strategy.

property serviceRegistries

public serviceRegistries: pulumi.Output<ServiceServiceRegistries | undefined>;

The service discovery registries for the service. The maximum number of serviceRegistries blocks is 1.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value mapping of resource tags

property taskDefinition

public taskDefinition: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property waitForSteadyState

public waitForSteadyState: pulumi.Output<boolean | undefined>;

If true, this provider will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing. Default false.

Resource TaskDefinition

class TaskDefinition extends CustomResource

Manages a revision of an ECS task definition to be used in aws.ecs.Service.

Example Usage

With AppMesh Proxy

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * from "fs";

const service = new aws.ecs.TaskDefinition("service", {
    family: "service",
    containerDefinitions: fs.readFileSync("task-definitions/service.json"),
    proxy_configuration: {
        type: "APPMESH",
        containerName: "applicationContainerName",
        properties: {
            AppPorts: "8080",
            EgressIgnoredIPs: "169.254.170.2,169.254.169.254",
            IgnoredUID: "1337",
            ProxyEgressPort: 15001,
            ProxyIngressPort: 15000,
        },
    },
});

constructor

new TaskDefinition(name: string, args: TaskDefinitionArgs, opts?: pulumi.CustomResourceOptions)

Create a TaskDefinition resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TaskDefinitionState, opts?: pulumi.CustomResourceOptions): TaskDefinition

Get an existing TaskDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TaskDefinition

Returns true if the given object is an instance of TaskDefinition. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Full ARN of the Task Definition (including both family and revision).

property containerDefinitions

public containerDefinitions: pulumi.Output<string>;

A list of valid container definitions provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the Task Definition Parameters section from the official Developer Guide.

property cpu

public cpu: pulumi.Output<string | undefined>;

The number of cpu units used by the task. If the requiresCompatibilities is FARGATE this field is required.

property executionRoleArn

public executionRoleArn: pulumi.Output<string | undefined>;

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

property family

public family: pulumi.Output<string>;

A unique name for your task definition.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property inferenceAccelerators

public inferenceAccelerators: pulumi.Output<TaskDefinitionInferenceAccelerator[] | undefined>;

Configuration block(s) with Inference Accelerators settings. Detailed below.

property ipcMode

public ipcMode: pulumi.Output<string | undefined>;

The IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.

property memory

public memory: pulumi.Output<string | undefined>;

The amount (in MiB) of memory used by the task. If the requiresCompatibilities is FARGATE this field is required.

property networkMode

public networkMode: pulumi.Output<string>;

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.

property pidMode

public pidMode: pulumi.Output<string | undefined>;

The process namespace to use for the containers in the task. The valid values are host and task.

property placementConstraints

public placementConstraints: pulumi.Output<TaskDefinitionPlacementConstraint[] | undefined>;

A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placementConstraints is 10.

property proxyConfiguration

public proxyConfiguration: pulumi.Output<TaskDefinitionProxyConfiguration | undefined>;

The proxy configuration details for the App Mesh proxy.

property requiresCompatibilities

public requiresCompatibilities: pulumi.Output<string[] | undefined>;

A set of launch types required by the task. The valid values are EC2 and FARGATE.

property revision

public revision: pulumi.Output<number>;

The revision of the task in a particular family.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property taskRoleArn

public taskRoleArn: pulumi.Output<string | undefined>;

The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumes

public volumes: pulumi.Output<TaskDefinitionVolume[] | undefined>;

A set of volume blocks that containers in your task may use.

Functions

Function getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>

The ECS Cluster data source allows access to details of a specific cluster within an AWS ECS service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const ecs_mongo = pulumi.output(aws.ecs.getCluster({
    clusterName: "ecs-mongo-production",
}, { async: true }));

Function getContainerDefinition

getContainerDefinition(args: GetContainerDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetContainerDefinitionResult>

The ECS container definition data source allows access to details of a specific container within an AWS ECS service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const ecs_mongo = aws_ecs_task_definition_mongo.id.apply(id => aws.ecs.getContainerDefinition({
    containerName: "mongodb",
    taskDefinition: id,
}, { async: true }));

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

The ECS Service data source allows access to details of a specific Service within a AWS ECS Cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws_ecs_cluster_example.arn.apply(arn => aws.ecs.getService({
    clusterArn: arn,
    serviceName: "example",
}, { async: true }));

Function getTaskDefinition

getTaskDefinition(args: GetTaskDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetTaskDefinitionResult>

The ECS task definition data source allows access to details of a specific AWS ECS task definition.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const mongoTaskDefinition = new aws.ecs.TaskDefinition("mongo", {
    containerDefinitions: `[
  {
    "cpu": 128,
    "environment": [{
      "name": "SECRET",
      "value": "KEY"
    }],
    "essential": true,
    "image": "mongo:latest",
    "memory": 128,
    "memoryReservation": 64,
    "name": "mongodb"
  }
]
`,
    family: "mongodb",
});
// Simply specify the family to find the latest ACTIVE revision in that family.
const mongoEcsTaskDefinition = mongoTaskDefinition.family.apply(family => aws.ecs.getTaskDefinition({
    taskDefinition: family,
}, { async: true }));
const foo = new aws.ecs.Cluster("foo", {});
const mongoService = new aws.ecs.Service("mongo", {
    cluster: foo.id,
    desiredCount: 2,
    taskDefinition: pulumi.all([mongoTaskDefinition.family, mongoTaskDefinition.revision, mongoEcsTaskDefinition]).apply(([family, revision, mongoEcsTaskDefinition]) => `${family}:${(() => {
        throw "tf2pulumi error: NYI: call to max";
        return (() => { throw "NYI: call to max"; })();
    })()}`),
});

Others

interface CapacityProviderArgs

interface CapacityProviderArgs

The set of arguments for constructing a CapacityProvider resource.

property autoScalingGroupProvider

autoScalingGroupProvider: pulumi.Input<CapacityProviderAutoScalingGroupProvider>;

Nested argument defining the provider for the ECS auto scaling group. Defined below.

property name

name?: pulumi.Input<string>;

The name of the capacity provider.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags.

interface CapacityProviderState

interface CapacityProviderState

Input properties used for looking up and filtering CapacityProvider resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) that identifies the capacity provider.

property autoScalingGroupProvider

autoScalingGroupProvider?: pulumi.Input<CapacityProviderAutoScalingGroupProvider>;

Nested argument defining the provider for the ECS auto scaling group. Defined below.

property name

name?: pulumi.Input<string>;

The name of the capacity provider.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags.

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property capacityProviders

capacityProviders?: pulumi.Input<pulumi.Input<string>[]>;

List of short names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE_SPOT.

property defaultCapacityProviderStrategies

defaultCapacityProviderStrategies?: pulumi.Input<pulumi.Input<ClusterDefaultCapacityProviderStrategy>[]>;

The capacity provider strategy to use by default for the cluster. Can be one or more. Defined below.

property name

name?: pulumi.Input<string>;

The name of the cluster (up to 255 letters, numbers, hyphens, and underscores)

property settings

settings?: pulumi.Input<pulumi.Input<ClusterSetting>[]>;

Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) that identifies the cluster

property capacityProviders

capacityProviders?: pulumi.Input<pulumi.Input<string>[]>;

List of short names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE_SPOT.

property defaultCapacityProviderStrategies

defaultCapacityProviderStrategies?: pulumi.Input<pulumi.Input<ClusterDefaultCapacityProviderStrategy>[]>;

The capacity provider strategy to use by default for the cluster. Can be one or more. Defined below.

property name

name?: pulumi.Input<string>;

The name of the cluster (up to 255 letters, numbers, hyphens, and underscores)

property settings

settings?: pulumi.Input<pulumi.Input<ClusterSetting>[]>;

Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Defined below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface ContainerDefinition

interface ContainerDefinition

property command

command?: string[];

property cpu

cpu?: undefined | number;

property dependsOn

dependsOn?: ContainerDependency[];

property disableNetworking

disableNetworking?: undefined | false | true;

property dnsSearchDomains

dnsSearchDomains?: string[];

property dnsServers

dnsServers?: string[];

property dockerLabels

dockerLabels?: undefined | {[label: string]: string};

property dockerSecurityOptions

dockerSecurityOptions?: string[];

property entryPoint

entryPoint?: string[];

property environment

environment?: KeyValuePair[];

property essential

essential?: undefined | false | true;

property extraHosts

extraHosts?: HostEntry[];

property firelensConfiguration

firelensConfiguration?: FirelensConfiguration;

property healthCheck

healthCheck?: HealthCheck;

property hostname

hostname?: undefined | string;

property image

image?: undefined | string;

property interactive

interactive?: undefined | false | true;

property links

links?: string[];

property linuxParameters

linuxParameters?: LinuxParameters;

property logConfiguration

logConfiguration?: LogConfiguration;

property memory

memory?: undefined | number;

property memoryReservation

memoryReservation?: undefined | number;

property mountPoints

mountPoints?: MountPoint[];

property name

name: string;

property portMappings

portMappings?: PortMapping[];

property privileged

privileged?: undefined | false | true;

property pseudoTerminal

pseudoTerminal?: undefined | false | true;

property readonlyRootFilesystem

readonlyRootFilesystem?: undefined | false | true;

property repositoryCredentials

repositoryCredentials?: RepositoryCredentials;

property resourceRequirements

resourceRequirements?: ResourceRequirements[];

property secrets

secrets?: Secret[];

property startTimeout

startTimeout?: undefined | number;

property stopTimeout

stopTimeout?: undefined | number;

property systemControls

systemControls?: SystemControl[];

property ulimits

ulimits?: Ulimit[];

property user

user?: undefined | string;

property volumesFrom

volumesFrom?: VolumeFrom[];

property workingDirectory

workingDirectory?: undefined | string;

interface ContainerDependency

interface ContainerDependency

property condition

condition?: undefined | string;

property containerName

containerName?: undefined | string;

interface Device

interface Device

property containerPath

containerPath?: undefined | string;

property hostPath

hostPath: string;

property permissions

permissions?: string[];

interface FirelensConfiguration

interface FirelensConfiguration

property options

options?: undefined | {[key: string]: string};

property type

type: string;

interface GetClusterArgs

interface GetClusterArgs

A collection of arguments for invoking getCluster.

property clusterName

clusterName: string;

The name of the ECS Cluster

interface GetClusterResult

interface GetClusterResult

A collection of values returned by getCluster.

property arn

arn: string;

The ARN of the ECS Cluster

property clusterName

clusterName: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property pendingTasksCount

pendingTasksCount: number;

The number of pending tasks for the ECS Cluster

property registeredContainerInstancesCount

registeredContainerInstancesCount: number;

The number of registered container instances for the ECS Cluster

property runningTasksCount

runningTasksCount: number;

The number of running tasks for the ECS Cluster

property settings

settings: GetClusterSetting[];

The settings associated with the ECS Cluster.

property status

status: string;

The status of the ECS Cluster

interface GetContainerDefinitionArgs

interface GetContainerDefinitionArgs

A collection of arguments for invoking getContainerDefinition.

property containerName

containerName: string;

The name of the container definition

property taskDefinition

taskDefinition: string;

The ARN of the task definition which contains the container

interface GetContainerDefinitionResult

interface GetContainerDefinitionResult

A collection of values returned by getContainerDefinition.

property containerName

containerName: string;

property cpu

cpu: number;

The CPU limit for this container definition

property disableNetworking

disableNetworking: boolean;

Indicator if networking is disabled

property dockerLabels

dockerLabels: {[key: string]: string};

Set docker labels

property environment

environment: {[key: string]: string};

The environment in use

property id

id: string;

The provider-assigned unique ID for this managed resource.

property image

image: string;

The docker image in use, including the digest

property imageDigest

imageDigest: string;

The digest of the docker image in use

property memory

memory: number;

The memory limit for this container definition

property memoryReservation

memoryReservation: number;

The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory to this soft limit

property taskDefinition

taskDefinition: string;

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property clusterArn

clusterArn: string;

The arn of the ECS Cluster

property serviceName

serviceName: string;

The name of the ECS Service

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property arn

arn: string;

The ARN of the ECS Service

property clusterArn

clusterArn: string;

property desiredCount

desiredCount: number;

The number of tasks for the ECS Service

property id

id: string;

The provider-assigned unique ID for this managed resource.

property launchType

launchType: string;

The launch type for the ECS Service

property schedulingStrategy

schedulingStrategy: string;

The scheduling strategy for the ECS Service

property serviceName

serviceName: string;

property taskDefinition

taskDefinition: string;

The family for the latest ACTIVE revision

interface GetTaskDefinitionArgs

interface GetTaskDefinitionArgs

A collection of arguments for invoking getTaskDefinition.

property taskDefinition

taskDefinition: string;

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to.

interface GetTaskDefinitionResult

interface GetTaskDefinitionResult

A collection of values returned by getTaskDefinition.

property family

family: string;

The family of this task definition

property id

id: string;

The provider-assigned unique ID for this managed resource.

property networkMode

networkMode: string;

The Docker networking mode to use for the containers in this task.

property revision

revision: number;

The revision of this task definition

property status

status: string;

The status of this task definition

property taskDefinition

taskDefinition: string;

property taskRoleArn

taskRoleArn: string;

The ARN of the IAM role that containers in this task can assume

interface HealthCheck

interface HealthCheck

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html

property command

command?: string[];

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container’s default shell. For example:

[ “CMD-SHELL”, “curl -f http://localhost/ || exit 1” ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

property interval

interval?: undefined | number;

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

property retries

retries?: undefined | number;

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

property startPeriod

startPeriod?: undefined | number;

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

Note: If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

property timeout

timeout?: undefined | number;

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

interface HostEntry

interface HostEntry

property hostname

hostname: string;

property ipAddress

ipAddress: string;

interface KernelCapabilities

interface KernelCapabilities

property add

add?: KernelCapability[];

property drop

drop?: KernelCapability[];

type KernelCapability

type KernelCapability = "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM";

interface KeyValuePair

interface KeyValuePair

property name

name: string;

property value

value: string;

interface LinuxParameters

interface LinuxParameters

property capabilities

capabilities?: KernelCapabilities;

property devices

devices?: Device[];

property initProcessEnabled

initProcessEnabled?: undefined | false | true;

interface LogConfiguration

interface LogConfiguration

property logDriver

logDriver: LogDriver;

property options

options?: undefined | {[key: string]: string};

type LogDriver

type LogDriver = "json-file" | "syslog" | "journald" | "gelf" | "fluentd" | "awslogs" | "splunk" | "awsfirelens";

interface MountPoint

interface MountPoint

property containerPath

containerPath?: undefined | string;

property readOnly

readOnly?: undefined | false | true;

property sourceVolume

sourceVolume?: undefined | string;

interface PortMapping

interface PortMapping

property containerPort

containerPort?: undefined | number;

property hostPort

hostPort?: undefined | number;

property protocol

protocol?: Protocol;

type Protocol

type Protocol = "tcp" | "udp";

interface RepositoryCredentials

interface RepositoryCredentials

property credentialsParameter

credentialsParameter: string;

interface ResourceRequirements

interface ResourceRequirements

The type and amount of a resource to assign to a container. The only supported resource is a GPU. For more information, see Working with GPUs on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

See https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html.

property type

type: string;

The type of resource to assign to a container. The only supported value is GPU.

property value

value: string;

The number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.

interface Secret

interface Secret

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

See https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Secret.html.

property name

name: string;

The name of the secret.

property valueFrom

valueFrom: string;

The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

Note: If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property capacityProviderStrategies

capacityProviderStrategies?: pulumi.Input<pulumi.Input<ServiceCapacityProviderStrategy>[]>;

The capacity provider strategy to use for the service. Can be one or more. Defined below.

property cluster

cluster?: pulumi.Input<string>;

ARN of an ECS cluster

property deploymentController

deploymentController?: pulumi.Input<ServiceDeploymentController>;

Configuration block containing deployment controller configuration. Defined below.

property deploymentMaximumPercent

deploymentMaximumPercent?: pulumi.Input<number>;

property deploymentMinimumHealthyPercent

deploymentMinimumHealthyPercent?: pulumi.Input<number>;

The lower limit (as a percentage of the service’s desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment.

property desiredCount

desiredCount?: pulumi.Input<number>;

The number of instances of the task definition to place and keep running. Defaults to 0. Do not specify if using the DAEMON scheduling strategy.

property enableEcsManagedTags

enableEcsManagedTags?: pulumi.Input<boolean>;

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

property forceNewDeployment

forceNewDeployment?: pulumi.Input<boolean>;

property healthCheckGracePeriodSeconds

healthCheckGracePeriodSeconds?: pulumi.Input<number>;

Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 2147483647. Only valid for services configured to use load balancers.

property iamRole

iamRole?: pulumi.Input<string>;

property launchType

launchType?: pulumi.Input<string>;

The launch type on which to run your service. The valid values are EC2 and FARGATE. Defaults to EC2.

property loadBalancers

loadBalancers?: pulumi.Input<pulumi.Input<ServiceLoadBalancer>[]>;

A load balancer block. Load balancers documented below.

property name

name?: pulumi.Input<string>;

The name of the service (up to 255 letters, numbers, hyphens, and underscores)

property networkConfiguration

networkConfiguration?: pulumi.Input<ServiceNetworkConfiguration>;

property orderedPlacementStrategies

orderedPlacementStrategies?: pulumi.Input<pulumi.Input<ServiceOrderedPlacementStrategy>[]>;

property placementConstraints

placementConstraints?: pulumi.Input<pulumi.Input<ServicePlacementConstraint>[]>;

property platformVersion

platformVersion?: pulumi.Input<string>;

property propagateTags

propagateTags?: pulumi.Input<string>;

Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION.

property schedulingStrategy

schedulingStrategy?: pulumi.Input<string>;

The scheduling strategy to use for the service. The valid values are REPLICA and DAEMON. Defaults to REPLICA. Note that Fargate tasks do not support the DAEMON scheduling strategy.

property serviceRegistries

serviceRegistries?: pulumi.Input<ServiceServiceRegistries>;

The service discovery registries for the service. The maximum number of serviceRegistries blocks is 1.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags

property taskDefinition

taskDefinition: pulumi.Input<string>;

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

property waitForSteadyState

waitForSteadyState?: pulumi.Input<boolean>;

If true, this provider will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing. Default false.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property capacityProviderStrategies

capacityProviderStrategies?: pulumi.Input<pulumi.Input<ServiceCapacityProviderStrategy>[]>;

The capacity provider strategy to use for the service. Can be one or more. Defined below.

property cluster

cluster?: pulumi.Input<string>;

ARN of an ECS cluster

property deploymentController

deploymentController?: pulumi.Input<ServiceDeploymentController>;

Configuration block containing deployment controller configuration. Defined below.

property deploymentMaximumPercent

deploymentMaximumPercent?: pulumi.Input<number>;

property deploymentMinimumHealthyPercent

deploymentMinimumHealthyPercent?: pulumi.Input<number>;

The lower limit (as a percentage of the service’s desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment.

property desiredCount

desiredCount?: pulumi.Input<number>;

The number of instances of the task definition to place and keep running. Defaults to 0. Do not specify if using the DAEMON scheduling strategy.

property enableEcsManagedTags

enableEcsManagedTags?: pulumi.Input<boolean>;

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

property forceNewDeployment

forceNewDeployment?: pulumi.Input<boolean>;

property healthCheckGracePeriodSeconds

healthCheckGracePeriodSeconds?: pulumi.Input<number>;

Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 2147483647. Only valid for services configured to use load balancers.

property iamRole

iamRole?: pulumi.Input<string>;

property launchType

launchType?: pulumi.Input<string>;

The launch type on which to run your service. The valid values are EC2 and FARGATE. Defaults to EC2.

property loadBalancers

loadBalancers?: pulumi.Input<pulumi.Input<ServiceLoadBalancer>[]>;

A load balancer block. Load balancers documented below.

property name

name?: pulumi.Input<string>;

The name of the service (up to 255 letters, numbers, hyphens, and underscores)

property networkConfiguration

networkConfiguration?: pulumi.Input<ServiceNetworkConfiguration>;

property orderedPlacementStrategies

orderedPlacementStrategies?: pulumi.Input<pulumi.Input<ServiceOrderedPlacementStrategy>[]>;

property placementConstraints

placementConstraints?: pulumi.Input<pulumi.Input<ServicePlacementConstraint>[]>;

property platformVersion

platformVersion?: pulumi.Input<string>;

property propagateTags

propagateTags?: pulumi.Input<string>;

Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION.

property schedulingStrategy

schedulingStrategy?: pulumi.Input<string>;

The scheduling strategy to use for the service. The valid values are REPLICA and DAEMON. Defaults to REPLICA. Note that Fargate tasks do not support the DAEMON scheduling strategy.

property serviceRegistries

serviceRegistries?: pulumi.Input<ServiceServiceRegistries>;

The service discovery registries for the service. The maximum number of serviceRegistries blocks is 1.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags

property taskDefinition

taskDefinition?: pulumi.Input<string>;

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

property waitForSteadyState

waitForSteadyState?: pulumi.Input<boolean>;

If true, this provider will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing. Default false.

interface SystemControl

interface SystemControl

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the –sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:

For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect.
For tasks that use the host network mode, the systemControls parameter applies to the container instance’s kernel parameter as well as that of all containers of any tasks running on that container instance.

See https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_SystemControl.html.

property namespace

namespace?: undefined | string;

The namespaced kernel parameter for which to set a value.

property value

value?: undefined | string;

The value for the namespaced kernel parameter specified in namespace.

interface TaskDefinitionArgs

interface TaskDefinitionArgs

The set of arguments for constructing a TaskDefinition resource.

property containerDefinitions

containerDefinitions: pulumi.Input<string>;

property cpu

cpu?: pulumi.Input<string>;

The number of cpu units used by the task. If the requiresCompatibilities is FARGATE this field is required.

property executionRoleArn

executionRoleArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

property family

family: pulumi.Input<string>;

A unique name for your task definition.

property inferenceAccelerators

inferenceAccelerators?: pulumi.Input<pulumi.Input<TaskDefinitionInferenceAccelerator>[]>;

Configuration block(s) with Inference Accelerators settings. Detailed below.

property ipcMode

ipcMode?: pulumi.Input<string>;

The IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.

property memory

memory?: pulumi.Input<string>;

The amount (in MiB) of memory used by the task. If the requiresCompatibilities is FARGATE this field is required.

property networkMode

networkMode?: pulumi.Input<string>;

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.

property pidMode

pidMode?: pulumi.Input<string>;

The process namespace to use for the containers in the task. The valid values are host and task.

property placementConstraints

placementConstraints?: pulumi.Input<pulumi.Input<TaskDefinitionPlacementConstraint>[]>;

A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placementConstraints is 10.

property proxyConfiguration

proxyConfiguration?: pulumi.Input<TaskDefinitionProxyConfiguration>;

The proxy configuration details for the App Mesh proxy.

property requiresCompatibilities

requiresCompatibilities?: pulumi.Input<pulumi.Input<string>[]>;

A set of launch types required by the task. The valid values are EC2 and FARGATE.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property taskRoleArn

taskRoleArn?: pulumi.Input<string>;

The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.

property volumes

volumes?: pulumi.Input<pulumi.Input<TaskDefinitionVolume>[]>;

A set of volume blocks that containers in your task may use.

interface TaskDefinitionState

interface TaskDefinitionState

Input properties used for looking up and filtering TaskDefinition resources.

property arn

arn?: pulumi.Input<string>;

Full ARN of the Task Definition (including both family and revision).

property containerDefinitions

containerDefinitions?: pulumi.Input<string>;

property cpu

cpu?: pulumi.Input<string>;

The number of cpu units used by the task. If the requiresCompatibilities is FARGATE this field is required.

property executionRoleArn

executionRoleArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

property family

family?: pulumi.Input<string>;

A unique name for your task definition.

property inferenceAccelerators

inferenceAccelerators?: pulumi.Input<pulumi.Input<TaskDefinitionInferenceAccelerator>[]>;

Configuration block(s) with Inference Accelerators settings. Detailed below.

property ipcMode

ipcMode?: pulumi.Input<string>;

The IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.

property memory

memory?: pulumi.Input<string>;

The amount (in MiB) of memory used by the task. If the requiresCompatibilities is FARGATE this field is required.

property networkMode

networkMode?: pulumi.Input<string>;

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.

property pidMode

pidMode?: pulumi.Input<string>;

The process namespace to use for the containers in the task. The valid values are host and task.

property placementConstraints

placementConstraints?: pulumi.Input<pulumi.Input<TaskDefinitionPlacementConstraint>[]>;

A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placementConstraints is 10.

property proxyConfiguration

proxyConfiguration?: pulumi.Input<TaskDefinitionProxyConfiguration>;

The proxy configuration details for the App Mesh proxy.

property requiresCompatibilities

requiresCompatibilities?: pulumi.Input<pulumi.Input<string>[]>;

A set of launch types required by the task. The valid values are EC2 and FARGATE.

property revision

revision?: pulumi.Input<number>;

The revision of the task in a particular family.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property taskRoleArn

taskRoleArn?: pulumi.Input<string>;

The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.

property volumes

volumes?: pulumi.Input<pulumi.Input<TaskDefinitionVolume>[]>;

A set of volume blocks that containers in your task may use.

interface Ulimit

interface Ulimit

property hardLimit

hardLimit: number;

property name

name: UlimitName;

property softLimit

softLimit: number;

type UlimitName

type UlimitName = "core" | "cpu" | "data" | "fsize" | "locks" | "memlock" | "msgqueue" | "nice" | "nofile" | "nproc" | "rss" | "rtprio" | "rttime" | "sigpending" | "stack";

interface VolumeFrom

interface VolumeFrom

property readOnly

readOnly?: undefined | false | true;

property sourceContainer

sourceContainer?: undefined | string;

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module ecs

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Ignoring Changes to Desired Count

Daemon Scheduling Strategy

Example Usage

With AppMesh Proxy

Functions

Example Usage

Example Usage

Example Usage

Example Usage

Others