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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudformation/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,
}

The Parameter data type.

Instance Attribute Summary collapse

Instance Attribute Details

#parameter_keyString

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)


2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2724

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

#parameter_valueString

The value associated with the parameter.

Returns:

  • (String)


2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2724

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

#use_previous_valueBoolean

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)


2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2724

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