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

Class CodeDeployEcsDeployActionProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • deploymentGroup

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder deploymentGroup(IEcsDeploymentGroup deploymentGroup)
      Sets the value of CodeDeployEcsDeployActionProps.getDeploymentGroup()
      Parameters:
      deploymentGroup - The CodeDeploy ECS Deployment Group to deploy to. This parameter is required.
      Returns:
      this

    • appSpecTemplateFile

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder appSpecTemplateFile(ArtifactPath appSpecTemplateFile)
      Sets the value of CodeDeployEcsDeployActionProps.getAppSpecTemplateFile()
      Parameters:
      appSpecTemplateFile - 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.

      Returns:
      this

    • appSpecTemplateInput

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder appSpecTemplateInput(Artifact appSpecTemplateInput)
      Sets the value of CodeDeployEcsDeployActionProps.getAppSpecTemplateInput()
      Parameters:
      appSpecTemplateInput - 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.

      Returns:
      this

    • containerImageInputs

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder containerImageInputs(List<? extends CodeDeployEcsContainerImageInput> containerImageInputs)
      Sets the value of CodeDeployEcsDeployActionProps.getContainerImageInputs()
      Parameters:
      containerImageInputs - 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.
      Returns:
      this

    • taskDefinitionTemplateFile

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateFile(ArtifactPath taskDefinitionTemplateFile)
      Sets the value of CodeDeployEcsDeployActionProps.getTaskDefinitionTemplateFile()
      Parameters:
      taskDefinitionTemplateFile - 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.

      Returns:
      this

    • taskDefinitionTemplateInput

      @Stability(Stable) public CodeDeployEcsDeployActionProps.Builder taskDefinitionTemplateInput(Artifact taskDefinitionTemplateInput)
      Sets the value of CodeDeployEcsDeployActionProps.getTaskDefinitionTemplateInput()
      Parameters:
      taskDefinitionTemplateInput - 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.

      Returns:
      this

    • role

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