Skip to content

RuleDeclaration

Source code in docs_src/capo_codepipeline/types/rule_declaration.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class RuleDeclaration(TypedDict, closed=True):
    name: "capo_codepipeline.types.rule_name.RuleName"
    """<p>The name of the rule that is created for the condition, such as <code>VariableCheck</code>.</p>"""
    rule_type_id: "capo_codepipeline.types.rule_type_id.RuleTypeId"
    """<p>The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.</p>"""
    configuration: NotRequired[
        "capo_codepipeline.types.rule_configuration_map.RuleConfigurationMap"
    ]
    """<p>The action configuration fields for the rule.</p>"""
    commands: NotRequired["capo_codepipeline.types.command_list.CommandList"]
    """<p>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.</p> <note> <p>Using compute time for this action will incur separate charges in CodeBuild.</p> </note>"""
    input_artifacts: NotRequired[
        "capo_codepipeline.types.input_artifact_list.InputArtifactList"
    ]
    """<p>The input artifacts fields for the rule, such as specifying an input file for the rule.</p>"""
    role_arn: NotRequired["capo_codepipeline.types.role_arn.RoleArn"]
    """<p>The pipeline role ARN associated with the rule.</p>"""
    region: NotRequired["capo_codepipeline.types.aws_region_name.AWSRegionName"]
    """<p>The Region for the condition associated with the rule.</p>"""
    timeout_in_minutes: NotRequired["capo_codepipeline.types.rule_timeout.RuleTimeout"]
    """<p>The action timeout for the rule.</p>"""

commands instance-attribute 

commands: NotRequired[CommandList]

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 CodeBuild.

configuration instance-attribute 

configuration: NotRequired[RuleConfigurationMap]

The action configuration fields for the rule.

input_artifacts instance-attribute 

input_artifacts: NotRequired[InputArtifactList]

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

name instance-attribute 

name: RuleName

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

region instance-attribute 

region: NotRequired[AWSRegionName]

The Region for the condition associated with the rule.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

The pipeline role ARN associated with the rule.

rule_type_id instance-attribute 

rule_type_id: RuleTypeId

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

timeout_in_minutes instance-attribute 

timeout_in_minutes: NotRequired[RuleTimeout]

The action timeout for the rule.