software.amazon.awscdk.services.codepipeline.actions

Interface CodeDeployEcsDeployActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps

All Known Implementing Classes:

CodeDeployEcsDeployActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:44.764Z")
public interface CodeDeployEcsDeployActionProps
extends CommonAwsActionProps

Construction properties of the CodeDeploy ECS deploy CodePipeline Action.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codedeploy.*;
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.codepipeline.actions.*;
 import software.amazon.awscdk.services.iam.*;
 Artifact artifact;
 ArtifactPath artifactPath;
 IEcsDeploymentGroup ecsDeploymentGroup;
 Role role;
 CodeDeployEcsDeployActionProps codeDeployEcsDeployActionProps = CodeDeployEcsDeployActionProps.builder()
         .actionName("actionName")
         .deploymentGroup(ecsDeploymentGroup)
         // the properties below are optional
         .appSpecTemplateFile(artifactPath)
         .appSpecTemplateInput(artifact)
         .containerImageInputs(List.of(CodeDeployEcsContainerImageInput.builder()
                 .input(artifact)
                 // the properties below are optional
                 .taskDefinitionPlaceholder("taskDefinitionPlaceholder")
                 .build()))
         .role(role)
         .runOrder(123)
         .taskDefinitionTemplateFile(artifactPath)
         .taskDefinitionTemplateInput(artifact)
         .variablesNamespace("variablesNamespace")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CodeDeployEcsDeployActionProps.Builder	builder()
default ArtifactPath	getAppSpecTemplateFile() The name of the CodeDeploy AppSpec file.
default Artifact	getAppSpecTemplateInput() The artifact containing the CodeDeploy AppSpec file.
default java.util.List<CodeDeployEcsContainerImageInput>	getContainerImageInputs() Configuration for dynamically updated images in the task definition.
IEcsDeploymentGroup	getDeploymentGroup() The CodeDeploy ECS Deployment Group to deploy to.
default ArtifactPath	getTaskDefinitionTemplateFile() The name of the ECS task definition template file.
default Artifact	getTaskDefinitionTemplateInput() The artifact containing the ECS task definition template file.

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

getRole

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

getActionName, getRunOrder, getVariablesNamespace

Method Detail

getDeploymentGroup

IEcsDeploymentGroup getDeploymentGroup()

The CodeDeploy ECS Deployment Group to deploy to.

getAppSpecTemplateFile

default ArtifactPath getAppSpecTemplateFile()

The name of the CodeDeploy AppSpec file.

During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.

Use this property if you want to use a different name for this file than the default 'appspec.yaml'. If you use this property, you don't need to specify the appSpecTemplateInput property.

Default: - one of this property, or `appSpecTemplateInput`, is required

getAppSpecTemplateInput

default Artifact getAppSpecTemplateInput()

The artifact containing the CodeDeploy AppSpec file.

During deployment, a new task definition will be registered with ECS, and the new task definition ID will be inserted into the CodeDeploy AppSpec file. The AppSpec file contents will be provided to CodeDeploy for the deployment.

If you use this property, it's assumed the file is called 'appspec.yaml'. If your AppSpec file uses a different filename, leave this property empty, and use the appSpecTemplateFile property instead.

Default: - one of this property, or `appSpecTemplateFile`, is required

getContainerImageInputs

default java.util.List<CodeDeployEcsContainerImageInput> getContainerImageInputs()

Configuration for dynamically updated images in the task definition.

Provide pairs of an image details input artifact and a placeholder string that will be used to dynamically update the ECS task definition template file prior to deployment. A maximum of 4 images can be given.

getTaskDefinitionTemplateFile

default ArtifactPath getTaskDefinitionTemplateFile()

The name of the ECS task definition template file.

During deployment, the task definition template file contents will be registered with ECS.

Use this property if you want to use a different name for this file than the default 'taskdef.json'. If you use this property, you don't need to specify the taskDefinitionTemplateInput property.

Default: - one of this property, or `taskDefinitionTemplateInput`, is required

getTaskDefinitionTemplateInput

default Artifact getTaskDefinitionTemplateInput()

The artifact containing the ECS task definition template file.

During deployment, the task definition template file contents will be registered with ECS.

If you use this property, it's assumed the file is called 'taskdef.json'. If your task definition template uses a different filename, leave this property empty, and use the taskDefinitionTemplateFile property instead.

Default: - one of this property, or `taskDefinitionTemplateFile`, is required

builder

static CodeDeployEcsDeployActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a CodeDeployEcsDeployActionProps.Builder of CodeDeployEcsDeployActionProps