Class: Aws::CodePipeline::Types::ActionTypeProperty

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::ActionTypeProperty

Includes:

Structure

Defined in:

lib/aws-sdk-codepipeline/types.rb

Overview

Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The description of the property that is displayed to users.

• #key ⇒ Boolean

  Whether the configuration property is a key.

• #name ⇒ String

  The property name that is displayed to users.

• #no_echo ⇒ Boolean

  Whether to omit the field value entered by the customer in the log.

• #optional ⇒ Boolean

  Whether the configuration property is an optional value.

• #queryable ⇒ Boolean

  Indicates that the property is used with polling.

Instance Attribute Details

#description ⇒ String

The description of the property that is displayed to users.

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ Boolean

Whether the configuration property is a key.

Returns:

• (Boolean)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The property name that is displayed to users.

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#no_echo ⇒ Boolean

Whether to omit the field value entered by the customer in the log. If ‘true`, the value is not saved in CloudTrail logs for the action execution.

Returns:

• (Boolean)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#optional ⇒ Boolean

Whether the configuration property is an optional value.

Returns:

• (Boolean)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#queryable ⇒ Boolean

Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.

Returns:

• (Boolean)

# File 'lib/aws-sdk-codepipeline/types.rb', line 965

class ActionTypeProperty < Struct.new(
  :name,
  :optional,
  :key,
  :no_echo,
  :queryable,
  :description)
  SENSITIVE = []
  include Aws::Structure
end