Skip to content

ActionConfigurationProperty

Source code in docs_src/capo_codepipeline/types/action_configuration_property.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class ActionConfigurationProperty(TypedDict, closed=True):
    name: "capo_codepipeline.types.action_configuration_key.ActionConfigurationKey"
    """<p>The name of the action 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. Secrets are hidden from all calls except for <code>GetJobDetails</code>, <code>GetThirdPartyJobDetails</code>, <code>PollForJobs</code>, and <code>PollForThirdPartyJobs</code>.</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 that the property is used with <code>PollForJobs</code>. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.</p> <p>If you create a pipeline with a custom action type, and that custom action 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.action_configuration_property_type.ActionConfigurationPropertyType"
    ]
    """<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: ActionConfigurationKey

The name of the action configuration property.

queryable instance-attribute 

queryable: Boolean

Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action 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. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

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[ActionConfigurationPropertyType]

The type of the configuration property.