DescribeGeneratedTemplateResponse Class | AWS SDK for .NET Version 4

This is the response object from the DescribeGeneratedTemplate operation.

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.CloudFormation.Model.DescribeGeneratedTemplateResponse

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

Syntax

public class DescribeGeneratedTemplateResponse : AmazonWebServiceResponse

The DescribeGeneratedTemplateResponse type exposes the following members

Constructors

	Name	Description
	DescribeGeneratedTemplateResponse()

Properties

Name	Type	Description
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
CreationTime	System.Nullable<System.DateTime>	Gets and sets the property CreationTime. The time the generated template was created.
GeneratedTemplateId	System.String	Gets and sets the property GeneratedTemplateId. The Amazon Resource Name (ARN) of the generated template. The format is `arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}`. For example, `arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc`.
GeneratedTemplateName	System.String	Gets and sets the property GeneratedTemplateName. The name of the generated template.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
LastUpdatedTime	System.Nullable<System.DateTime>	Gets and sets the property LastUpdatedTime. The time the generated template was last updated.
Progress	Amazon.CloudFormation.Model.TemplateProgress	Gets and sets the property Progress. An object describing the progress of the template generation.
Resources	System.Collections.Generic.List<Amazon.CloudFormation.Model.ResourceDetail>	Gets and sets the property Resources. A list of objects describing the details of the resources in the template generation. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
StackId	System.String	Gets and sets the property StackId. The stack ARN of the base stack if a base stack was provided when generating the template.
Status	Amazon.CloudFormation.GeneratedTemplateStatus	Gets and sets the property Status. The status of the template generation. Supported values are: `CreatePending` - the creation of the template is pending. `CreateInProgress` - the creation of the template is in progress. `DeletePending` - the deletion of the template is pending. `DeleteInProgress` - the deletion of the template is in progress. `UpdatePending` - the update of the template is pending. `UpdateInProgress` - the update of the template is in progress. `Failed` - the template operation failed. `Complete` - the template operation is complete.
StatusReason	System.String	Gets and sets the property StatusReason. The reason for the current template generation status. This will provide more details if a failure happened.
TemplateConfiguration	Amazon.CloudFormation.Model.TemplateConfiguration	Gets and sets the property TemplateConfiguration. The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.
TotalWarnings	System.Nullable<System.Int32>	Gets and sets the property TotalWarnings. The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.

Examples

This example describes a generated template

To describe a generated template


var client = new AmazonCloudFormationClient();
var response = client.DescribeGeneratedTemplate(new DescribeGeneratedTemplateRequest 
{
    GeneratedTemplateName = "JazzyTemplate"
});

DateTime creationTime = response.CreationTime;
string generatedTemplateId = response.GeneratedTemplateId;
string generatedTemplateName = response.GeneratedTemplateName;
DateTime lastUpdatedTime = response.LastUpdatedTime;
TemplateProgress progress = response.Progress;
string status = response.Status;
string statusReason = response.StatusReason;
TemplateConfiguration templateConfiguration = response.TemplateConfiguration;
int totalWarnings = response.TotalWarnings;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer