Class: Aws::CodePipeline::Types::ActionConfigurationProperty
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::ActionConfigurationProperty
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-codepipeline/types.rb
Overview
When making an API call, you may pass ActionConfigurationProperty data as a 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 will be 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 will be used in conjunction 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 will be displayed to users.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |
#key ⇒ Boolean
Whether the configuration property is a key.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |
#name ⇒ String
The name of the action configuration property.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |
#queryable ⇒ Boolean
Indicates that the property will be used in conjunction 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 additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |
#required ⇒ Boolean
Whether the configuration property is a required value.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) 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 will preserve the prior value of the secret.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |
#type ⇒ String
The type of the configuration property.
205 206 207 208 209 210 211 212 213 214 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 205 class ActionConfigurationProperty < Struct.new( :name, :required, :key, :secret, :queryable, :description, :type) include Aws::Structure end |