AWS SDK for C++  1.8.129
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribeSecurityGroupsRequest Class Reference

#include <DescribeSecurityGroupsRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribeSecurityGroupsRequest:

Public Member Functions

 DescribeSecurityGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribeSecurityGroupsRequest & WithFilters (const Aws::Vector< Filter > &value)
 
DescribeSecurityGroupsRequest & WithFilters (Aws::Vector< Filter > &&value)
 
DescribeSecurityGroupsRequest & AddFilters (const Filter &value)
 
DescribeSecurityGroupsRequest & AddFilters (Filter &&value)
 
const Aws::Vector< Aws::String > & GetGroupIds () const
 
bool GroupIdsHasBeenSet () const
 
void SetGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetGroupIds (Aws::Vector< Aws::String > &&value)
 
DescribeSecurityGroupsRequest & WithGroupIds (const Aws::Vector< Aws::String > &value)
 
DescribeSecurityGroupsRequest & WithGroupIds (Aws::Vector< Aws::String > &&value)
 
DescribeSecurityGroupsRequest & AddGroupIds (const Aws::String &value)
 
DescribeSecurityGroupsRequest & AddGroupIds (Aws::String &&value)
 
DescribeSecurityGroupsRequest & AddGroupIds (const char *value)
 
const Aws::Vector< Aws::String > & GetGroupNames () const
 
bool GroupNamesHasBeenSet () const
 
void SetGroupNames (const Aws::Vector< Aws::String > &value)
 
void SetGroupNames (Aws::Vector< Aws::String > &&value)
 
DescribeSecurityGroupsRequest & WithGroupNames (const Aws::Vector< Aws::String > &value)
 
DescribeSecurityGroupsRequest & WithGroupNames (Aws::Vector< Aws::String > &&value)
 
DescribeSecurityGroupsRequest & AddGroupNames (const Aws::String &value)
 
DescribeSecurityGroupsRequest & AddGroupNames (Aws::String &&value)
 
