GetTemplateSummaryRequest Class | AWS SDK for .NET V3

Container for the parameters to the GetTemplateSummary operation. Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template doesn't exist, a ValidationError is returned.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudFormation.AmazonCloudFormationRequest
      Amazon.CloudFormation.Model.GetTemplateSummaryRequest

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

public class GetTemplateSummaryRequest : AmazonCloudFormationRequest
         IAmazonWebServiceRequest

The GetTemplateSummaryRequest type exposes the following members

Constructors

	Name	Description
	GetTemplateSummaryRequest()

Properties

Name	Type	Description
CallAs	Amazon.CloudFormation.CallAs	Gets and sets the property CallAs. [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.
StackName	System.String	Gets and sets the property StackName. 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`.
StackSetName	System.String	Gets and sets the property StackSetName. 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`.
TemplateBody	System.String	Gets and sets the property TemplateBody. 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`.
TemplateSummaryConfig	Amazon.CloudFormation.Model.TemplateSummaryConfig	Gets and sets the property TemplateSummaryConfig. Specifies options for the `GetTemplateSummary` API action.
TemplateURL	System.String	Gets and sets the property TemplateURL. 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`.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5