AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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",
  call_as: "SELF", # accepts SELF, DELEGATED_ADMIN
}

The input for the GetTemplateSummary action.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#call_asString

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide.

Returns:

  • (String)


3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3576

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end

#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)


3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3576

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  SENSITIVE = []
  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)


3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3576

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  SENSITIVE = []
  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)


3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3576

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  SENSITIVE = []
  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 or a Systems Manager document. 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)


3576
3577
3578
3579
3580
3581
3582
3583
3584
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 3576

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  SENSITIVE = []
  include Aws::Structure
end