Package software.amazon.awscdk.services.codepipeline.actions

Class EcsDeployActionProps.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.EcsDeployActionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<EcsDeployActionProps>
Enclosing interface:
EcsDeployActionProps
@Stability(Stable) public static final class EcsDeployActionProps.Builder extends Object implements software.amazon.jsii.Builder<EcsDeployActionProps>
A builder for EcsDeployActionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • service

      @Stability(Stable) public EcsDeployActionProps.Builder service(IBaseService service)
      Sets the value of EcsDeployActionProps.getService()
      Parameters:
      service - The ECS Service to deploy. This parameter is required.
      Returns:
      this

    • deploymentTimeout

      @Stability(Stable) public EcsDeployActionProps.Builder deploymentTimeout(Duration deploymentTimeout)
      Sets the value of EcsDeployActionProps.getDeploymentTimeout()
      Parameters:
      deploymentTimeout - Timeout for the ECS deployment in minutes. Value must be between 1-60.
      Returns:
      this

    • imageFile

      @Stability(Stable) public EcsDeployActionProps.Builder imageFile(ArtifactPath imageFile)
      Sets the value of EcsDeployActionProps.getImageFile()
      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.
      Returns:
      this

    • input

      @Stability(Stable) public EcsDeployActionProps.Builder input(Artifact input)
      Sets the value of EcsDeployActionProps.getInput()
      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.
      Returns:
      this

    • role

      @Stability(Stable) public EcsDeployActionProps.Builder role(IRole role)
      Sets the value of CommonAwsActionProps.getRole()
      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.
      Returns:
      this

    • actionName

      @Stability(Stable) public EcsDeployActionProps.Builder actionName(String actionName)
      Sets the value of CommonActionProps.getActionName()
      Parameters:
      actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.
      Returns:
      this

    • runOrder

      @Stability(Stable) public EcsDeployActionProps.Builder runOrder(Number runOrder)
      Sets the value of CommonActionProps.getRunOrder()
      Parameters:
      runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.
      Returns:
      this

    • variablesNamespace

      @Stability(Stable) public EcsDeployActionProps.Builder variablesNamespace(String variablesNamespace)
      Sets the value of CommonActionProps.getVariablesNamespace()
      Parameters:
      variablesNamespace - The name of the namespace to use for variables emitted by this action.
      Returns:
      this

    • build

      @Stability(Stable) public EcsDeployActionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<EcsDeployActionProps>
      Returns:
      a new instance of EcsDeployActionProps
      Throws:
      NullPointerException - if any required attribute was not provided