AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::NetworkFirewall::Model::RuleGroupResponse Class Reference

#include <RuleGroupResponse.h>

Public Member Functions

 RuleGroupResponse ()
 
 RuleGroupResponse (Aws::Utils::Json::JsonView jsonValue)
 
RuleGroupResponseoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRuleGroupArn () const
 
bool RuleGroupArnHasBeenSet () const
 
void SetRuleGroupArn (const Aws::String &value)
 
void SetRuleGroupArn (Aws::String &&value)
 
void SetRuleGroupArn (const char *value)
 
RuleGroupResponseWithRuleGroupArn (const Aws::String &value)
 
RuleGroupResponseWithRuleGroupArn (Aws::String &&value)
 
RuleGroupResponseWithRuleGroupArn (const char *value)
 
const Aws::StringGetRuleGroupName () const
 
bool RuleGroupNameHasBeenSet () const
 
void SetRuleGroupName (const Aws::String &value)
 
void SetRuleGroupName (Aws::String &&value)
 
void SetRuleGroupName (const char *value)
 
RuleGroupResponseWithRuleGroupName (const Aws::String &value)
 
RuleGroupResponseWithRuleGroupName (Aws::String &&value)
 
RuleGroupResponseWithRuleGroupName (const char *value)
 
const Aws::StringGetRuleGroupId () const
 
bool RuleGroupIdHasBeenSet () const
 
void SetRuleGroupId (const Aws::String &value)
 
void SetRuleGroupId (Aws::String &&value)
 
void SetRuleGroupId (const char *value)
 
RuleGroupResponseWithRuleGroupId (const Aws::String &value)
 
RuleGroupResponseWithRuleGroupId (Aws::String &&value)
 
RuleGroupResponseWithRuleGroupId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
RuleGroupResponseWithDescription (const Aws::String &value)
 
RuleGroupResponseWithDescription (Aws::String &&value)
 
RuleGroupResponseWithDescription (const char *value)
 
const RuleGroupTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const RuleGroupType &value)
 
void SetType (RuleGroupType &&value)
 
RuleGroupResponseWithType (const RuleGroupType &value)
 
RuleGroupResponseWithType (RuleGroupType &&value)
 
int GetCapacity () const
 
bool CapacityHasBeenSet () const
 
void SetCapacity (int value)
 
RuleGroupResponseWithCapacity (int value)
 
const ResourceStatusGetRuleGroupStatus () const
 
bool RuleGroupStatusHasBeenSet () const
 
void SetRuleGroupStatus (const ResourceStatus &value)
 
void SetRuleGroupStatus (ResourceStatus &&value)
 
RuleGroupResponseWithRuleGroupStatus (const ResourceStatus &value)
 
RuleGroupResponseWithRuleGroupStatus (ResourceStatus &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
RuleGroupResponseWithTags (const Aws::Vector< Tag > &value)
 
RuleGroupResponseWithTags (Aws::Vector< Tag > &&value)
 
RuleGroupResponseAddTags (const Tag &value)
 
RuleGroupResponseAddTags (Tag &&value)
 

Detailed Description

The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

See Also:

AWS API Reference

Definition at line 37 of file RuleGroupResponse.h.

Constructor & Destructor Documentation

◆ RuleGroupResponse() [1/2]

Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupResponse ( )

◆ RuleGroupResponse() [2/2]

Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupResponse ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTags() [1/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::AddTags ( const Tag value)
inline

The key:value pairs to associate with the resource.

Definition at line 394 of file RuleGroupResponse.h.

◆ AddTags() [2/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::AddTags ( Tag &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 399 of file RuleGroupResponse.h.

◆ CapacityHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::CapacityHasBeenSet ( ) const
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Definition at line 305 of file RuleGroupResponse.h.

◆ DescriptionHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::DescriptionHasBeenSet ( ) const
inline

A description of the rule group.

Definition at line 209 of file RuleGroupResponse.h.

◆ GetCapacity()

int Aws::NetworkFirewall::Model::RuleGroupResponse::GetCapacity ( ) const
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Definition at line 294 of file RuleGroupResponse.h.

◆ GetDescription()

const Aws::String& Aws::NetworkFirewall::Model::RuleGroupResponse::GetDescription ( ) const
inline

A description of the rule group.

Definition at line 204 of file RuleGroupResponse.h.

◆ GetRuleGroupArn()

const Aws::String& Aws::NetworkFirewall::Model::RuleGroupResponse::GetRuleGroupArn ( ) const
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 52 of file RuleGroupResponse.h.

◆ GetRuleGroupId()

const Aws::String& Aws::NetworkFirewall::Model::RuleGroupResponse::GetRuleGroupId ( ) const
inline

The unique identifier for the rule group.

Definition at line 163 of file RuleGroupResponse.h.

◆ GetRuleGroupName()

const Aws::String& Aws::NetworkFirewall::Model::RuleGroupResponse::GetRuleGroupName ( ) const
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 115 of file RuleGroupResponse.h.

◆ GetRuleGroupStatus()

const ResourceStatus& Aws::NetworkFirewall::Model::RuleGroupResponse::GetRuleGroupStatus ( ) const
inline

Detailed information about the current status of a rule group.

Definition at line 333 of file RuleGroupResponse.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::NetworkFirewall::Model::RuleGroupResponse::GetTags ( ) const
inline

The key:value pairs to associate with the resource.

Definition at line 364 of file RuleGroupResponse.h.

◆ GetType()

const RuleGroupType& Aws::NetworkFirewall::Model::RuleGroupResponse::GetType ( ) const
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 247 of file RuleGroupResponse.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::NetworkFirewall::Model::RuleGroupResponse::Jsonize ( ) const

◆ operator=()

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RuleGroupArnHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 60 of file RuleGroupResponse.h.

◆ RuleGroupIdHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupIdHasBeenSet ( ) const
inline

The unique identifier for the rule group.

Definition at line 168 of file RuleGroupResponse.h.

◆ RuleGroupNameHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupNameHasBeenSet ( ) const
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 121 of file RuleGroupResponse.h.

◆ RuleGroupStatusHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::RuleGroupStatusHasBeenSet ( ) const
inline

Detailed information about the current status of a rule group.

Definition at line 338 of file RuleGroupResponse.h.

◆ SetCapacity()

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetCapacity ( int  value)
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Definition at line 316 of file RuleGroupResponse.h.

◆ SetDescription() [1/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetDescription ( Aws::String &&  value)
inline

A description of the rule group.

Definition at line 219 of file RuleGroupResponse.h.

◆ SetDescription() [2/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetDescription ( const Aws::String value)
inline

A description of the rule group.

Definition at line 214 of file RuleGroupResponse.h.

◆ SetDescription() [3/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetDescription ( const char *  value)
inline

A description of the rule group.

Definition at line 224 of file RuleGroupResponse.h.

◆ SetRuleGroupArn() [1/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 76 of file RuleGroupResponse.h.

◆ SetRuleGroupArn() [2/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 68 of file RuleGroupResponse.h.

◆ SetRuleGroupArn() [3/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 84 of file RuleGroupResponse.h.

◆ SetRuleGroupId() [1/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupId ( Aws::String &&  value)
inline

The unique identifier for the rule group.

Definition at line 178 of file RuleGroupResponse.h.

◆ SetRuleGroupId() [2/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupId ( const Aws::String value)
inline

The unique identifier for the rule group.

Definition at line 173 of file RuleGroupResponse.h.

◆ SetRuleGroupId() [3/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupId ( const char *  value)
inline

The unique identifier for the rule group.

Definition at line 183 of file RuleGroupResponse.h.

◆ SetRuleGroupName() [1/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupName ( Aws::String &&  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 133 of file RuleGroupResponse.h.

◆ SetRuleGroupName() [2/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupName ( const Aws::String value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 127 of file RuleGroupResponse.h.

◆ SetRuleGroupName() [3/3]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupName ( const char *  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 139 of file RuleGroupResponse.h.

◆ SetRuleGroupStatus() [1/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupStatus ( const ResourceStatus value)
inline

Detailed information about the current status of a rule group.

Definition at line 343 of file RuleGroupResponse.h.

◆ SetRuleGroupStatus() [2/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetRuleGroupStatus ( ResourceStatus &&  value)
inline

Detailed information about the current status of a rule group.

Definition at line 348 of file RuleGroupResponse.h.

◆ SetTags() [1/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetTags ( Aws::Vector< Tag > &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 379 of file RuleGroupResponse.h.

◆ SetTags() [2/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetTags ( const Aws::Vector< Tag > &  value)
inline

The key:value pairs to associate with the resource.

Definition at line 374 of file RuleGroupResponse.h.

◆ SetType() [1/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetType ( const RuleGroupType value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 261 of file RuleGroupResponse.h.

◆ SetType() [2/2]

void Aws::NetworkFirewall::Model::RuleGroupResponse::SetType ( RuleGroupType &&  value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 268 of file RuleGroupResponse.h.

◆ TagsHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::TagsHasBeenSet ( ) const
inline

The key:value pairs to associate with the resource.

Definition at line 369 of file RuleGroupResponse.h.

◆ TypeHasBeenSet()

bool Aws::NetworkFirewall::Model::RuleGroupResponse::TypeHasBeenSet ( ) const
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 254 of file RuleGroupResponse.h.

◆ WithCapacity()

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithCapacity ( int  value)
inline

The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.

You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.

Definition at line 327 of file RuleGroupResponse.h.

◆ WithDescription() [1/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithDescription ( Aws::String &&  value)
inline

A description of the rule group.

Definition at line 234 of file RuleGroupResponse.h.

◆ WithDescription() [2/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithDescription ( const Aws::String value)
inline

A description of the rule group.

Definition at line 229 of file RuleGroupResponse.h.

◆ WithDescription() [3/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithDescription ( const char *  value)
inline

A description of the rule group.

Definition at line 239 of file RuleGroupResponse.h.

◆ WithRuleGroupArn() [1/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 100 of file RuleGroupResponse.h.

◆ WithRuleGroupArn() [2/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 92 of file RuleGroupResponse.h.

◆ WithRuleGroupArn() [3/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the rule group.

If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.

Definition at line 108 of file RuleGroupResponse.h.

◆ WithRuleGroupId() [1/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupId ( Aws::String &&  value)
inline

The unique identifier for the rule group.

Definition at line 193 of file RuleGroupResponse.h.

◆ WithRuleGroupId() [2/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupId ( const Aws::String value)
inline

The unique identifier for the rule group.

Definition at line 188 of file RuleGroupResponse.h.

◆ WithRuleGroupId() [3/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupId ( const char *  value)
inline

The unique identifier for the rule group.

Definition at line 198 of file RuleGroupResponse.h.

◆ WithRuleGroupName() [1/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupName ( Aws::String &&  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 151 of file RuleGroupResponse.h.

◆ WithRuleGroupName() [2/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupName ( const Aws::String value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 145 of file RuleGroupResponse.h.

◆ WithRuleGroupName() [3/3]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupName ( const char *  value)
inline

The descriptive name of the rule group. You can't change the name of a rule group after you create it.

Definition at line 157 of file RuleGroupResponse.h.

◆ WithRuleGroupStatus() [1/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupStatus ( const ResourceStatus value)
inline

Detailed information about the current status of a rule group.

Definition at line 353 of file RuleGroupResponse.h.

◆ WithRuleGroupStatus() [2/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithRuleGroupStatus ( ResourceStatus &&  value)
inline

Detailed information about the current status of a rule group.

Definition at line 358 of file RuleGroupResponse.h.

◆ WithTags() [1/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithTags ( Aws::Vector< Tag > &&  value)
inline

The key:value pairs to associate with the resource.

Definition at line 389 of file RuleGroupResponse.h.

◆ WithTags() [2/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithTags ( const Aws::Vector< Tag > &  value)
inline

The key:value pairs to associate with the resource.

Definition at line 384 of file RuleGroupResponse.h.

◆ WithType() [1/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithType ( const RuleGroupType value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 275 of file RuleGroupResponse.h.

◆ WithType() [2/2]

RuleGroupResponse& Aws::NetworkFirewall::Model::RuleGroupResponse::WithType ( RuleGroupType &&  value)
inline

Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.

Definition at line 282 of file RuleGroupResponse.h.


The documentation for this class was generated from the following file: