software.amazon.awscdk.services.codepipeline.actions

Class CodeDeployEcsDeployAction.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.CodeDeployEcsDeployAction.Builder

Enclosing class:

CodeDeployEcsDeployAction

@Stability(value=Stable)
public static final class CodeDeployEcsDeployAction.Builder
extends Object

A fluent builder for CodeDeployEcsDeployAction.

Method Summary

Modifier and Type	Method and Description
CodeDeployEcsDeployAction.Builder	actionName(String actionName)
CodeDeployEcsDeployAction.Builder	appSpecTemplateFile(ArtifactPath appSpecTemplateFile)
CodeDeployEcsDeployAction.Builder	appSpecTemplateInput(Artifact appSpecTemplateInput)
CodeDeployEcsDeployAction	build()
CodeDeployEcsDeployAction.Builder	containerImageInputs(List<CodeDeployEcsContainerImageInput> containerImageInputs)
static CodeDeployEcsDeployAction.Builder	create()
CodeDeployEcsDeployAction.Builder	deploymentGroup(IEcsDeploymentGroup deploymentGroup)
CodeDeployEcsDeployAction.Builder	role(IRole role)
CodeDeployEcsDeployAction.Builder	runOrder(Number runOrder)
CodeDeployEcsDeployAction.Builder	taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile)
CodeDeployEcsDeployAction.Builder	taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CodeDeployEcsDeployAction.Builder create()

Returns:

a new instance of CodeDeployEcsDeployAction.Builder.

actionName

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder actionName(String actionName)

Parameters:

actionName - The physical, human-readable name of the Action. Not that Action names must be unique within a single Stage. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder runOrder(Number runOrder)

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder role(IRole role)

Parameters:

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. This parameter is required.

Returns:

this

deploymentGroup

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder deploymentGroup(IEcsDeploymentGroup deploymentGroup)

Parameters:

deploymentGroup - The CodeDeploy ECS Deployment Group to deploy to. This parameter is required.

Returns:

this

appSpecTemplateFile

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder appSpecTemplateFile(ArtifactPath appSpecTemplateFile)

Parameters:

appSpecTemplateFile - 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. This parameter is required.

Returns:

this

appSpecTemplateInput

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder appSpecTemplateInput(Artifact appSpecTemplateInput)

Parameters:

appSpecTemplateInput - 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. This parameter is required.

Returns:

this

containerImageInputs

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder containerImageInputs(List<CodeDeployEcsContainerImageInput> containerImageInputs)

Parameters:

containerImageInputs - Configuration for dynamically updated images in the task definition. This parameter is required.

Returns:

this

taskDefinitionTemplateFile

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile)

Parameters:

taskDefinitionTemplateFile - The name of the ECS task definition template file. During deployment, the task definition template file contents will be registered with ECS. This parameter is required.

Returns:

this

taskDefinitionTemplateInput

@Stability(value=Stable)
public CodeDeployEcsDeployAction.Builder taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput)

Parameters:

taskDefinitionTemplateInput - The artifact containing the ECS task definition template file. During deployment, the task definition template file contents will be registered with ECS. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CodeDeployEcsDeployAction build()