interface EcsDeployActionProps

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.Actions.EcsDeployActionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#EcsDeployActionProps
Java	software.amazon.awscdk.services.codepipeline.actions.EcsDeployActionProps
Python	aws_cdk.aws_codepipeline_actions.EcsDeployActionProps
TypeScript (source)	aws-cdk-lib » aws_codepipeline_actions » EcsDeployActionProps

Construction properties of EcsDeployAction.

Example

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

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
service	IBaseService	The ECS Service to deploy.
deploymentTimeout?	Duration	Timeout for the ECS deployment in minutes.
imageFile?	ArtifactPath	The name of the JSON image definitions file to use for deployments.
input?	Artifact	The input artifact that contains the JSON image definitions file to use for deployments.
role?	IRole	The Role in which context's this Action will be executing in.
runOrder?	number	The runOrder property for this Action.
variablesNamespace?	string	The name of the namespace to use for variables emitted by this action.

---

actionName

Type: string

The physical, human-readable name of the Action.

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

---

service

Type: IBaseService

The ECS Service to deploy.

---

deploymentTimeout?

Type: Duration (optional, default: 60 minutes)

Timeout for the ECS deployment in minutes.

Value must be between 1-60.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-ECS.html

---

imageFile?

Type: ArtifactPath (optional, default: one of this property, or input, is required)

The name of the JSON image definitions file to use for deployments.

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.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-create.html#pipelines-create-image-definitions

---

input?

Type: Artifact (optional, default: one of this property, or imageFile, is required)

The input artifact that contains the JSON image definitions file to use for deployments.

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.

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-create.html#pipelines-create-image-definitions

---

role?

Type: IRole (optional, default: a new Role will be generated)

The Role in which context's this Action will be executing in.

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?

Type: number (optional, default: 1)

The runOrder property for this Action.

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

See also: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

---

variablesNamespace?

Type: string (optional, 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)

The name of the namespace to use for variables emitted by this action.