/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace CloudFormation { namespace Model { /** *

The input for DescribeStacks action.

See Also:

AWS * API Reference

*/ class DescribeStacksRequest : public CloudFormationRequest { public: AWS_CLOUDFORMATION_API DescribeStacksRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeStacks"; } AWS_CLOUDFORMATION_API Aws::String SerializePayload() const override; protected: AWS_CLOUDFORMATION_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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

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.

*/ inline const Aws::String& GetStackName() const{ return m_stackName; } /** *

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

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.

*/ inline bool StackNameHasBeenSet() const { return m_stackNameHasBeenSet; } /** *

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

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.

*/ inline void SetStackName(const Aws::String& value) { m_stackNameHasBeenSet = true; m_stackName = value; } /** *

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

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.

*/ inline void SetStackName(Aws::String&& value) { m_stackNameHasBeenSet = true; m_stackName = std::move(value); } /** *

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

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.

*/ inline void SetStackName(const char* value) { m_stackNameHasBeenSet = true; m_stackName.assign(value); } /** *

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

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.

*/ inline DescribeStacksRequest& WithStackName(const Aws::String& value) { SetStackName(value); return *this;} /** *

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

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.

*/ inline DescribeStacksRequest& WithStackName(Aws::String&& value) { SetStackName(std::move(value)); return *this;} /** *

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

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.

*/ inline DescribeStacksRequest& WithStackName(const char* value) { SetStackName(value); return *this;} /** *

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

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

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

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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

*/ inline DescribeStacksRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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

*/ inline DescribeStacksRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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

*/ inline DescribeStacksRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_stackName; bool m_stackNameHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace CloudFormation } // namespace Aws