This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-wafv2/include/aws/wafv2/model/DeleteWebACLRequest.h

325 lines
15 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/wafv2/WAFV2_EXPORTS.h>
#include <aws/wafv2/WAFV2Request.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/wafv2/model/Scope.h>
#include <utility>
namespace Aws
{
namespace WAFV2
{
namespace Model
{
/**
*/
class AWS_WAFV2_API DeleteWebACLRequest : public WAFV2Request
{
public:
DeleteWebACLRequest();
// 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 "DeleteWebACL"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline const Aws::String& GetName() const{ return m_name; }
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline DeleteWebACLRequest& WithName(const Aws::String& value) { SetName(value); return *this;}
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline DeleteWebACLRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}
/**
* <p>The name of the Web ACL. You cannot change the name of a Web ACL after you
* create it.</p>
*/
inline DeleteWebACLRequest& WithName(const char* value) { SetName(value); return *this;}
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline const Scope& GetScope() const{ return m_scope; }
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; }
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline void SetScope(const Scope& value) { m_scopeHasBeenSet = true; m_scope = value; }
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline void SetScope(Scope&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); }
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline DeleteWebACLRequest& WithScope(const Scope& value) { SetScope(value); return *this;}
/**
* <p>Specifies whether this is for an AWS CloudFront distribution or for a
* regional application. A regional application can be an Application Load Balancer
* (ALB) or an API Gateway stage. </p> <p>To work with CloudFront, you must also
* specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI -
* Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT
* --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use
* the Region endpoint us-east-1. </p> </li> </ul>
*/
inline DeleteWebACLRequest& WithScope(Scope&& value) { SetScope(std::move(value)); return *this;}
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline const Aws::String& GetId() const{ return m_id; }
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; }
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); }
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); }
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline DeleteWebACLRequest& WithId(const Aws::String& value) { SetId(value); return *this;}
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline DeleteWebACLRequest& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;}
/**
* <p>The unique identifier for the Web ACL. This ID is returned in the responses
* to create and list commands. You provide it to operations like update and
* delete.</p>
*/
inline DeleteWebACLRequest& WithId(const char* value) { SetId(value); return *this;}
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline const Aws::String& GetLockToken() const{ return m_lockToken; }
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline bool LockTokenHasBeenSet() const { return m_lockTokenHasBeenSet; }
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline void SetLockToken(const Aws::String& value) { m_lockTokenHasBeenSet = true; m_lockToken = value; }
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline void SetLockToken(Aws::String&& value) { m_lockTokenHasBeenSet = true; m_lockToken = std::move(value); }
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline void SetLockToken(const char* value) { m_lockTokenHasBeenSet = true; m_lockToken.assign(value); }
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline DeleteWebACLRequest& WithLockToken(const Aws::String& value) { SetLockToken(value); return *this;}
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline DeleteWebACLRequest& WithLockToken(Aws::String&& value) { SetLockToken(std::move(value)); return *this;}
/**
* <p>A token used for optimistic locking. AWS WAF returns a token to your get and
* list requests, to mark the state of the entity at the time of the request. To
* make changes to the entity associated with the token, you provide the token to
* operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change
* has been made, the update fails with a <code>WAFOptimisticLockException</code>.
* If this happens, perform another get, and use the new token returned by that
* operation. </p>
*/
inline DeleteWebACLRequest& WithLockToken(const char* value) { SetLockToken(value); return *this;}
private:
Aws::String m_name;
bool m_nameHasBeenSet;
Scope m_scope;
bool m_scopeHasBeenSet;
Aws::String m_id;
bool m_idHasBeenSet;
Aws::String m_lockToken;
bool m_lockTokenHasBeenSet;
};
} // namespace Model
} // namespace WAFV2
} // namespace Aws