Class CodeDeployServerDeployAction.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.CodeDeployServerDeployAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CodeDeployServerDeployAction>
Enclosing class:
CodeDeployServerDeployAction

@Stability(Stable) public static final class CodeDeployServerDeployAction.Builder extends Object implements software.amazon.jsii.Builder<CodeDeployServerDeployAction>
A fluent builder for CodeDeployServerDeployAction.
  • Method Details

    • create

      @Stability(Stable) public static CodeDeployServerDeployAction.Builder create()
      Returns:
      a new instance of CodeDeployServerDeployAction.Builder.
    • actionName

      @Stability(Stable) public CodeDeployServerDeployAction.Builder actionName(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

      @Stability(Stable) public CodeDeployServerDeployAction.Builder runOrder(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:
    • variablesNamespace

      @Stability(Stable) public CodeDeployServerDeployAction.Builder variablesNamespace(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

      @Stability(Stable) 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 IAction.bind method in the 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(Stable) 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

      @Stability(Stable) 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

      @Stability(Stable) public CodeDeployServerDeployAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CodeDeployServerDeployAction>
      Returns:
      a newly built instance of CodeDeployServerDeployAction.