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

#include <ProtectionGroup.h>

Public Member Functions

 ProtectionGroup ()
 
 ProtectionGroup (Aws::Utils::Json::JsonView jsonValue)
 
ProtectionGroupoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetProtectionGroupId () const
 
bool ProtectionGroupIdHasBeenSet () const
 
void SetProtectionGroupId (const Aws::String &value)
 
void SetProtectionGroupId (Aws::String &&value)
 
void SetProtectionGroupId (const char *value)
 
ProtectionGroupWithProtectionGroupId (const Aws::String &value)
 
ProtectionGroupWithProtectionGroupId (Aws::String &&value)
 
ProtectionGroupWithProtectionGroupId (const char *value)
 
const ProtectionGroupAggregationGetAggregation () const
 
bool AggregationHasBeenSet () const
 
void SetAggregation (const ProtectionGroupAggregation &value)
 
void SetAggregation (ProtectionGroupAggregation &&value)
 
ProtectionGroupWithAggregation (const ProtectionGroupAggregation &value)
 
ProtectionGroupWithAggregation (ProtectionGroupAggregation &&value)
 
const ProtectionGroupPatternGetPattern () const
 
bool PatternHasBeenSet () const
 
void SetPattern (const ProtectionGroupPattern &value)
 
void SetPattern (ProtectionGroupPattern &&value)
 
ProtectionGroupWithPattern (const ProtectionGroupPattern &value)
 
ProtectionGroupWithPattern (ProtectionGroupPattern &&value)
 
const ProtectedResourceTypeGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const ProtectedResourceType &value)
 
void SetResourceType (ProtectedResourceType &&value)
 
ProtectionGroupWithResourceType (const ProtectedResourceType &value)
 
ProtectionGroupWithResourceType (ProtectedResourceType &&value)
 
const Aws::Vector< Aws::String > & GetMembers () const
 
bool MembersHasBeenSet () const
 
void SetMembers (const Aws::Vector< Aws::String > &value)
 
void SetMembers (Aws::Vector< Aws::String > &&value)
 
ProtectionGroupWithMembers (const Aws::Vector< Aws::String > &value)
 
ProtectionGroupWithMembers (Aws::Vector< Aws::String > &&value)
 
ProtectionGroupAddMembers (const Aws::String &value)
 
ProtectionGroupAddMembers (Aws::String &&value)
 
ProtectionGroupAddMembers (const char *value)
 
const Aws::StringGetProtectionGroupArn () const
 
bool ProtectionGroupArnHasBeenSet () const
 
void SetProtectionGroupArn (const Aws::String &value)
 
void SetProtectionGroupArn (Aws::String &&value)
 
void SetProtectionGroupArn (const char *value)
 
ProtectionGroupWithProtectionGroupArn (const Aws::String &value)
 
ProtectionGroupWithProtectionGroupArn (Aws::String &&value)
 
ProtectionGroupWithProtectionGroupArn (const char *value)
 

Detailed Description

A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.

See Also:

AWS API Reference

Definition at line 37 of file ProtectionGroup.h.

Constructor & Destructor Documentation

◆ ProtectionGroup() [1/2]

Aws::Shield::Model::ProtectionGroup::ProtectionGroup ( )

◆ ProtectionGroup() [2/2]

