Skip to content

ActionTypeProperty

Source code in docs_src/capo_codepipeline/types/action_type_property.py
class ActionTypeProperty(TypedDict, closed=True):
    name: "capo_codepipeline.types.action_configuration_key.ActionConfigurationKey"
    """<p>The property name that is displayed to users.</p>"""
    optional: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether the configuration property is an optional value.</p>"""
    key: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether the configuration property is a key.</p>"""
    no_echo: "capo_codepipeline.types.boolean.Boolean"
    """<p>Whether to omit the field value entered by the customer in the log. If <code>true</code>, the value is not saved in CloudTrail logs for the action execution.</p>"""
    queryable: "capo_codepipeline.types.boolean.Boolean"
    """<p>Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.</p>"""
    description: NotRequired[
        "capo_codepipeline.types.property_description.PropertyDescription"
    ]
    """<p>The description of the property that is displayed to users.</p>"""

description instance-attribute

description: NotRequired[PropertyDescription]

The description of the property that is displayed to users.

key instance-attribute

key: Boolean

Whether the configuration property is a key.

name instance-attribute

The property name that is displayed to users.

no_echo instance-attribute

no_echo: Boolean

Whether to omit the field value entered by the customer in the log. If true, the value is not saved in CloudTrail logs for the action execution.

optional instance-attribute

optional: Boolean

Whether the configuration property is an optional value.

queryable instance-attribute

queryable: Boolean

Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.