Package software.amazon.awssdk.services.cloudformation.model

Interface DescribeStacksRequest.Builder

    • Method Detail

      • stackName

        DescribeStacksRequest.Builder stackName​(String stackName)

        If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

        Consider using the ListStacks API if you're not passing a parameter to StackName.

        The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

        { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

        The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

        • Running stacks: You can specify either the stack's name or its unique stack ID.

        • Deleted stacks: You must specify the unique stack ID.

        Default: There is no default value.

        Parameters:
        stackName -

        If you don't pass a parameter to StackName, the API returns a response that describes all resources in the account, which can impact performance. This requires ListStacks and DescribeStacks permissions.

        Consider using the ListStacks API if you're not passing a parameter to StackName.

        The IAM policy below can be added to IAM policies when you want to limit resource-level permissions and avoid returning a response when no parameter is sent in the request:

        { "Version": "2012-10-17", "Statement": [{ "Effect": "Deny", "Action": "cloudformation:DescribeStacks", "NotResource": "arn:aws:cloudformation:*:*:stack/*/*" }] }

        The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:

        • Running stacks: You can specify either the stack's name or its unique stack ID.

        • Deleted stacks: You must specify the unique stack ID.

        Default: There is no default value.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        DescribeStacksRequest.Builder nextToken​(String nextToken)

        A string that identifies the next page of stacks that you want to retrieve.

        Parameters:
        nextToken - A string that identifies the next page of stacks that you want to retrieve.
        Returns:
        Returns a reference to this object so that method calls can be chained together.