Class: Aws::CodePipeline::Types::ActionConfigurationProperty
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::ActionConfigurationProperty
- Defined in:
- gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb
Overview
Represents information about an action configuration property.
Constant Summary collapse
- SENSITIVE =
[]
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.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#key ⇒ Boolean
Whether the configuration property is a key.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the action configuration property.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#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.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#required ⇒ Boolean
Whether the configuration property is a required value.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#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.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of the configuration property.
183 184 185 186 187 188 189 190 191 192 193 |
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 183 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) SENSITIVE = [] include Aws::Structure end |