# EcsDeployActionProps

Construction properties of `EcsDeployAction`.

Extends: EcsDeployActionProps
Extends: CommonAwsActionProps
Used as props by: EcsDeployAction

- Source: [`aws-codepipeline-actions/lib/ecs/deploy-action.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-codepipeline-actions/lib/ecs/deploy-action.ts#L14)

## Example

```ts
import * as ecs from 'aws-cdk-lib/aws-ecs';

declare const service: ecs.FargateService;
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const buildOutput = new codepipeline.Artifact();
const deployStage = pipeline.addStage({
  stageName: 'Deploy',
  actions: [
    new codepipeline_actions.EcsDeployAction({
      actionName: 'DeployAction',
      service,
      // if your file is called imagedefinitions.json,
      // use the `input` property,
      // and leave out the `imageFile` property
      input: buildOutput,
      // if your file name is _not_ imagedefinitions.json,
      // use the `imageFile` property,
      // and leave out the `input` property
      imageFile: buildOutput.atPath('imageDef.json'),
      deploymentTimeout: Duration.minutes(60), // optional, default is 60 minutes
    }),
  ],
});
```

## Properties

- `actionName`: string (required) — The physical, human-readable name of the Action.

  Note that Action names must be unique within a single Stage.

- `deploymentTimeout`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) — Timeout for the ECS deployment in minutes.

  **Default:** 60 minutes

  Value must be between 1-60.

- `imageFile`: [ArtifactPath](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.ArtifactPath.html) — The name of the JSON image definitions file to use for deployments.

  **Default:** one of this property, or `input`, is required

  The JSON file is a list of objects,
  each with 2 keys: `name` is the name of the container in the Task Definition,
  and `imageUri` is the Docker image URI you want to update your service with.
  Use this property if you want to use a different name for this file than the default 'imagedefinitions.json'.
  If you use this property, you don't need to specify the `input` property.

- `input`: [Artifact](/cdk/api/v2/docs/aws-cdk-lib.aws_codepipeline.Artifact.html) — The input artifact that contains the JSON image definitions file to use for deployments.

  **Default:** one of this property, or `imageFile`, is required

  The JSON file is a list of objects,
  each with 2 keys: `name` is the name of the container in the Task Definition,
  and `imageUri` is the Docker image URI you want to update your service with.
  If you use this property, it's assumed the file is called 'imagedefinitions.json'.
  If your build uses a different file, leave this property empty,
  and use the `imageFile` property instead.

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The Role in which context's this Action will be executing in.

  **Default:** a new Role will be generated

  The Pipeline's Role will assume this Role
  (the required permissions for that will be granted automatically)
  right before executing this Action.
  This Action will be passed into your `IAction.bind`
  method in the `ActionBindOptions.role` property.

- `runOrder`: number = 1 — The runOrder property for this Action.

  RunOrder determines the relative order in which multiple Actions in the same Stage execute.

- `service`: [IBaseService](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.IBaseService.html) (required) — The ECS Service to deploy.

- `variablesNamespace`: string — The name of the namespace to use for variables emitted by this action.

  **Default:** a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set