software.amazon.awscdk.services.codepipeline.actions

Class CodeDeployEcsDeployAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CodeDeployEcsDeployAction>

Enclosing class:

CodeDeployEcsDeployAction

@Stability(value=Experimental)
public static final class CodeDeployEcsDeployAction.Builder
extends Object
implements software.amazon.jsii.Builder<CodeDeployEcsDeployAction>

(experimental) A fluent builder for CodeDeployEcsDeployAction.

Method Summary

Modifier and Type	Method and Description
CodeDeployEcsDeployAction.Builder	actionName(String actionName) (experimental) The physical, human-readable name of the Action.
CodeDeployEcsDeployAction.Builder	appSpecTemplateFile(ArtifactPath appSpecTemplateFile) (experimental) The name of the CodeDeploy AppSpec file.
CodeDeployEcsDeployAction.Builder	appSpecTemplateInput(Artifact appSpecTemplateInput) (experimental) The artifact containing the CodeDeploy AppSpec file.
CodeDeployEcsDeployAction	build()
CodeDeployEcsDeployAction.Builder	containerImageInputs(List<? extends CodeDeployEcsContainerImageInput> containerImageInputs) (experimental) Configuration for dynamically updated images in the task definition.
static CodeDeployEcsDeployAction.Builder	create()
CodeDeployEcsDeployAction.Builder	deploymentGroup(IEcsDeploymentGroup deploymentGroup) (experimental) The CodeDeploy ECS Deployment Group to deploy to.
CodeDeployEcsDeployAction.Builder	role(IRole role) (experimental) The Role in which context's this Action will be executing in.
CodeDeployEcsDeployAction.Builder	runOrder(Number runOrder) (experimental) The runOrder property for this Action.
CodeDeployEcsDeployAction.Builder	taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile) (experimental) The name of the ECS task definition template file.
CodeDeployEcsDeployAction.Builder	taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput) (experimental) The artifact containing the ECS task definition template file.
CodeDeployEcsDeployAction.Builder	variablesNamespace(String variablesNamespace) (experimental) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Returns:

a new instance of CodeDeployEcsDeployAction.Builder.

actionName

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

(experimental) The physical, human-readable name of the Action.

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

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

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

(experimental) The runOrder property for this Action.

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

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

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

variablesNamespace

@Stability(value=Experimental)
public CodeDeployEcsDeployAction.Builder variablesNamespace(String variablesNamespace)

(experimental) 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

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

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

(experimental) 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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

deploymentGroup

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

(experimental) The CodeDeploy ECS Deployment Group to deploy to.

Parameters:

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

Returns:

this

appSpecTemplateFile

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

(experimental) 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

Parameters:

appSpecTemplateFile - The name of the CodeDeploy AppSpec file. This parameter is required.

Returns:

this

appSpecTemplateInput

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

(experimental) 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

Parameters:

appSpecTemplateInput - The artifact containing the CodeDeploy AppSpec file. This parameter is required.

Returns:

this

containerImageInputs

@Stability(value=Experimental)
public CodeDeployEcsDeployAction.Builder containerImageInputs(List<? extends CodeDeployEcsContainerImageInput> containerImageInputs)

(experimental) 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.

Parameters:

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

Returns:

this

taskDefinitionTemplateFile

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

(experimental) 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

Parameters:

taskDefinitionTemplateFile - The name of the ECS task definition template file. This parameter is required.

Returns:

this

taskDefinitionTemplateInput

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

(experimental) 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

Parameters:

taskDefinitionTemplateInput - The artifact containing the ECS task definition template file. This parameter is required.

Returns:

this

build

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

Specified by:

build in interface software.amazon.jsii.Builder<CodeDeployEcsDeployAction>