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

Class: Aws::CloudFormation::Types::GetTemplateInput

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 GetTemplateInput data as a hash:

{
  stack_name: "StackName",
  change_set_name: "ChangeSetNameOrId",
  template_stage: "Original", # accepts Original, Processed
}

The input for a GetTemplate action.

Instance Attribute Summary collapse

Instance Attribute Details

#change_set_nameString

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

Returns:

  • (String)


2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2139

class GetTemplateInput < Struct.new(
  :stack_name,
  :change_set_name,
  :template_stage)
  include Aws::Structure
end

#stack_nameString

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Returns:

  • (String)


2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2139

class GetTemplateInput < Struct.new(
  :stack_name,
  :change_set_name,
  :template_stage)
  include Aws::Structure
end

#template_stageString

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

Returns:

  • (String)


2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2139

class GetTemplateInput < Struct.new(
  :stack_name,
  :change_set_name,
  :template_stage)
  include Aws::Structure
end