Class: Aws::CodePipeline::Types::RuleConfigurationProperty

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

Overview

Represents information about a rule configuration property.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#keyBoolean

Whether the configuration property is a key.

Returns:

  • (Boolean)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the rule configuration property.

Returns:

  • (String)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#queryableBoolean

Indicates whether the property can be queried.

If you create a pipeline with a condition and rule, and that rule contains a queryable property, the value for that configuration property is subject to other 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)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#requiredBoolean

Whether the configuration property is a required value.

Returns:

  • (Boolean)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#secretBoolean

Whether the configuration property is secret.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

Returns:

  • (Boolean)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The type of the configuration property.

Returns:

  • (String)


4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 4425

class RuleConfigurationProperty < Struct.new(
  :name,
  :required,
  :key,
  :secret,
  :queryable,
  :description,
  :type)
  SENSITIVE = []
  include Aws::Structure
end