stack_set_auto_deployment_targets
Creates, updates, deletes, gets or lists a stack_set_auto_deployment_targets resource.
Overview
| Name | stack_set_auto_deployment_targets |
| Type | Resource |
| Id | aws.cloudformation.stack_set_auto_deployment_targets |
Fields
The following fields are returned by SELECT queries:
- list_stack_set_auto_deployment_targets
| Name | Datatype | Description |
|---|---|---|
organizational_unit_id | string | The organization root ID or organizational unit (OU) IDs where the StackSet is targeted. |
regions | string | The list of Regions targeted for this organization or OU. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_stack_set_auto_deployment_targets | select | StackSetName, region | NextToken, MaxResults, CallAs | Returns summary information about deployment targets for a StackSet. |
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 |
|---|---|---|
StackSetName | string | The name or unique ID of the StackSet that you want to get automatic deployment targets for. |
region | string | AWS region (default: us-east-1) |
CallAs | string | 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 StackSets 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. |
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_set_auto_deployment_targets
Returns summary information about deployment targets for a StackSet.
SELECT
organizational_unit_id,
regions
FROM aws.cloudformation.stack_set_auto_deployment_targets
WHERE StackSetName = '{{ StackSetName }}' -- required
AND region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND CallAs = '{{ CallAs }}'
;