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

Inherits:

Struct

• Object
• Struct
• Aws::CloudFormation::Types::GetTemplateSummaryInput

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #stack_name ⇒ String

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

• #stack_set_name ⇒ String

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

• #template_body ⇒ String

  Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

• #template_url ⇒ String

  Location of file containing the template body.

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][1

  in the *CloudFormation

  User Guide*.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4092

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

#stack_name ⇒ String

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)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4092

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

# File 'lib/aws-sdk-cloudformation/types.rb', line 4092

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

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4092

class GetTemplateSummaryInput < Struct.new(
  :template_body,
  :template_url,
  :stack_name,
  :stack_set_name,
  :call_as)
  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 is located in an Amazon S3 bucket or a Systems Manager document. 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`.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudformation/types.rb', line 4092

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