/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace WAFV2 { namespace Model { /** *

High-level information for a managed rule set.

This is * intended for use only by vendors of managed rule sets. Vendors are Amazon Web * Services and Amazon Web Services Marketplace sellers.

Vendors, you can * use the managed rule set APIs to provide controlled rollout of your versioned * managed rule group offerings for your customers. The APIs are * ListManagedRuleSets, GetManagedRuleSet, * PutManagedRuleSetVersions, and * UpdateManagedRuleSetVersionExpiryDate.

See * Also:

AWS * API Reference

*/ class ManagedRuleSetSummary { public: AWS_WAFV2_API ManagedRuleSetSummary(); AWS_WAFV2_API ManagedRuleSetSummary(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API ManagedRuleSetSummary& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

The name of the managed rule set. You use this, along with the rule set ID, * to identify the rule set.

This name is assigned to the corresponding * managed rule group, which your customers can access and use.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A unique identifier for the managed rule set. The ID is returned in the * responses to commands like list. You provide it to operations like * get and update.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A description of the set that helps with identification.

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

A token used for optimistic locking. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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 ManagedRuleSetSummary& WithLockToken(const Aws::String& value) { SetLockToken(value); return *this;} /** *

A token used for optimistic locking. 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. 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 ManagedRuleSetSummary& WithLockToken(Aws::String&& value) { SetLockToken(std::move(value)); return *this;} /** *

A token used for optimistic locking. 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. 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 ManagedRuleSetSummary& WithLockToken(const char* value) { SetLockToken(value); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline const Aws::String& GetARN() const{ return m_aRN; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline bool ARNHasBeenSet() const { return m_aRNHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(const Aws::String& value) { m_aRNHasBeenSet = true; m_aRN = value; } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(Aws::String&& value) { m_aRNHasBeenSet = true; m_aRN = std::move(value); } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline void SetARN(const char* value) { m_aRNHasBeenSet = true; m_aRN.assign(value); } /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline ManagedRuleSetSummary& WithARN(const Aws::String& value) { SetARN(value); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline ManagedRuleSetSummary& WithARN(Aws::String&& value) { SetARN(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the entity.

*/ inline ManagedRuleSetSummary& WithARN(const char* value) { SetARN(value); return *this;} /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline const Aws::String& GetLabelNamespace() const{ return m_labelNamespace; } /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline bool LabelNamespaceHasBeenSet() const { return m_labelNamespaceHasBeenSet; } /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(const Aws::String& value) { m_labelNamespaceHasBeenSet = true; m_labelNamespace = value; } /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(Aws::String&& value) { m_labelNamespaceHasBeenSet = true; m_labelNamespace = std::move(value); } /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline void SetLabelNamespace(const char* value) { m_labelNamespaceHasBeenSet = true; m_labelNamespace.assign(value); } /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline ManagedRuleSetSummary& WithLabelNamespace(const Aws::String& value) { SetLabelNamespace(value); return *this;} /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline ManagedRuleSetSummary& WithLabelNamespace(Aws::String&& value) { SetLabelNamespace(std::move(value)); return *this;} /** *

The label namespace prefix for the managed rule groups that are offered to * customers from this managed rule set. All labels that are added by rules in the * managed rule group have this prefix.

  • The syntax for the label * namespace prefix for a managed rule group is the following:

    * awswaf:managed:<vendor>:<rule group name>:

    • *

  • When a rule with a label matches a web request, WAF adds the fully * qualified label to the request. A fully qualified label is made up of the label * namespace from the rule group or web ACL where the rule is defined and the label * from the rule, separated by a colon:

    <label * namespace>:<label from rule>

*/ inline ManagedRuleSetSummary& WithLabelNamespace(const char* value) { SetLabelNamespace(value); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_id; bool m_idHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; Aws::String m_lockToken; bool m_lockTokenHasBeenSet = false; Aws::String m_aRN; bool m_aRNHasBeenSet = false; Aws::String m_labelNamespace; bool m_labelNamespaceHasBeenSet = false; }; } // namespace Model } // namespace WAFV2 } // namespace Aws