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

Interface Ec2DeployActionProps

All Superinterfaces:
CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
Ec2DeployActionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:17.166Z") @Stability(Stable) public interface Ec2DeployActionProps extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps
Construction properties of Ec2DeployAction.

Example: 

 Artifact sourceOutput = new Artifact();
 Pipeline pipeline = Pipeline.Builder.create(this, "MyPipeline")
         .pipelineType(PipelineType.V2)
         .build();
 Ec2DeployAction deployAction = Ec2DeployAction.Builder.create()
         .actionName("Ec2Deploy")
         .input(sourceOutput)
         .instanceType(Ec2InstanceType.EC2)
         .instanceTagKey("Name")
         .instanceTagValue("MyInstance")
         .deploySpecifications(Ec2DeploySpecifications.inline(Ec2DeploySpecificationsInlineProps.builder()
                 .targetDirectory("/home/ec2-user/deploy")
                 .preScript("scripts/pre-deploy.sh")
                 .postScript("scripts/post-deploy.sh")
                 .build()))
         .build();
 IStage deployStage = pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(deployAction))
         .build());

  • Method Details

    • getDeploySpecifications

      @Stability(Stable) @NotNull Ec2DeploySpecifications getDeploySpecifications()
      The deploy specifications.

    • getInput

      @Stability(Stable) @NotNull Artifact getInput()
      The input artifact to deploy to EC2 instances.

    • getInstanceTagKey

      @Stability(Stable) @NotNull String getInstanceTagKey()
      The tag key of the instances that you created in Amazon EC2.

    • getInstanceType

      @Stability(Stable) @NotNull Ec2InstanceType getInstanceType()
      The type of instances or SSM nodes created in Amazon EC2.

      You must have already created, tagged, and installed the SSM agent on all instances.

    • getInstanceTagValue

      @Stability(Stable) @Nullable default String getInstanceTagValue()
      The tag value of the instances that you created in Amazon EC2.

      Default: - all instances with `instanceTagKey` will be matched

    • getMaxBatch

      @Stability(Stable) @Nullable default Ec2MaxInstances getMaxBatch()
      The number or percentage of instances that can deploy in parallel.

      Default: - No configuration

    • getMaxError

      @Stability(Stable) @Nullable default Ec2MaxInstances getMaxError()
      Stop the task after the task fails on the specified number or percentage of instances.

      Default: - No configuration

    • getTargetGroups

      @Stability(Stable) @Nullable default List<ITargetGroup> getTargetGroups()
      The list of target groups for deployment. You must have already created the target groups.

      Target groups provide a set of instances to process specific requests. If the target group is specified, instances will be removed from the target group before deployment and added back to the target group after deployment.

      Default: - No target groups

    • builder

      @Stability(Stable) static Ec2DeployActionProps.Builder builder()
      Returns:
      a Ec2DeployActionProps.Builder of Ec2DeployActionProps