You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::ActionConfigurationProperty

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

Note:

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

Instance Attribute Details

#descriptionString

The description of the action configuration property that will be displayed to users.

Returns:

  • (String)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#keyBoolean

Whether the configuration property is a key.

Returns:

  • (Boolean)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#nameString

The name of the action configuration property.

Returns:

  • (String)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#queryableBoolean

Indicates that the proprety 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.

Returns:

  • (Boolean)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#requiredBoolean

Whether the configuration property is a required value.

Returns:

  • (Boolean)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#secretBoolean

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.

Returns:

  • (Boolean)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end

#typeString

The type of the configuration property.

Returns:

  • (String)


205
206
207
208
209
210
211
212
213
214
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 205

class ActionConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  include Aws::Structure
end