Interface IEcsDeployActionProps
Construction properties of EcsDeployAction
.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEcsDeployActionProps : ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Interface IEcsDeployActionProps
Inherits ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.ECS;
FargateService service;
var pipeline = new Pipeline(this, "MyPipeline");
var buildOutput = new Artifact();
var deployStage = pipeline.AddStage(new StageOptions {
StageName = "Deploy",
Actions = new [] {
new EcsDeployAction(new EcsDeployActionProps {
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)
}) }
});
Synopsis
Properties
DeploymentTimeout | Timeout for the ECS deployment in minutes. |
ImageFile | The name of the JSON image definitions file to use for deployments. |
Input | The input artifact that contains the JSON image definitions file to use for deployments. |
Service | The ECS Service to deploy. |
Properties
DeploymentTimeout
Timeout for the ECS deployment in minutes.
virtual Duration DeploymentTimeout { get; }
Property Value
Remarks
Value must be between 1-60.
Default: - 60 minutes
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-ECS.html
ImageFile
The name of the JSON image definitions file to use for deployments.
virtual ArtifactPath_ ImageFile { get; }
Property Value
Remarks
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
The input artifact that contains the JSON image definitions file to use for deployments.
virtual Artifact_ Input { get; }
Property Value
Remarks
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