You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CodePipeline::Types::ActionConfigurationProperty
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::ActionConfigurationProperty
- Defined in:
- (unknown)
Overview
When passing ActionConfigurationProperty as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "ActionConfigurationKey", # required
required: false, # required
key: false, # required
secret: false, # required
queryable: false,
description: "Description",
type: "String", # accepts String, Number, Boolean
}
Represents information about an action configuration property.
Instance Attribute Summary collapse
-
#description ⇒ String
The description of the action configuration property that is displayed to users.
-
#key ⇒ Boolean
Whether the configuration property is a key.
-
#name ⇒ String
The name of the action configuration property.
-
#queryable ⇒ Boolean
Indicates that the property is used with
PollForJobs
. -
#required ⇒ Boolean
Whether the configuration property is a required value.
-
#secret ⇒ Boolean
Whether the configuration property is secret.
-
#type ⇒ String
The type of the configuration property.
Instance Attribute Details
#description ⇒ String
The description of the action configuration property that is displayed to users.
#key ⇒ Boolean
Whether the configuration property is a key.
#name ⇒ String
The name of the action configuration property.
#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 ⇒ Boolean
Whether the configuration property is a required value.
#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 ⇒ String
The type of the configuration property.
Possible values:
- String
- Number
- Boolean