Aws::Shield::Model::ProtectionGroup::ProtectionGroup ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddMembers() [1/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::AddMembers ( Aws::String &&  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 354 of file ProtectionGroup.h.

◆ AddMembers() [2/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::AddMembers ( const Aws::String value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 346 of file ProtectionGroup.h.

◆ AddMembers() [3/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::AddMembers ( const char *  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 362 of file ProtectionGroup.h.

◆ AggregationHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::AggregationHasBeenSet ( ) const
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 131 of file ProtectionGroup.h.

◆ GetAggregation()

const ProtectionGroupAggregation& Aws::Shield::Model::ProtectionGroup::GetAggregation ( ) const
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 116 of file ProtectionGroup.h.

◆ GetMembers()

const Aws::Vector<Aws::String>& Aws::Shield::Model::ProtectionGroup::GetMembers ( ) const
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 298 of file ProtectionGroup.h.

◆ GetPattern()

const ProtectionGroupPattern& Aws::Shield::Model::ProtectionGroup::GetPattern ( ) const
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 200 of file ProtectionGroup.h.

◆ GetProtectionGroupArn()

const Aws::String& Aws::Shield::Model::ProtectionGroup::GetProtectionGroupArn ( ) const
inline

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

Definition at line 368 of file ProtectionGroup.h.

◆ GetProtectionGroupId()

const Aws::String& Aws::Shield::Model::ProtectionGroup::GetProtectionGroupId ( ) const
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 51 of file ProtectionGroup.h.

◆ GetResourceType()

const ProtectedResourceType& Aws::Shield::Model::ProtectionGroup::GetResourceType ( ) const
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 249 of file ProtectionGroup.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Shield::Model::ProtectionGroup::Jsonize ( ) const

◆ MembersHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::MembersHasBeenSet ( ) const
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 306 of file ProtectionGroup.h.

◆ operator=()

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PatternHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::PatternHasBeenSet ( ) const
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 208 of file ProtectionGroup.h.

◆ ProtectionGroupArnHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::ProtectionGroupArnHasBeenSet ( ) const
inline

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

Definition at line 373 of file ProtectionGroup.h.

◆ ProtectionGroupIdHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::ProtectionGroupIdHasBeenSet ( ) const
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 58 of file ProtectionGroup.h.

◆ ResourceTypeHasBeenSet()

bool Aws::Shield::Model::ProtectionGroup::ResourceTypeHasBeenSet ( ) const
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 257 of file ProtectionGroup.h.

◆ SetAggregation() [1/2]

void Aws::Shield::Model::ProtectionGroup::SetAggregation ( const ProtectionGroupAggregation value)
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 146 of file ProtectionGroup.h.

◆ SetAggregation() [2/2]

void Aws::Shield::Model::ProtectionGroup::SetAggregation ( ProtectionGroupAggregation &&  value)
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 161 of file ProtectionGroup.h.

◆ SetMembers() [1/2]

void Aws::Shield::Model::ProtectionGroup::SetMembers ( Aws::Vector< Aws::String > &&  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 322 of file ProtectionGroup.h.

◆ SetMembers() [2/2]

void Aws::Shield::Model::ProtectionGroup::SetMembers ( const Aws::Vector< Aws::String > &  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 314 of file ProtectionGroup.h.

◆ SetPattern() [1/2]

void Aws::Shield::Model::ProtectionGroup::SetPattern ( const ProtectionGroupPattern value)
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 216 of file ProtectionGroup.h.

◆ SetPattern() [2/2]

void Aws::Shield::Model::ProtectionGroup::SetPattern ( ProtectionGroupPattern &&  value)
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 224 of file ProtectionGroup.h.

◆ SetProtectionGroupArn() [1/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupArn ( Aws::String &&  value)
inline

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

Definition at line 383 of file ProtectionGroup.h.

◆ SetProtectionGroupArn() [2/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupArn ( const Aws::String value)
inline

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

Definition at line 378 of file ProtectionGroup.h.

◆ SetProtectionGroupArn() [3/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupArn ( const char *  value)
inline

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

Definition at line 388 of file ProtectionGroup.h.

◆ SetProtectionGroupId() [1/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupId ( Aws::String &&  value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 72 of file ProtectionGroup.h.

◆ SetProtectionGroupId() [2/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupId ( const Aws::String value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 65 of file ProtectionGroup.h.

◆ SetProtectionGroupId() [3/3]

void Aws::Shield::Model::ProtectionGroup::SetProtectionGroupId ( const char *  value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 79 of file ProtectionGroup.h.

◆ SetResourceType() [1/2]

void Aws::Shield::Model::ProtectionGroup::SetResourceType ( const ProtectedResourceType value)
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 265 of file ProtectionGroup.h.

◆ SetResourceType() [2/2]

void Aws::Shield::Model::ProtectionGroup::SetResourceType ( ProtectedResourceType &&  value)
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 273 of file ProtectionGroup.h.

◆ WithAggregation() [1/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithAggregation ( const ProtectionGroupAggregation value)
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 176 of file ProtectionGroup.h.

◆ WithAggregation() [2/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithAggregation ( ProtectionGroupAggregation &&  value)
inline

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront distributions and origin resources for CloudFront distributions.

Definition at line 191 of file ProtectionGroup.h.

◆ WithMembers() [1/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithMembers ( Aws::Vector< Aws::String > &&  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 338 of file ProtectionGroup.h.

◆ WithMembers() [2/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithMembers ( const Aws::Vector< Aws::String > &  value)
inline

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Definition at line 330 of file ProtectionGroup.h.

◆ WithPattern() [1/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithPattern ( const ProtectionGroupPattern value)
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 232 of file ProtectionGroup.h.

◆ WithPattern() [2/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithPattern ( ProtectionGroupPattern &&  value)
inline

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Definition at line 240 of file ProtectionGroup.h.

◆ WithProtectionGroupArn() [1/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupArn ( Aws::String &&  value)
inline

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

Definition at line 398 of file ProtectionGroup.h.

◆ WithProtectionGroupArn() [2/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupArn ( const Aws::String value)
inline

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

Definition at line 393 of file ProtectionGroup.h.

◆ WithProtectionGroupArn() [3/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupArn ( const char *  value)
inline

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

Definition at line 403 of file ProtectionGroup.h.

◆ WithProtectionGroupId() [1/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupId ( Aws::String &&  value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 93 of file ProtectionGroup.h.

◆ WithProtectionGroupId() [2/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupId ( const Aws::String value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 86 of file ProtectionGroup.h.

◆ WithProtectionGroupId() [3/3]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithProtectionGroupId ( const char *  value)
inline

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Definition at line 100 of file ProtectionGroup.h.

◆ WithResourceType() [1/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithResourceType ( const ProtectedResourceType value)
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 281 of file ProtectionGroup.h.

◆ WithResourceType() [2/2]

ProtectionGroup& Aws::Shield::Model::ProtectionGroup::WithResourceType ( ProtectedResourceType &&  value)
inline

The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Definition at line 289 of file ProtectionGroup.h.


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