stack_refactor_actions
Creates, updates, deletes, gets or lists a stack_refactor_actions resource.
Overview
| Name | stack_refactor_actions |
| Type | Resource |
| Id | aws.cloudformation.stack_refactor_actions |
Fields
The following fields are returned by SELECT queries:
- list_stack_refactor_actions
| Name | Datatype | Description |
|---|---|---|
action | string | The action that CloudFormation takes on the stack. |
description | string | A description to help you identify the refactor. |
detection | string | The detection type is one of the following: Auto: CloudFormation figured out the mapping on its own. Manual: The customer provided the mapping in the ResourceMapping parameter. |
detection_reason | string | The description of the detection type. |
entity | string | The type that will be evaluated in the StackRefactorAction. The following are potential Entity types: Stack Resource |
physical_resource_id | string | The name or unique identifier associated with the physical instance of the resource. |
resource_identifier | string | A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket). |
resource_mapping | string | The mapping for the stack resource Source and stack resource Destination. |
tag_resources | string | Assigns one or more tags to specified resources. |
untag_resources | string | Removes one or more tags to specified resources. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_stack_refactor_actions | select | StackRefactorId, region | NextToken, MaxResults | Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
StackRefactorId | string | The ID associated with the stack refactor created from the CreateStackRefactor action. |
region | string | AWS region (default: us-east-1) |
MaxResults | integer | The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results. |
NextToken | string | The token for the next set of items to return. (You received this token from a previous call.) |
SELECT examples
- list_stack_refactor_actions
Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.
SELECT
action,
description,
detection,
detection_reason,
entity,
physical_resource_id,
resource_identifier,
resource_mapping,
tag_resources,
untag_resources
FROM aws.cloudformation.stack_refactor_actions
WHERE StackRefactorId = '{{ StackRefactorId }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;