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

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

Overview

The input for the GetTemplateSummary action.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#call_as ⇒ String

[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 Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

Returns:

  • (String) 


4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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

#stack_name ⇒ String

The name or the stack ID that's associated with the stack, which aren't 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) 


4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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

#stack_set_name ⇒ String

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) 


4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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

#template_body ⇒ String

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 CloudFormation User Guide.

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

Returns:

  • (String) 


4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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

#template_summary_config ⇒ Types::TemplateSummaryConfig

Specifies options for the GetTemplateSummary API action.

Returns:



4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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

#template_url ⇒ String

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy in the CloudFormation User Guide. The location for an Amazon S3 bucket must start with https://.

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

Returns:

  • (String) 


4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
 
# File 'gems/aws-sdk-cloudformation/lib/aws-sdk-cloudformation/types.rb', line 4406

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