AWS::CodePipeline::Pipeline RuleDeclaration

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Configuration" : Json,
  "InputArtifacts" : [ InputArtifact, ... ],
  "Name" : String,
  "Region" : String,
  "RoleArn" : String,
  "RuleTypeId" : RuleTypeId
}

YAML

  Configuration: Json
  InputArtifacts: 
    - InputArtifact
  Name: String
  Region: String
  RoleArn: String
  RuleTypeId: 
    RuleTypeId

Properties

Configuration

The action configuration fields for the rule.

Required: No

Type: Json

Update requires: No interruption

InputArtifacts

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

Required: No

Type: Array of InputArtifact

Update requires: No interruption

Name

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

Required: No

Type: String

Pattern: [A-Za-z0-9.@\-_]+

Minimum: 1

Maximum: 100

Update requires: No interruption

Region

The Region for the condition associated with the rule.

Required: No

Type: String

Minimum: 4

Maximum: 30

Update requires: No interruption

RoleArn

The pipeline role ARN associated with the rule.

Required: No

Type: String

Pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*

Update requires: No interruption

RuleTypeId

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

Required: No

Type: RuleTypeId

Update requires: No interruption