software.amazon.awscdk.services.codepipeline.actions

Class EcsDeployAction.Builder

java.lang.Object

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

Enclosing class:

EcsDeployAction

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

A fluent builder for EcsDeployAction.

Method Summary

Modifier and Type	Method and Description
EcsDeployAction.Builder	actionName(String actionName)
EcsDeployAction	build()
static EcsDeployAction.Builder	create()
EcsDeployAction.Builder	imageFile(ArtifactPath imageFile)
EcsDeployAction.Builder	input(Artifact input)
EcsDeployAction.Builder	role(IRole role)
EcsDeployAction.Builder	runOrder(Number runOrder)
EcsDeployAction.Builder	service(BaseService service)

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 EcsDeployAction.Builder create()

Returns:

a new instance of EcsDeployAction.Builder.

actionName

@Stability(value=Stable)
public EcsDeployAction.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 EcsDeployAction.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 EcsDeployAction.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

service

@Stability(value=Stable)
public EcsDeployAction.Builder service(BaseService service)

Parameters:

service - The ECS Service to deploy. This parameter is required.

Returns:

this

imageFile

@Stability(value=Stable)
public EcsDeployAction.Builder imageFile(ArtifactPath imageFile)

Parameters:

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

Returns:

this

input

@Stability(value=Stable)
public EcsDeployAction.Builder input(Artifact input)

Parameters:

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

Returns:

this

build

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