Aws::EC2::Model::DescribeSecurityGroupsRequest Class Reference

#include <DescribeSecurityGroupsRequest.h>

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

Public Member Functions

AWS_EC2_API DescribeSecurityGroupsRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_EC2_API Aws::String SerializePayload () const override

 

const Aws::Vector< Aws::String > & GetGroupIds () const

 

bool GroupIdsHasBeenSet () const

 

template<typename GroupIdsT = Aws::Vector<Aws::String>>

void SetGroupIds (GroupIdsT &&value)

 

template<typename GroupIdsT = Aws::Vector<Aws::String>>

DescribeSecurityGroupsRequest & WithGroupIds (GroupIdsT &&value)

 

template<typename GroupIdsT = Aws::String>

DescribeSecurityGroupsRequest & AddGroupIds (GroupIdsT &&value)

 

const Aws::Vector< Aws::String > & GetGroupNames () const

 

bool GroupNamesHasBeenSet () const

 

template<typename GroupNamesT = Aws::Vector<Aws::String>>

void SetGroupNames (GroupNamesT &&value)

 

template<typename GroupNamesT = Aws::Vector<Aws::String>>

DescribeSecurityGroupsRequest & WithGroupNames (GroupNamesT &&value)

 

template<typename GroupNamesT = Aws::String>

DescribeSecurityGroupsRequest & AddGroupNames (GroupNamesT &&value)

 

const Aws::String & GetNextToken () const

 

bool NextTokenHasBeenSet () const

 

template<typename NextTokenT = Aws::String>

void SetNextToken (NextTokenT &&value)

 

template<typename NextTokenT = Aws::String>

DescribeSecurityGroupsRequest & WithNextToken (NextTokenT &&value)

 

int GetMaxResults () const

 

bool MaxResultsHasBeenSet () const

 

void SetMaxResults (int value)

 

DescribeSecurityGroupsRequest & WithMaxResults (int value)

 

bool GetDryRun () const

 

bool DryRunHasBeenSet () const

 

void SetDryRun (bool value)

 

DescribeSecurityGroupsRequest & WithDryRun (bool value)

 

const Aws::Vector< Filter > & GetFilters () const

 

bool FiltersHasBeenSet () const

 

template<typename FiltersT = Aws::Vector<Filter>>

void SetFilters (FiltersT &&value)

 

template<typename FiltersT = Aws::Vector<Filter>>

DescribeSecurityGroupsRequest & WithFilters (FiltersT &&value)

 

template<typename FiltersT = Filter>

DescribeSecurityGroupsRequest & AddFilters (FiltersT &&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 const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

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 HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) const

 

virtual bool IsChunked () const

 

virtual bool IsLongPollingOperation () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

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

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () const

 

virtual bool ChecksumAlgorithmIsSet () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Protected Member Functions

AWS_EC2_API void DumpBodyToUrl (Aws::Http::URI &uri) const override

 

Protected Member Functions inherited from Aws::EC2::EC2Request

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Additional Inherited Members

Public Types inherited from Aws::EC2::EC2Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 21 of file DescribeSecurityGroupsRequest.h.

Constructor & Destructor Documentation

DescribeSecurityGroupsRequest()

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

default

Member Function Documentation

AddFilters()

