Package software.amazon.awscdk.services.codepipeline

Interface CfnPipeline.RuleDeclarationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.RuleDeclarationProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

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

Represents information about the rule to be created for an associated condition.

An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. 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;
 RuleDeclarationProperty ruleDeclarationProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.RuleDeclarationProperty.Builder	builder()
default List<String>	getCommands()	The shell commands to run with your commands rule in CodePipeline.
default Object	getConfiguration()	The action configuration fields for the rule.
default Object	getInputArtifacts()	The input artifacts fields for the rule, such as specifying an input file for the rule.
default String	getName()	The name of the rule that is created for the condition, such as VariableCheck .
default String	getRegion()	The Region for the condition associated with the rule.
default String	getRoleArn()	The pipeline role ARN associated with the rule.
default Object	getRuleTypeId()	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCommands

@Stability(Stable)
@Nullable
default List<String> getCommands()

The shell commands to run with your commands rule in CodePipeline.

All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in AWS CodeBuild .

See Also:

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

getConfiguration

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

The action configuration fields for the rule.

See Also:

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

getInputArtifacts

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

The input artifacts fields for the rule, such as specifying an input file for the rule.

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

See Also:

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

getName

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

The name of the rule that is created for the condition, such as VariableCheck .

See Also:

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

getRegion

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

The Region for the condition associated with the rule.

See Also:

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

getRoleArn

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

The pipeline role ARN associated with the rule.

See Also:

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

getRuleTypeId

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

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Returns union: either IResolvable or CfnPipeline.RuleTypeIdProperty

See Also:

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

builder

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

Returns:

a CfnPipeline.RuleDeclarationProperty.Builder of CfnPipeline.RuleDeclarationProperty