You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ServerlessApplicationRepository::Types::ParameterDefinition

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

Overview

Parameters supported by the application.

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_patternString

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

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#allowed_valuesArray<String>

Array containing the list of values allowed for the parameter.

Returns:

  • (Array<String>)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#constraint_descriptionString

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 contain only uppercase and lowercase letters, and numbers," you can display the following customized error message:

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

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#default_valueString

A value of the appropriate type for the template to use if no value is specified when a stack is created. If you define constraints for the parameter, you must specify a value that adheres to those constraints.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#descriptionString

A string of up to 4,000 characters that describes the parameter.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#max_lengthInteger

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

Returns:

  • (Integer)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#max_valueInteger

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

Returns:

  • (Integer)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#min_lengthInteger

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

Returns:

  • (Integer)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#min_valueInteger

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

Returns:

  • (Integer)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#nameString

The name of the parameter.

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#no_echoBoolean

Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the value to true, the parameter value is masked with asterisks (*****).

Returns:

  • (Boolean)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#referenced_by_resourcesArray<String>

A list of AWS SAM resources that use this parameter.

Returns:

  • (Array<String>)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end

#typeString

The type of the parameter.

Valid values: String | Number | List<Number> | CommaDelimitedList

String: A literal string.

For example, users could specify "MyUserName".

Number: An integer or float. AWS CloudFormation validates the parameter value as a number; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

For example, users could specify "8888".

List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers; however, when you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

For example, users could specify "80,20", and a Ref results in ["80","20"].

CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas. Also, each member string is space-trimmed.

For example, users could specify "test,dev,prod", and a Ref results in ["test","dev","prod"].

Returns:

  • (String)


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
# File 'gems/aws-sdk-serverlessapplicationrepository/lib/aws-sdk-serverlessapplicationrepository/types.rb', line 1012

class ParameterDefinition < Struct.new(
  :allowed_pattern,
  :allowed_values,
  :constraint_description,
  :default_value,
  :description,
  :max_length,
  :max_value,
  :min_length,
  :min_value,
  :name,
  :no_echo,
  :referenced_by_resources,
  :type)
  include Aws::Structure
end