Deploy AWS ECS Service

Use EC2 Instance Role

Octopus.Action.AwsAccount.UseInstanceRole

Execute using the AWS service role for an EC2 instance.

Allowed values: True, False

Default: False

AWS Account

Octopus.Action.AwsAccount.Variable

The AWS account variable to use for authentication.

Assume a Different AWS Service Role

Octopus.Action.Aws.AssumeRole

Whether to assume a different AWS IAM role for executing this step.

Allowed values: True, False

Default: False

Assumed Role ARN

Octopus.Action.Aws.AssumedRoleArn

The Amazon Resource Name (ARN) of the IAM role to assume.

Example: arn:aws:iam::123456789012:role/ExampleRole

Assumed Role Session Name

Octopus.Action.Aws.AssumedRoleSession

A name for the assumed role session. Leave blank to use an automatically generated session name.

Assumed Role Session Duration (seconds)

Octopus.Action.Aws.AssumeRoleSessionDurationSeconds

The duration in seconds for the assumed role session. If blank, defaults to 3600 seconds (1 hour). AWS requires a session duration between 900 seconds (15 minutes) and 43200 seconds (12 hours).

Example: 3600

Assumed Role External ID

Octopus.Action.Aws.AssumeRoleExternalId

An external ID to provide additional security when assuming the role.

Region

Octopus.Action.Aws.Region (required)

The default AWS region code for this step.

Example: us-west-2

ECS Cluster Name

Octopus.Action.Aws.Ecs.ClusterName (required)

The name of the ECS cluster the service is deployed into.

ECS Service Name

Octopus.Action.Aws.Ecs.ServiceName (required)

The name of the ECS service. Also used as the task definition family name and to label post-deployment task diagnostics.

CloudFormation Stack Name

Octopus.Action.Aws.CloudFormationStackName (required)

The CloudFormation stack name used to deploy the ECS service.

Template Source

Octopus.Action.Aws.TemplateSource (required)

The source of the CloudFormation template. Always Inline for this step; the template is generated by the step package mapper from the ECS step inputs.

Allowed values: Inline

Default: Inline

CloudFormation Template

Octopus.Action.Aws.CloudFormationTemplate (required)

The inline CloudFormation template body that deploys the ECS task definition and service. Generated by the step package mapper.

Template Parameters

Octopus.Action.Aws.CloudFormationTemplateParameters

CloudFormation template parameters as a JSON array of ParameterKey/ParameterValue pairs.

Example: [{"ParameterKey":"ClusterName","ParameterValue":"my-cluster"}]

Wait Option

Octopus.Action.Aws.Ecs.WaitOption.Type (required)

Whether and how to wait for the stack and ECS task deployment to complete.

Allowed values: waitUntilCompleted, waitWithTimeout, dontWait

Default: waitUntilCompleted

Wait Timeout (ms)

Octopus.Action.Aws.Ecs.WaitOption.Timeout

Timeout in milliseconds. Required when Wait Option is waitWithTimeout; otherwise ignored.

Tags

Octopus.Action.Aws.CloudFormation.Tags

User-supplied stack tags as a JSON array of key-value pairs. Calamari merges these with 19 default Octopus tags (project/release/environment/tenant identifiers and names) and propagates them to all stack resources.

Example: [{"key":"Environment","value":"Production"}]