interface RuleDeclarationProperty

Language	Type name
.NET	Amazon.CDK.AWS.CodePipeline.CfnPipeline.RuleDeclarationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscodepipeline#CfnPipeline_RuleDeclarationProperty
Java	software.amazon.awscdk.services.codepipeline.CfnPipeline.RuleDeclarationProperty
Python	aws_cdk.aws_codepipeline.CfnPipeline.RuleDeclarationProperty
TypeScript	aws-cdk-lib » aws_codepipeline » CfnPipeline » RuleDeclarationProperty

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codepipeline as codepipeline } from 'aws-cdk-lib';

declare const configuration: any;
const ruleDeclarationProperty: codepipeline.CfnPipeline.RuleDeclarationProperty = {
  configuration: configuration,
  inputArtifacts: [{
    name: 'name',
  }],
  name: 'name',
  region: 'region',
  roleArn: 'roleArn',
  ruleTypeId: {
    category: 'category',
    owner: 'owner',
    provider: 'provider',
    version: 'version',
  },
};

Properties

Name	Type	Description
configuration?	any	The action configuration fields for the rule.
inputArtifacts?	IResolvable | IResolvable | InputArtifactProperty[]	The input artifacts fields for the rule, such as specifying an input file for the rule.
name?	string	The name of the rule that is created for the condition, such as CheckAllResults.
region?	string	The Region for the condition associated with the rule.
roleArn?	string	The pipeline role ARN associated with the rule.
ruleTypeId?	IResolvable | RuleTypeIdProperty	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

---

configuration?

Type: any (optional)

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

---

inputArtifacts?

Type: IResolvable | IResolvable | InputArtifactProperty[] (optional)

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

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

---

name?

Type: string (optional)

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

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

---

region?

Type: string (optional)

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

---

roleArn?

Type: string (optional)

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

---

ruleTypeId?

Type: IResolvable | RuleTypeIdProperty (optional)

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

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