template<typename FiltersT = Filter>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::AddFilters ( FiltersT &&  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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services account that has been referenced in an inbound security group rule.

• owner-id - The Amazon Web Services 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 216 of file DescribeSecurityGroupsRequest.h.

AddGroupIds()

template<typename GroupIdsT = Aws::String>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds ( GroupIdsT &&  value)

inline

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

Default: Describes all of your security groups.

Definition at line 55 of file DescribeSecurityGroupsRequest.h.

AddGroupNames()

template<typename GroupNamesT = Aws::String>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames ( GroupNamesT &&  value)

inline

[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

Default: Describes all of your security groups.

Definition at line 81 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 135 of file DescribeSecurityGroupsRequest.h.

DumpBodyToUrl()

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

overrideprotectedvirtual

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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services account that has been referenced in an inbound security group rule.

• owner-id - The Amazon Web Services 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 204 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 134 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services account that has been referenced in an inbound security group rule.

• owner-id - The Amazon Web Services 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 203 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 of your security groups.

Definition at line 42 of file DescribeSecurityGroupsRequest.h.

GetGroupNames()

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

inline

[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

Default: Describes all of your security groups.

Definition at line 68 of file DescribeSecurityGroupsRequest.h.

GetMaxResults()

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

inline

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Definition at line 115 of file DescribeSecurityGroupsRequest.h.

GetNextToken()

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

inline

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Definition at line 93 of file DescribeSecurityGroupsRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 29 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 of your security groups.

Definition at line 43 of file DescribeSecurityGroupsRequest.h.

GroupNamesHasBeenSet()

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

inline

[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

Default: Describes all of your security groups.

Definition at line 69 of file DescribeSecurityGroupsRequest.h.

MaxResultsHasBeenSet()

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

inline

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Definition at line 116 of file DescribeSecurityGroupsRequest.h.

NextTokenHasBeenSet()

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

inline

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Definition at line 94 of file DescribeSecurityGroupsRequest.h.

SerializePayload()

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

overridevirtual

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 136 of file DescribeSecurityGroupsRequest.h.

SetFilters()

template<typename FiltersT = Aws::Vector<Filter>>

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetFilters ( FiltersT &&  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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services account that has been referenced in an inbound security group rule.

• owner-id - The Amazon Web Services 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 206 of file DescribeSecurityGroupsRequest.h.

SetGroupIds()

template<typename GroupIdsT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupIds ( GroupIdsT &&  value)

inline

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

Default: Describes all of your security groups.

Definition at line 45 of file DescribeSecurityGroupsRequest.h.

SetGroupNames()

template<typename GroupNamesT = Aws::Vector<Aws::String>>

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupNames ( GroupNamesT &&  value)

inline

[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

Default: Describes all of your security groups.

Definition at line 71 of file DescribeSecurityGroupsRequest.h.

SetMaxResults()

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

inline

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Definition at line 117 of file DescribeSecurityGroupsRequest.h.

SetNextToken()

template<typename NextTokenT = Aws::String>

void Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken ( NextTokenT &&  value)

inline

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Definition at line 96 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 140 of file DescribeSecurityGroupsRequest.h.

WithFilters()

template<typename FiltersT = Aws::Vector<Filter>>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::WithFilters ( FiltersT &&  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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services 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 is 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, a protocol number, or -1 for all protocols).

• 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 Amazon Web Services account that has been referenced in an inbound security group rule.

• owner-id - The Amazon Web Services 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 211 of file DescribeSecurityGroupsRequest.h.

WithGroupIds()

template<typename GroupIdsT = Aws::Vector<Aws::String>>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupIds ( GroupIdsT &&  value)

inline

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

Default: Describes all of your security groups.

Definition at line 50 of file DescribeSecurityGroupsRequest.h.

WithGroupNames()

template<typename GroupNamesT = Aws::Vector<Aws::String>>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupNames ( GroupNamesT &&  value)

inline

[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.

Default: Describes all of your security groups.

Definition at line 76 of file DescribeSecurityGroupsRequest.h.

WithMaxResults()

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

inline

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.

Definition at line 121 of file DescribeSecurityGroupsRequest.h.

WithNextToken()

template<typename NextTokenT = Aws::String>

DescribeSecurityGroupsRequest & Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken ( NextTokenT &&  value)

inline

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Definition at line 101 of file DescribeSecurityGroupsRequest.h.

---

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

• generated/src/aws-cpp-sdk-ec2/include/aws/ec2/model/DescribeSecurityGroupsRequest.h