Skip to content

RuleConfigurationProperty

Source code in docs_src/capo_codepipeline/types/rule_configuration_property.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class RuleConfigurationProperty(TypedDict, closed=True):
    name: "capo_codepipeline.types.rule_configuration_key.RuleConfigurationKey"
    """<p>The name of the rule configuration property.</p>"""
    required: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether the configuration property is a required value.</p>"""
    key: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether the configuration property is a key.</p>"""
    secret: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether the configuration property is secret.</p> <p>When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.</p>"""
    queryable: "capo_codepipeline.types.boolean.Boolean"
    """<p>Indicates whether the property can be queried.</p> <p>If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.</p>"""
    description: NotRequired["capo_codepipeline.types.description.Description"]
    """<p>The description of the action configuration property that is displayed to users.</p>"""
    type: NotRequired[
        "capo_codepipeline.types.rule_configuration_property_type.RuleConfigurationPropertyType"
    ]
    """<p>The type of the configuration property.</p>"""

description instance-attribute 

description: NotRequired[Description]

The description of the action configuration property that is displayed to users.

key instance-attribute 

key: Boolean

Whether the configuration property is a key.

name instance-attribute 

name: RuleConfigurationKey

The name of the rule configuration property.

queryable instance-attribute 

queryable: Boolean

Indicates whether the property can be queried.

If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

required instance-attribute 

required: Boolean

Whether the configuration property is a required value.

secret instance-attribute 

secret: Boolean

Whether the configuration property is secret.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

type instance-attribute 

type: NotRequired[RuleConfigurationPropertyType]

The type of the configuration property.