Class: Aws::CloudFormation::Types::Parameter

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudformation/types.rb

Overview

Note:

When making an API call, you may pass Parameter data as a hash:

{
  parameter_key: "ParameterKey",
  parameter_value: "ParameterValue",
  use_previous_value: false,
  resolved_value: "ParameterValue",
}

The Parameter data type.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#parameter_key ⇒ String

The key associated with the parameter. If you don’t specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

Returns:

  • (String) 


3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 3308

class Parameter < Struct.new(
  :parameter_key,
  :parameter_value,
  :use_previous_value,
  :resolved_value)
  include Aws::Structure
end

#parameter_value ⇒ String

The input value associated with the parameter.

Returns:

  • (String) 


3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 3308

class Parameter < Struct.new(
  :parameter_key,
  :parameter_value,
  :use_previous_value,
  :resolved_value)
  include Aws::Structure
end

#resolved_value ⇒ String

Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for [ ‘SSM` parameter types] in the template.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types

Returns:

  • (String) 


3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 3308

class Parameter < Struct.new(
  :parameter_key,
  :parameter_value,
  :use_previous_value,
  :resolved_value)
  include Aws::Structure
end

#use_previous_value ⇒ Boolean

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ‘true`, do not specify a parameter value.

Returns:

  • (Boolean) 


3308
3309
3310
3311
3312
3313
3314
 
# File 'lib/aws-sdk-cloudformation/types.rb', line 3308

class Parameter < Struct.new(
  :parameter_key,
  :parameter_value,
  :use_previous_value,
  :resolved_value)
  include Aws::Structure
end