Package software.amazon.awscdk.pipelines

Interface StageDeploymentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StageDeploymentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.303Z")
@Stability(Stable)
public interface StageDeploymentProps
extends software.amazon.jsii.JsiiSerializable

Properties for a StageDeployment.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.pipelines.*;
 Stack stack;
 Step step;
 StageDeploymentProps stageDeploymentProps = StageDeploymentProps.builder()
         .post(List.of(step))
         .pre(List.of(step))
         .stackSteps(List.of(StackSteps.builder()
                 .stack(stack)
                 // the properties below are optional
                 .changeSet(List.of(step))
                 .post(List.of(step))
                 .pre(List.of(step))
                 .build()))
         .stageName("stageName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StageDeploymentProps.Builder	A builder for StageDeploymentProps
static final class	StageDeploymentProps.Jsii$Proxy	An implementation for StageDeploymentProps

Method Summary

Modifier and Type	Method	Description
static StageDeploymentProps.Builder	builder()
default List<Step>	getPost()	Additional steps to run after all of the stacks in the stage.
default List<Step>	getPre()	Additional steps to run before any of the stacks in the stage.
default List<StackSteps>	getStackSteps()	Instructions for additional steps that are run at the stack level.
default String	getStageName()	Stage name to use in the pipeline.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPost

@Stability(Stable)
@Nullable
default List<Step> getPost()

Additional steps to run after all of the stacks in the stage.

Default: - No additional steps

getPre

@Stability(Stable)
@Nullable
default List<Step> getPre()

Additional steps to run before any of the stacks in the stage.

Default: - No additional steps

getStackSteps

@Stability(Stable)
@Nullable
default List<StackSteps> getStackSteps()

Instructions for additional steps that are run at the stack level.

Default: - No additional instructions

getStageName

@Stability(Stable)
@Nullable
default String getStageName()

Stage name to use in the pipeline.

Default: - Use Stage's construct ID

builder

@Stability(Stable)
static StageDeploymentProps.Builder builder()

Returns:

a StageDeploymentProps.Builder of StageDeploymentProps