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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)

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

#keyBoolean

Whether the configuration property is a key.

Returns:

  • (Boolean)

    Whether the configuration property is a key.

#nameString

The name of the action configuration property.

Returns:

  • (String)

    The name of the action configuration property.

#queryableBoolean

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.

Returns:

  • (Boolean)

    Indicates that the property will be used in conjunction with PollForJobs.

#requiredBoolean

Whether the configuration property is a required value.

Returns:

  • (Boolean)

    Whether the configuration property is a required value.

#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)

    Whether the configuration property is secret.

#typeString

The type of the configuration property.

Possible values:

  • String
  • Number
  • Boolean

Returns:

  • (String)

    The type of the configuration property.