Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.StageDeclarationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.StageDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.StageDeclarationProperty
extends software.amazon.jsii.JsiiSerializable

Represents information about a stage and its definition.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codepipeline.*;
 Object configuration;
 StageDeclarationProperty stageDeclarationProperty = StageDeclarationProperty.builder()
         .actions(List.of(ActionDeclarationProperty.builder()
                 .actionTypeId(ActionTypeIdProperty.builder()
                         .category("category")
                         .owner("owner")
                         .provider("provider")
                         .version("version")
                         .build())
                 .name("name")
                 // the properties below are optional
                 .commands(List.of("commands"))
                 .configuration(configuration)
                 .inputArtifacts(List.of(InputArtifactProperty.builder()
                         .name("name")
                         .build()))
                 .namespace("namespace")
                 .outputArtifacts(List.of(OutputArtifactProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .files(List.of("files"))
                         .build()))
                 .outputVariables(List.of("outputVariables"))
                 .region("region")
                 .roleArn("roleArn")
                 .runOrder(123)
                 .timeoutInMinutes(123)
                 .build()))
         .name("name")
         // the properties below are optional
         .beforeEntry(BeforeEntryConditionsProperty.builder()
                 .conditions(List.of(ConditionProperty.builder()
                         .result("result")
                         .rules(List.of(RuleDeclarationProperty.builder()
                                 .commands(List.of("commands"))
                                 .configuration(configuration)
                                 .inputArtifacts(List.of(InputArtifactProperty.builder()
                                         .name("name")
                                         .build()))
                                 .name("name")
                                 .region("region")
                                 .roleArn("roleArn")
                                 .ruleTypeId(RuleTypeIdProperty.builder()
                                         .category("category")
                                         .owner("owner")
                                         .provider("provider")
                                         .version("version")
                                         .build())
                                 .build()))
                         .build()))
                 .build())
         .blockers(List.of(BlockerDeclarationProperty.builder()
                 .name("name")
                 .type("type")
                 .build()))
         .onFailure(FailureConditionsProperty.builder()
                 .conditions(List.of(ConditionProperty.builder()
                         .result("result")
                         .rules(List.of(RuleDeclarationProperty.builder()
                                 .commands(List.of("commands"))
                                 .configuration(configuration)
                                 .inputArtifacts(List.of(InputArtifactProperty.builder()
                                         .name("name")
                                         .build()))
                                 .name("name")
                                 .region("region")
                                 .roleArn("roleArn")
                                 .ruleTypeId(RuleTypeIdProperty.builder()
                                         .category("category")
                                         .owner("owner")
                                         .provider("provider")
                                         .version("version")
                                         .build())
                                 .build()))
                         .build()))
                 .result("result")
                 .retryConfiguration(RetryConfigurationProperty.builder()
                         .retryMode("retryMode")
                         .build())
                 .build())
         .onSuccess(SuccessConditionsProperty.builder()
                 .conditions(List.of(ConditionProperty.builder()
                         .result("result")
                         .rules(List.of(RuleDeclarationProperty.builder()
                                 .commands(List.of("commands"))
                                 .configuration(configuration)
                                 .inputArtifacts(List.of(InputArtifactProperty.builder()
                                         .name("name")
                                         .build()))
                                 .name("name")
                                 .region("region")
                                 .roleArn("roleArn")
                                 .ruleTypeId(RuleTypeIdProperty.builder()
                                         .category("category")
                                         .owner("owner")
                                         .provider("provider")
                                         .version("version")
                                         .build())
                                 .build()))
                         .build()))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.StageDeclarationProperty.Builder	builder()
Object	getActions()	The actions included in a stage.
default Object	getBeforeEntry()	The method to use when a stage allows entry.
default Object	getBlockers()	Reserved for future use.
String	getName()	The name of the stage.
default Object	getOnFailure()	The method to use when a stage has not completed successfully.
default Object	getOnSuccess()	The method to use when a stage has succeeded.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The actions included in a stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-actions

getName

@Stability(Stable)
@NotNull
String getName()

The name of the stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-name

getBeforeEntry

@Stability(Stable)
@Nullable
default Object getBeforeEntry()

The method to use when a stage allows entry.

For example, configuring this field for conditions will allow entry to the stage when the conditions are met.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-beforeentry

getBlockers

@Stability(Stable)
@Nullable
default Object getBlockers()

Reserved for future use.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-blockers

getOnFailure

@Stability(Stable)
@Nullable
default Object getOnFailure()

The method to use when a stage has not completed successfully.

For example, configuring this field for rollback will roll back a failed stage automatically to the last successful pipeline execution in the stage.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onfailure

getOnSuccess

@Stability(Stable)
@Nullable
default Object getOnSuccess()

The method to use when a stage has succeeded.

For example, configuring this field for conditions will allow the stage to succeed when the conditions are met.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codepipeline-pipeline-stagedeclaration.html#cfn-codepipeline-pipeline-stagedeclaration-onsuccess

builder

@Stability(Stable)
static CfnPipeline.StageDeclarationProperty.Builder builder()

Returns:

a CfnPipeline.StageDeclarationProperty.Builder of CfnPipeline.StageDeclarationProperty