EcsDeployActionProps

class aws_cdk.aws_codepipeline_actions.EcsDeployActionProps(*, action_name, run_order=None, variables_namespace=None, role=None, service, deployment_timeout=None, image_file=None, input=None)

Bases: CommonAwsActionProps

Construction properties of EcsDeployAction.

Parameters:
  • action_name (str) – The physical, human-readable name of the Action. Note that Action names must be unique within a single Stage.

  • run_order (Union[int, float, None]) – The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. Default: 1

  • variables_namespace (Optional[str]) – 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

  • role (Optional[IRole]) – 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. Default: a new Role will be generated

  • service (IBaseService) – The ECS Service to deploy.

  • deployment_timeout (Optional[Duration]) – Timeout for the ECS deployment in minutes. Value must be between 1-60. Default: - 60 minutes

  • image_file (Optional[ArtifactPath]) – 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. Default: - one of this property, or input, is required

  • input (Optional[Artifact]) – 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. Default: - one of this property, or imageFile, is required

ExampleMetadata:

infused

Example:

import aws_cdk.aws_ecs as ecs

# service: ecs.FargateService

pipeline = codepipeline.Pipeline(self, "MyPipeline")
build_output = codepipeline.Artifact()
deploy_stage = pipeline.add_stage(
    stage_name="Deploy",
    actions=[
        codepipeline_actions.EcsDeployAction(
            action_name="DeployAction",
            service=service,
            # if your file is called imagedefinitions.json,
            # use the `input` property,
            # and leave out the `imageFile` property
            input=build_output,
            # if your file name is _not_ imagedefinitions.json,
            # use the `imageFile` property,
            # and leave out the `input` property
            image_file=build_output.at_path("imageDef.json"),
            deployment_timeout=Duration.minutes(60)
        )
    ]
)

Attributes

action_name

The physical, human-readable name of the Action.

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

deployment_timeout

Timeout for the ECS deployment in minutes.

Value must be between 1-60.

Default:
  • 60 minutes

See:

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

image_file

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.

Default:
  • one of this property, or input, is required

See:

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

input

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.

Default:
  • one of this property, or imageFile, is required

See:

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

role

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.

Default:

a new Role will be generated

run_order

The runOrder property for this Action.

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

Default:

1

See:

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

service

The ECS Service to deploy.

variables_namespace

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