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.
Contents
- name
-
The name of the rule that is created for the condition, such as CheckAllResults.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[A-Za-z0-9.@\-_]+Required: Yes
- ruleTypeId
-
The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
Type: RuleTypeId object
Required: Yes
- configuration
-
The action configuration fields for the rule.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 200 items.
Key Length Constraints: Minimum length of 1. Maximum length of 50.
Value Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: No
- inputArtifacts
-
The input artifacts fields for the rule, such as specifying an input file for the rule.
Type: Array of InputArtifact objects
Required: No
- region
-
The Region for the condition associated with the rule.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 30.
Required: No
- roleArn
-
The pipeline role ARN associated with the rule.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*Required: No
- timeoutInMinutes
-
The action timeout for the rule.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 86400.
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: