UpdateGeneratedTemplate
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources,
and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of
the update to the generated template using the DescribeGeneratedTemplate API action.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AddResources.member.N
-
An optional list of resources to be added to the generated template.
Type: Array of ResourceDefinition objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- GeneratedTemplateName
-
The name or Amazon Resource Name (ARN) of a generated template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- NewGeneratedTemplateName
-
An optional new name to assign to the generated template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- RefreshAllResources
-
If
true, update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.Type: Boolean
Required: No
- RemoveResources.member.N
-
A list of logical ids for resources to remove from the generated template.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 500 items.
Required: No
- TemplateConfiguration
-
The configuration details of the generated template, including the
DeletionPolicyandUpdateReplacePolicy.Type: TemplateConfiguration object
Required: No
Response Elements
The following element is returned by the service.
- 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.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExists
-
The resource with the name requested already exists.
HTTP Status Code: 400
- GeneratedTemplateNotFound
-
The generated template was not found.
HTTP Status Code: 404
- LimitExceeded
-
The quota for the resource has already been reached.
For information about resource and stack limitations, see AWS CloudFormation quotas in the AWS CloudFormation User Guide.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
