software.amazon.awscdk.services.codepipeline.actions

Interface EcsDeployActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EcsDeployActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.537Z")
 @Stability(value=Stable)
public interface EcsDeployActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of EcsDeployAction.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 import software.amazon.awscdk.services.ecs.*;
 FargateService service;
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact buildOutput = new Artifact();
 IStage deployStage = pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(
             EcsDeployAction.Builder.create()
                     .actionName("DeployAction")
                     .service(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))
                     .build()))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EcsDeployActionProps.Builder A builder for EcsDeployActionProps
static class	EcsDeployActionProps.Jsii$Proxy An implementation for EcsDeployActionProps

Method Summary

Modifier and Type	Method and Description
static EcsDeployActionProps.Builder	builder()
default Duration	getDeploymentTimeout() Timeout for the ECS deployment in minutes.
default ArtifactPath	getImageFile() The name of the JSON image definitions file to use for deployments.
default Artifact	getInput() The input artifact that contains the JSON image definitions file to use for deployments.
IBaseService	getService() The ECS Service to deploy.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getService

@Stability(value=Stable)
 @NotNull
IBaseService getService()

The ECS Service to deploy.

getDeploymentTimeout

@Stability(value=Stable)
 @Nullable
default Duration getDeploymentTimeout()

Timeout for the ECS deployment in minutes.

Value must be between 1-60.

Default: - 60 minutes

See Also:

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

getImageFile

@Stability(value=Stable)
 @Nullable
default ArtifactPath getImageFile()

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 Also:

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

getInput

@Stability(value=Stable)
 @Nullable
default Artifact getInput()

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 Also:

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

builder

@Stability(value=Stable)
static EcsDeployActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a EcsDeployActionProps.Builder of EcsDeployActionProps