/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace WAFV2 { namespace Model { /** */ class AWS_WAFV2_API UpdateRuleGroupRequest : public WAFV2Request { public: UpdateRuleGroupRequest(); // 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 "UpdateRuleGroup"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline UpdateRuleGroupRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline UpdateRuleGroupRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the rule group. You cannot change the name of a rule group after * you create it.

*/ inline UpdateRuleGroupRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline const Scope& GetScope() const{ return m_scope; } /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; } /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline void SetScope(const Scope& value) { m_scopeHasBeenSet = true; m_scope = value; } /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline void SetScope(Scope&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); } /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline UpdateRuleGroupRequest& WithScope(const Scope& value) { SetScope(value); return *this;} /** *

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.

To work with CloudFront, you must also * specify the Region US East (N. Virginia) as follows:

  • CLI - * Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT * --region=us-east-1.

  • API and SDKs - For all calls, use * the Region endpoint us-east-1.

*/ inline UpdateRuleGroupRequest& WithScope(Scope&& value) { SetScope(std::move(value)); return *this;} /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline const Aws::String& GetId() const{ return m_id; } /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline bool IdHasBeenSet() const { return m_idHasBeenSet; } /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline void SetId(const Aws::String& value) { m_idHasBeenSet = true; m_id = value; } /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline void SetId(Aws::String&& value) { m_idHasBeenSet = true; m_id = std::move(value); } /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline void SetId(const char* value) { m_idHasBeenSet = true; m_id.assign(value); } /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline UpdateRuleGroupRequest& WithId(const Aws::String& value) { SetId(value); return *this;} /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline UpdateRuleGroupRequest& WithId(Aws::String&& value) { SetId(std::move(value)); return *this;} /** *

A unique identifier for the rule group. This ID is returned in the responses * to create and list commands. You provide it to operations like update and * delete.

*/ inline UpdateRuleGroupRequest& WithId(const char* value) { SetId(value); return *this;} /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline const Aws::String& GetDescription() const{ return m_description; } /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline UpdateRuleGroupRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline UpdateRuleGroupRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

A description of the rule group that helps with identification. You cannot * change the description of a rule group after you create it.

*/ inline UpdateRuleGroupRequest& WithDescription(const char* value) { SetDescription(value); return *this;} /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline const Aws::Vector& GetRules() const{ return m_rules; } /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline bool RulesHasBeenSet() const { return m_rulesHasBeenSet; } /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline void SetRules(const Aws::Vector& value) { m_rulesHasBeenSet = true; m_rules = value; } /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline void SetRules(Aws::Vector&& value) { m_rulesHasBeenSet = true; m_rules = std::move(value); } /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline UpdateRuleGroupRequest& WithRules(const Aws::Vector& value) { SetRules(value); return *this;} /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline UpdateRuleGroupRequest& WithRules(Aws::Vector&& value) { SetRules(std::move(value)); return *this;} /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline UpdateRuleGroupRequest& AddRules(const Rule& value) { m_rulesHasBeenSet = true; m_rules.push_back(value); return *this; } /** *

The Rule statements used to identify the web requests that you want to * allow, block, or count. Each rule includes one top-level statement that AWS WAF * uses to identify matching web requests, and parameters that govern how AWS WAF * handles them.

*/ inline UpdateRuleGroupRequest& AddRules(Rule&& value) { m_rulesHasBeenSet = true; m_rules.push_back(std::move(value)); return *this; } /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline const VisibilityConfig& GetVisibilityConfig() const{ return m_visibilityConfig; } /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline bool VisibilityConfigHasBeenSet() const { return m_visibilityConfigHasBeenSet; } /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline void SetVisibilityConfig(const VisibilityConfig& value) { m_visibilityConfigHasBeenSet = true; m_visibilityConfig = value; } /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline void SetVisibilityConfig(VisibilityConfig&& value) { m_visibilityConfigHasBeenSet = true; m_visibilityConfig = std::move(value); } /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline UpdateRuleGroupRequest& WithVisibilityConfig(const VisibilityConfig& value) { SetVisibilityConfig(value); return *this;} /** *

Defines and enables Amazon CloudWatch metrics and web request sample * collection.

*/ inline UpdateRuleGroupRequest& WithVisibilityConfig(VisibilityConfig&& value) { SetVisibilityConfig(std::move(value)); return *this;} /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline const Aws::String& GetLockToken() const{ return m_lockToken; } /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline bool LockTokenHasBeenSet() const { return m_lockTokenHasBeenSet; } /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline void SetLockToken(const Aws::String& value) { m_lockTokenHasBeenSet = true; m_lockToken = value; } /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline void SetLockToken(Aws::String&& value) { m_lockTokenHasBeenSet = true; m_lockToken = std::move(value); } /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline void SetLockToken(const char* value) { m_lockTokenHasBeenSet = true; m_lockToken.assign(value); } /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline UpdateRuleGroupRequest& WithLockToken(const Aws::String& value) { SetLockToken(value); return *this;} /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline UpdateRuleGroupRequest& WithLockToken(Aws::String&& value) { SetLockToken(std::move(value)); return *this;} /** *

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 WAFOptimisticLockException. * If this happens, perform another get, and use the new token returned by that * operation.

*/ inline UpdateRuleGroupRequest& 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_description; bool m_descriptionHasBeenSet; Aws::Vector m_rules; bool m_rulesHasBeenSet; VisibilityConfig m_visibilityConfig; bool m_visibilityConfigHasBeenSet; Aws::String m_lockToken; bool m_lockTokenHasBeenSet; }; } // namespace Model } // namespace WAFV2 } // namespace Aws