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

The input for the GetTemplateSummary action.

See Also:

* AWS * API Reference

*/ class GetTemplateSummaryRequest : public CloudFormationRequest { public: AWS_CLOUDFORMATION_API GetTemplateSummaryRequest(); // 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 "GetTemplateSummary"; } AWS_CLOUDFORMATION_API Aws::String SerializePayload() const override; protected: AWS_CLOUDFORMATION_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline const Aws::String& GetTemplateBody() const{ return m_templateBody; } /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline bool TemplateBodyHasBeenSet() const { return m_templateBodyHasBeenSet; } /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateBody(const Aws::String& value) { m_templateBodyHasBeenSet = true; m_templateBody = value; } /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateBody(Aws::String&& value) { m_templateBodyHasBeenSet = true; m_templateBody = std::move(value); } /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateBody(const char* value) { m_templateBodyHasBeenSet = true; m_templateBody.assign(value); } /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateBody(const Aws::String& value) { SetTemplateBody(value); return *this;} /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateBody(Aws::String&& value) { SetTemplateBody(std::move(value)); return *this;} /** *

Structure containing the template body with a minimum length of 1 byte and a * maximum length of 51,200 bytes. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateBody(const char* value) { SetTemplateBody(value); return *this;} /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline const Aws::String& GetTemplateURL() const{ return m_templateURL; } /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline bool TemplateURLHasBeenSet() const { return m_templateURLHasBeenSet; } /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateURL(const Aws::String& value) { m_templateURLHasBeenSet = true; m_templateURL = value; } /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateURL(Aws::String&& value) { m_templateURLHasBeenSet = true; m_templateURL = std::move(value); } /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetTemplateURL(const char* value) { m_templateURLHasBeenSet = true; m_templateURL.assign(value); } /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateURL(const Aws::String& value) { SetTemplateURL(value); return *this;} /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateURL(Aws::String&& value) { SetTemplateURL(std::move(value)); return *this;} /** *

Location of file containing the template body. The URL must point to a * template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a * Systems Manager document. For more information about templates, see Template * anatomy in the CloudFormation User Guide.

Conditional: You must * specify only one of the following parameters: StackName, * StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithTemplateURL(const char* value) { SetTemplateURL(value); return *this;} /** *

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or the stack ID that's associated with the stack, which aren't * always interchangeable. For running stacks, you can specify either the stack's * name or its unique stack ID. For deleted stack, you must specify the unique * stack ID.

Conditional: You must specify only one of the following * parameters: StackName, StackSetName, * TemplateBody, or TemplateURL.

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

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline const Aws::String& GetStackSetName() const{ return m_stackSetName; } /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline bool StackSetNameHasBeenSet() const { return m_stackSetNameHasBeenSet; } /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetStackSetName(const Aws::String& value) { m_stackSetNameHasBeenSet = true; m_stackSetName = value; } /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetStackSetName(Aws::String&& value) { m_stackSetNameHasBeenSet = true; m_stackSetName = std::move(value); } /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline void SetStackSetName(const char* value) { m_stackSetNameHasBeenSet = true; m_stackSetName.assign(value); } /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithStackSetName(const Aws::String& value) { SetStackSetName(value); return *this;} /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithStackSetName(Aws::String&& value) { SetStackSetName(std::move(value)); return *this;} /** *

The name or unique ID of the stack set from which the stack was created.

*

Conditional: You must specify only one of the following parameters: * StackName, StackSetName, TemplateBody, or * TemplateURL.

*/ inline GetTemplateSummaryRequest& WithStackSetName(const char* value) { SetStackSetName(value); return *this;} /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline const CallAs& GetCallAs() const{ return m_callAs; } /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline bool CallAsHasBeenSet() const { return m_callAsHasBeenSet; } /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline void SetCallAs(const CallAs& value) { m_callAsHasBeenSet = true; m_callAs = value; } /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline void SetCallAs(CallAs&& value) { m_callAsHasBeenSet = true; m_callAs = std::move(value); } /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline GetTemplateSummaryRequest& WithCallAs(const CallAs& value) { SetCallAs(value); return *this;} /** *

[Service-managed permissions] 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 stack sets 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.

  • *
*/ inline GetTemplateSummaryRequest& WithCallAs(CallAs&& value) { SetCallAs(std::move(value)); return *this;} /** *

Specifies options for the GetTemplateSummary API action.

*/ inline const TemplateSummaryConfig& GetTemplateSummaryConfig() const{ return m_templateSummaryConfig; } /** *

Specifies options for the GetTemplateSummary API action.

*/ inline bool TemplateSummaryConfigHasBeenSet() const { return m_templateSummaryConfigHasBeenSet; } /** *

Specifies options for the GetTemplateSummary API action.

*/ inline void SetTemplateSummaryConfig(const TemplateSummaryConfig& value) { m_templateSummaryConfigHasBeenSet = true; m_templateSummaryConfig = value; } /** *

Specifies options for the GetTemplateSummary API action.

*/ inline void SetTemplateSummaryConfig(TemplateSummaryConfig&& value) { m_templateSummaryConfigHasBeenSet = true; m_templateSummaryConfig = std::move(value); } /** *

Specifies options for the GetTemplateSummary API action.

*/ inline GetTemplateSummaryRequest& WithTemplateSummaryConfig(const TemplateSummaryConfig& value) { SetTemplateSummaryConfig(value); return *this;} /** *

Specifies options for the GetTemplateSummary API action.

*/ inline GetTemplateSummaryRequest& WithTemplateSummaryConfig(TemplateSummaryConfig&& value) { SetTemplateSummaryConfig(std::move(value)); return *this;} private: Aws::String m_templateBody; bool m_templateBodyHasBeenSet = false; Aws::String m_templateURL; bool m_templateURLHasBeenSet = false; Aws::String m_stackName; bool m_stackNameHasBeenSet = false; Aws::String m_stackSetName; bool m_stackSetNameHasBeenSet = false; CallAs m_callAs; bool m_callAsHasBeenSet = false; TemplateSummaryConfig m_templateSummaryConfig; bool m_templateSummaryConfigHasBeenSet = false; }; } // namespace Model } // namespace CloudFormation } // namespace Aws