software.amazon.awscdk.services.codepipeline.actions

Class CodeDeployServerDeployAction.Builder

java.lang.Object

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

Enclosing class:

CodeDeployServerDeployAction

public static final class CodeDeployServerDeployAction.Builder
extends java.lang.Object

A fluent builder for CodeDeployServerDeployAction.

Method Summary

Modifier and Type	Method and Description
CodeDeployServerDeployAction.Builder	actionName(java.lang.String actionName) The physical, human-readable name of the Action.
CodeDeployServerDeployAction	build()
static CodeDeployServerDeployAction.Builder	create()
CodeDeployServerDeployAction.Builder	deploymentGroup(IServerDeploymentGroup deploymentGroup) The CodeDeploy server Deployment Group to deploy to.
CodeDeployServerDeployAction.Builder	input(Artifact input) The source to use as input for deployment.
CodeDeployServerDeployAction.Builder	role(IRole role) The Role in which context's this Action will be executing in.
CodeDeployServerDeployAction.Builder	runOrder(java.lang.Number runOrder) The runOrder property for this Action.
CodeDeployServerDeployAction.Builder	variablesNamespace(java.lang.String variablesNamespace) 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

public static CodeDeployServerDeployAction.Builder create()

Returns:

a new instance of CodeDeployServerDeployAction.Builder.

actionName

public CodeDeployServerDeployAction.Builder actionName(java.lang.String actionName)

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

public CodeDeployServerDeployAction.Builder runOrder(java.lang.Number runOrder)

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

public CodeDeployServerDeployAction.Builder variablesNamespace(java.lang.String variablesNamespace)

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

public CodeDeployServerDeployAction.Builder role(IRole 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 {@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

public CodeDeployServerDeployAction.Builder deploymentGroup(IServerDeploymentGroup deploymentGroup)

The CodeDeploy server Deployment Group to deploy to.

Parameters:

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

Returns:

this

input

public CodeDeployServerDeployAction.Builder input(Artifact input)

The source to use as input for deployment.

Parameters:

input - The source to use as input for deployment. This parameter is required.

Returns:

this

build

public CodeDeployServerDeployAction build()