Class: Aws::ServiceCatalog::Types::ParameterConstraints

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::ParameterConstraints

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicecatalog/types.rb

Overview

The constraints that the administrator has put on the parameter.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_pattern ⇒ String

  A regular expression that represents the patterns that allow for ‘String` types.

• #allowed_values ⇒ Array<String>

  The values that the administrator has allowed for the parameter.

• #constraint_description ⇒ String

  A string that explains a constraint when the constraint is violated.

• #max_length ⇒ String

  An integer value that determines the largest number of characters you want to allow for ‘String` types.

• #max_value ⇒ String

  A numeric value that determines the largest numeric value you want to allow for ‘Number` types.

• #min_length ⇒ String

  An integer value that determines the smallest number of characters you want to allow for ‘String` types.

• #min_value ⇒ String

  A numeric value that determines the smallest numeric value you want to allow for ‘Number` types.

Instance Attribute Details

#allowed_pattern ⇒ String

A regular expression that represents the patterns that allow for ‘String` types. The pattern must match the entire parameter value provided.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#allowed_values ⇒ Array<String>

The values that the administrator has allowed for the parameter.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#constraint_description ⇒ String

A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of ‘[A-Za-z0-9]+` displays the following error message when the user specifies an invalid value:

‘Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+`

By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

‘Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.`

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#max_length ⇒ String

An integer value that determines the largest number of characters you want to allow for ‘String` types.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#max_value ⇒ String

A numeric value that determines the largest numeric value you want to allow for ‘Number` types.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#min_length ⇒ String

An integer value that determines the smallest number of characters you want to allow for ‘String` types.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end

#min_value ⇒ String

A numeric value that determines the smallest numeric value you want to allow for ‘Number` types.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 4193

class ParameterConstraints < Struct.new(
  :allowed_values,
  :allowed_pattern,
  :constraint_description,
  :max_length,
  :min_length,
  :max_value,
  :min_value)
  SENSITIVE = []
  include Aws::Structure
end