DescribeSecurityGroupsRequest & AddGroupNames (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribeSecurityGroupsRequest & WithDryRun (bool value)
 
const Aws::String & GetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeSecurityGroupsRequest & WithNextToken (const Aws::String &value)
 
DescribeSecurityGroupsRequest & WithNextToken (Aws::String &&value)
 
DescribeSecurityGroupsRequest & WithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeSecurityGroupsRequest & WithMaxResults (int value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStream > GetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandler & GetRequestSignedHandler () const
 
const Aws::IOStreamFactory & GetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const
 
virtual const RequestRetryHandler & GetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 23 of file DescribeSecurityGroupsRequest.h.

Constructor & Destructor Documentation

◆ DescribeSecurityGroupsRequest()

Aws::EC2::Model::DescribeSecurityGroupsRequest::DescribeSecurityGroupsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddFilters ( const Filter &  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 438 of file DescribeSecurityGroupsRequest.h.

◆ AddFilters() [2/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddFilters ( Filter &&  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 495 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupIds() [1/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds ( Aws::String &&  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 544 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupIds() [2/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds ( const Aws::String &  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 538 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupIds() [3/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds ( const char *  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 550 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupNames() [1/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames ( Aws::String &&  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 615 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupNames() [2/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames ( const Aws::String &  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 607 of file DescribeSecurityGroupsRequest.h.

◆ AddGroupNames() [3/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames ( const char *  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 623 of file DescribeSecurityGroupsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 640 of file DescribeSecurityGroupsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribeSecurityGroupsRequest::DumpBodyToUrl ( Aws::Http::URI &  uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::FiltersHasBeenSet ( ) const
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 153 of file DescribeSecurityGroupsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 632 of file DescribeSecurityGroupsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribeSecurityGroupsRequest::GetFilters ( ) const
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 96 of file DescribeSecurityGroupsRequest.h.

◆ GetGroupIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSecurityGroupsRequest::GetGroupIds ( ) const
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 502 of file DescribeSecurityGroupsRequest.h.

◆ GetGroupNames()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribeSecurityGroupsRequest::GetGroupNames ( ) const
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 559 of file DescribeSecurityGroupsRequest.h.

◆ GetMaxResults()

int Aws::EC2::Model::DescribeSecurityGroupsRequest::GetMaxResults ( ) const
inline

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Definition at line 706 of file DescribeSecurityGroupsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::EC2::Model::DescribeSecurityGroupsRequest::GetNextToken ( ) const
inline

The token to request the next page of results.

Definition at line 662 of file DescribeSecurityGroupsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribeSecurityGroupsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeSecurityGroupsRequest.h.

◆ GroupIdsHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::GroupIdsHasBeenSet ( ) const
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 508 of file DescribeSecurityGroupsRequest.h.

◆ GroupNamesHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::GroupNamesHasBeenSet ( ) const
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 567 of file DescribeSecurityGroupsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Definition at line 714 of file DescribeSecurityGroupsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::EC2::Model::DescribeSecurityGroupsRequest::NextTokenHasBeenSet ( ) const
inline

The token to request the next page of results.

Definition at line 667 of file DescribeSecurityGroupsRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribeSecurityGroupsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 648 of file DescribeSecurityGroupsRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 267 of file DescribeSecurityGroupsRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 210 of file DescribeSecurityGroupsRequest.h.

◆ SetGroupIds() [1/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 520 of file DescribeSecurityGroupsRequest.h.

◆ SetGroupIds() [2/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 514 of file DescribeSecurityGroupsRequest.h.

◆ SetGroupNames() [1/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 583 of file DescribeSecurityGroupsRequest.h.

◆ SetGroupNames() [2/2]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 575 of file DescribeSecurityGroupsRequest.h.

◆ SetMaxResults()

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Definition at line 722 of file DescribeSecurityGroupsRequest.h.

◆ SetNextToken() [1/3]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken ( Aws::String &&  value)
inline

The token to request the next page of results.

Definition at line 677 of file DescribeSecurityGroupsRequest.h.

◆ SetNextToken() [2/3]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken ( const Aws::String &  value)
inline

The token to request the next page of results.

Definition at line 672 of file DescribeSecurityGroupsRequest.h.

◆ SetNextToken() [3/3]

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken ( const char *  value)
inline

The token to request the next page of results.

Definition at line 682 of file DescribeSecurityGroupsRequest.h.

◆ WithDryRun()

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 656 of file DescribeSecurityGroupsRequest.h.

◆ WithFilters() [1/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 381 of file DescribeSecurityGroupsRequest.h.

◆ WithFilters() [2/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port

    • For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key

    • The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

Definition at line 324 of file DescribeSecurityGroupsRequest.h.

◆ WithGroupIds() [1/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 532 of file DescribeSecurityGroupsRequest.h.

◆ WithGroupIds() [2/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

Definition at line 526 of file DescribeSecurityGroupsRequest.h.

◆ WithGroupNames() [1/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 599 of file DescribeSecurityGroupsRequest.h.

◆ WithGroupNames() [2/2]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

Definition at line 591 of file DescribeSecurityGroupsRequest.h.

◆ WithMaxResults()

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

Definition at line 730 of file DescribeSecurityGroupsRequest.h.

◆ WithNextToken() [1/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken ( Aws::String &&  value)
inline

The token to request the next page of results.

Definition at line 692 of file DescribeSecurityGroupsRequest.h.

◆ WithNextToken() [2/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken ( const Aws::String &  value)
inline

The token to request the next page of results.

Definition at line 687 of file DescribeSecurityGroupsRequest.h.

◆ WithNextToken() [3/3]

DescribeSecurityGroupsRequest& Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken ( const char *  value)
inline

The token to request the next page of results.

Definition at line 697 of file DescribeSecurityGroupsRequest.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.8.19
Privacy | Site terms | Cookie preferences