Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.ConditionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.ConditionProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

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

The condition for the stage.

A condition is made up of the rules and the result for the condition. For more information about conditions, see Stage conditions and How do stage conditions work? .. For more information about rules, see the AWS CodePipeline rule reference .

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;
 ConditionProperty conditionProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.ConditionProperty.Builder	builder()
default String	getResult()	The action to be done when the condition is met.
default Object	getRules()	The rules that make up the condition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResult

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

The action to be done when the condition is met.

For example, rolling back an execution for a failure condition.

See Also:

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

getRules

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

The rules that make up the condition.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipeline.RuleDeclarationProperty>

See Also:

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

builder

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

Returns:

a CfnPipeline.ConditionProperty.Builder of CfnPipeline.ConditionProperty