CustomActionProperty¶
-
class
aws_cdk.aws_codepipeline.
CustomActionProperty
(*, name, required, description=None, key=None, queryable=None, secret=None, type=None)¶ Bases:
object
The creation attributes used for defining a configuration property of a custom Action.
- Parameters
name (
str
) – The name of the property. You use this name in theconfiguration
attribute when defining your custom Action class.required (
bool
) – Whether this property is required.description (
Optional
[str
]) – The description of the property. Default: the description will be emptykey (
Optional
[bool
]) – Whether this property is a key. Default: falsequeryable (
Optional
[bool
]) – Whether this property is queryable. Note that only a single property of a custom Action can be queryable. Default: falsesecret (
Optional
[bool
]) – Whether this property is secret, like a password, or access key. Default: falsetype (
Optional
[str
]) – The type of the property, like ‘String’, ‘Number’, or ‘Boolean’. Default: ‘String’
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_codepipeline as codepipeline custom_action_property = codepipeline.CustomActionProperty( name="name", required=False, # the properties below are optional description="description", key=False, queryable=False, secret=False, type="type" )
Attributes
-
description
¶ The description of the property.
- Default
the description will be empty
- Return type
Optional
[str
]
-
key
¶ Whether this property is a key.
-
name
¶ The name of the property.
You use this name in the
configuration
attribute when defining your custom Action class.- Return type
str
-
queryable
¶ Whether this property is queryable.
Note that only a single property of a custom Action can be queryable.
-
required
¶ Whether this property is required.
- Return type
bool
-
secret
¶ Whether this property is secret, like a password, or access key.
- Default
false
- Return type
Optional
[bool
]
-
type
¶ The type of the property, like ‘String’, ‘Number’, or ‘Boolean’.
- Default
‘String’
- Return type
Optional
[str
]