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

Inherits:

Struct

• Object
• Struct
• Aws::CodePipeline::Types::RuleConfigurationProperty

Includes:

Structure

Defined in:

lib/aws-sdk-codepipeline/types.rb

Overview

Represents information about a rule configuration property.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

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

• #key ⇒ Boolean

  Whether the configuration property is a key.

• #name ⇒ String

  The name of the rule configuration property.

• #queryable ⇒ Boolean

  Indicates whether the property can be queried.

• #required ⇒ Boolean

  Whether the configuration property is a required value.

• #secret ⇒ Boolean

  Whether the configuration property is secret.

• #type ⇒ String

  The type of the configuration property.

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

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

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

#key ⇒ Boolean

Whether the configuration property is a key.

Returns:

• (Boolean)

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

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

#name ⇒ String

The name of the rule configuration property.

Returns:

• (String)

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

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

#queryable ⇒ Boolean

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)

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

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

#required ⇒ Boolean

Whether the configuration property is a required value.

Returns:

• (Boolean)

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

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

#secret ⇒ Boolean

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)

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

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

#type ⇒ String

The type of the configuration property.

Returns:

• (String)

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

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