update_generated_template¶
Operation¶
async
¶
update_generated_template(input: UpdateGeneratedTemplateInput, plugins: list[Plugin] | None = None) -> UpdateGeneratedTemplateOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateGeneratedTemplateInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateGeneratedTemplateOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGeneratedTemplateInput structure.
Attributes¶
class-attribute
instance-attribute
¶
add_resources: list[ResourceDefinition] | None = ...
An optional list of resources to be added to the generated template.
class-attribute
instance-attribute
¶
generated_template_name: str | None = ...
The name or Amazon Resource Name (ARN) of a generated template.
class-attribute
instance-attribute
¶
new_generated_template_name: str | None = ...
An optional new name to assign to the generated template.
class-attribute
instance-attribute
¶
refresh_all_resources: bool | None = ...
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.
class-attribute
instance-attribute
¶
A list of logical ids for resources to remove from the generated template.
class-attribute
instance-attribute
¶
The configuration details of the generated template, including the
DeletionPolicy and UpdateReplacePolicy.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateGeneratedTemplateOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
generated_template_id: str | None = ...
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.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.