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

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 ActionTypeProperty data as a hash:

{
  name: "ActionConfigurationKey", # required
  optional: false, # required
  key: false, # required
  no_echo: false, # required
  queryable: false,
  description: "PropertyDescription",
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The description of the property that is displayed to users.

Returns:

  • (String)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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

#keyBoolean

Whether the configuration property is a key.

Returns:

  • (Boolean)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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

#nameString

The property name that is displayed to users.

Returns:

  • (String)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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

#no_echoBoolean

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)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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

#optionalBoolean

Whether the configuration property is an optional value.

Returns:

  • (Boolean)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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

#queryableBoolean

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)


1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 1137

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