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

Class: Aws::CloudFormation::Types::GetTemplateSummaryInput

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

{
  template_body: "TemplateBody",
  template_url: "TemplateURL",
  stack_name: "StackNameOrId",
  stack_set_name: "StackSetNameOrId",
}

The input for the GetTemplateSummary action.

Instance Attribute Summary collapse

Instance Attribute Details

#stack_nameString

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Returns:

  • (String)


2183
2184
2185
2186
2187
2188
2189
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2183

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name)
  include Aws::Structure
end

#stack_set_nameString

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Returns:

  • (String)


2183
2184
2185
2186
2187
2188
2189
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2183

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name)
  include Aws::Structure
end

#template_bodyString

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Returns:

  • (String)


2183
2184
2185
2186
2187
2188
2189
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2183

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name)
  include Aws::Structure
end

#template_urlString

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

Returns:

  • (String)


2183
2184
2185
2186
2187
2188
2189
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 2183

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name)
  include Aws::Structure
end