Stack / Collection / resource_summaries

resource_summaries¶

CloudFormation.Stack.resource_summaries¶

A collection of StackResourceSummary resources.A StackResourceSummary Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()¶

Creates an iterable of all StackResourceSummary resources in the collection.

See also: AWS API Documentation

Request Syntax

stack_resource_summary_iterator = stack.resource_summaries.all()

Return type:: list(cloudformation.StackResourceSummary)
Returns:: A list of StackResourceSummary resources

filter(**kwargs)¶

Creates an iterable of all StackResourceSummary resources in the collection filtered by kwargs passed to method. A StackResourceSummary collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

stack_resource_summary_iterator = stack.resource_summaries.filter(
    NextToken='string'
)

Parameters:: NextToken (string) – A string that identifies the next page of stack resources that you want to retrieve.
Return type:: list(cloudformation.StackResourceSummary)
Returns:: A list of StackResourceSummary resources

limit(**kwargs)¶

Creates an iterable up to a specified amount of StackResourceSummary resources in the collection.

See also: AWS API Documentation

Request Syntax

stack_resource_summary_iterator = stack.resource_summaries.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(cloudformation.StackResourceSummary)
Returns:: A list of StackResourceSummary resources

page_size(**kwargs)¶

Creates an iterable of all StackResourceSummary resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

stack_resource_summary_iterator = stack.resource_summaries.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(cloudformation.StackResourceSummary)
Returns:: A list of StackResourceSummary resources