AWS SDK for C++  1.9.123
AWS SDK for C++
DescribeSecurityGroupsRequest.h
Go to the documentation of this file.
1 
6 #pragma once
7 #include <aws/ec2/EC2_EXPORTS.h>
8 #include <aws/ec2/EC2Request.h>
11 #include <aws/ec2/model/Filter.h>
12 #include <utility>
13 
14 namespace Aws
15 {
16 namespace EC2
17 {
18 namespace Model
19 {
20 
24  {
25  public:
27 
28  // Service request name is the Operation name which will send this request out,
29  // each operation should has unique request name, so that we can get operation's name from this request.
30  // Note: this is not true for response, multiple operations may have the same response name,
31  // so we can not get operation's name from response.
32  inline virtual const char* GetServiceRequestName() const override { return "DescribeSecurityGroups"; }
33 
34  Aws::String SerializePayload() const override;
35 
36  protected:
37  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
38 
39  public:
40 
97  inline const Aws::Vector<Filter>& GetFilters() const{ return m_filters; }
98 
155  inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
156 
213  inline void SetFilters(const Aws::Vector<Filter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
214 
271  inline void SetFilters(Aws::Vector<Filter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
272 
329  inline DescribeSecurityGroupsRequest& WithFilters(const Aws::Vector<Filter>& value) { SetFilters(value); return *this;}
330 
387  inline DescribeSecurityGroupsRequest& WithFilters(Aws::Vector<Filter>&& value) { SetFilters(std::move(value)); return *this;}
388 
445  inline DescribeSecurityGroupsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
446 
503  inline DescribeSecurityGroupsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
504 
505 
510  inline const Aws::Vector<Aws::String>& GetGroupIds() const{ return m_groupIds; }
511 
516  inline bool GroupIdsHasBeenSet() const { return m_groupIdsHasBeenSet; }
517 
522  inline void SetGroupIds(const Aws::Vector<Aws::String>& value) { m_groupIdsHasBeenSet = true; m_groupIds = value; }
523 
528  inline void SetGroupIds(Aws::Vector<Aws::String>&& value) { m_groupIdsHasBeenSet = true; m_groupIds = std::move(value); }
529 
534  inline DescribeSecurityGroupsRequest& WithGroupIds(const Aws::Vector<Aws::String>& value) { SetGroupIds(value); return *this;}
535 
540  inline DescribeSecurityGroupsRequest& WithGroupIds(Aws::Vector<Aws::String>&& value) { SetGroupIds(std::move(value)); return *this;}
541 
546  inline DescribeSecurityGroupsRequest& AddGroupIds(const Aws::String& value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(value); return *this; }
547 
552  inline DescribeSecurityGroupsRequest& AddGroupIds(Aws::String&& value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(std::move(value)); return *this; }
553 
558  inline DescribeSecurityGroupsRequest& AddGroupIds(const char* value) { m_groupIdsHasBeenSet = true; m_groupIds.push_back(value); return *this; }
559 
560 
568  inline const Aws::Vector<Aws::String>& GetGroupNames() const{ return m_groupNames; }
569 
577  inline bool GroupNamesHasBeenSet() const { return m_groupNamesHasBeenSet; }
578 
586  inline void SetGroupNames(const Aws::Vector<Aws::String>& value) { m_groupNamesHasBeenSet = true; m_groupNames = value; }
587 
595  inline void SetGroupNames(Aws::Vector<Aws::String>&& value) { m_groupNamesHasBeenSet = true; m_groupNames = std::move(value); }
596 
604  inline DescribeSecurityGroupsRequest& WithGroupNames(const Aws::Vector<Aws::String>& value) { SetGroupNames(value); return *this;}
605 
613  inline DescribeSecurityGroupsRequest& WithGroupNames(Aws::Vector<Aws::String>&& value) { SetGroupNames(std::move(value)); return *this;}
614 
622  inline DescribeSecurityGroupsRequest& AddGroupNames(const Aws::String& value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(value); return *this; }
623 
631  inline DescribeSecurityGroupsRequest& AddGroupNames(Aws::String&& value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(std::move(value)); return *this; }
632 
640  inline DescribeSecurityGroupsRequest& AddGroupNames(const char* value) { m_groupNamesHasBeenSet = true; m_groupNames.push_back(value); return *this; }
641 
642 
649  inline bool GetDryRun() const{ return m_dryRun; }
650 
657  inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; }
658 
665  inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; }
666 
673  inline DescribeSecurityGroupsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;}
674 
675 
679  inline const Aws::String& GetNextToken() const{ return m_nextToken; }
680 
684  inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
685 
689  inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
690 
694  inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
695 
699  inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
700 
704  inline DescribeSecurityGroupsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
705 
709  inline DescribeSecurityGroupsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
710 
714  inline DescribeSecurityGroupsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
715 
716 
723  inline int GetMaxResults() const{ return m_maxResults; }
724 
731  inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
732 
739  inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
740 
747  inline DescribeSecurityGroupsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
748 
749  private:
750 
751  Aws::Vector<Filter> m_filters;
752  bool m_filtersHasBeenSet;
753 
754  Aws::Vector<Aws::String> m_groupIds;
755  bool m_groupIdsHasBeenSet;
756 
757  Aws::Vector<Aws::String> m_groupNames;
758  bool m_groupNamesHasBeenSet;
759 
760  bool m_dryRun;
761  bool m_dryRunHasBeenSet;
762 
763  Aws::String m_nextToken;
764  bool m_nextTokenHasBeenSet;
765 
766  int m_maxResults;
767  bool m_maxResultsHasBeenSet;
768  };
769 
770 } // namespace Model
771 } // namespace EC2
772 } // namespace Aws
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupIds
DescribeSecurityGroupsRequest & WithGroupIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSecurityGroupsRequest.h:534
Aws::EC2::Model::DescribeSecurityGroupsRequest::DescribeSecurityGroupsRequest
DescribeSecurityGroupsRequest()
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupNames
void SetGroupNames(Aws::Vector< Aws::String > &&value)
Definition: DescribeSecurityGroupsRequest.h:595
Aws::EC2::Model::DescribeSecurityGroupsRequest
Definition: DescribeSecurityGroupsRequest.h:24
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddFilters
DescribeSecurityGroupsRequest & AddFilters(const Filter &value)
Definition: DescribeSecurityGroupsRequest.h:445
Aws::Http::URI
Definition: URI.h:32
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames
DescribeSecurityGroupsRequest & AddGroupNames(const char *value)
Definition: DescribeSecurityGroupsRequest.h:640
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken
DescribeSecurityGroupsRequest & WithNextToken(Aws::String &&value)
Definition: DescribeSecurityGroupsRequest.h:709
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupIds
void SetGroupIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSecurityGroupsRequest.h:528
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetDryRun
bool GetDryRun() const
Definition: DescribeSecurityGroupsRequest.h:649
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds
DescribeSecurityGroupsRequest & AddGroupIds(const Aws::String &value)
Definition: DescribeSecurityGroupsRequest.h:546
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupIds
void SetGroupIds(const Aws::Vector< Aws::String > &value)
Definition: DescribeSecurityGroupsRequest.h:522
Aws::EC2::Model::DescribeSecurityGroupsRequest::MaxResultsHasBeenSet
bool MaxResultsHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:731
AWS_EC2_API
#define AWS_EC2_API
Definition: EC2_EXPORTS.h:28
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken
void SetNextToken(const char *value)
Definition: DescribeSecurityGroupsRequest.h:699
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken
DescribeSecurityGroupsRequest & WithNextToken(const Aws::String &value)
Definition: DescribeSecurityGroupsRequest.h:704
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithMaxResults
DescribeSecurityGroupsRequest & WithMaxResults(int value)
Definition: DescribeSecurityGroupsRequest.h:747
Aws::EC2::Model::Filter
Definition: Filter.h:36
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds
DescribeSecurityGroupsRequest & AddGroupIds(const char *value)
Definition: DescribeSecurityGroupsRequest.h:558
AWSVector.h
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames
DescribeSecurityGroupsRequest & AddGroupNames(const Aws::String &value)
Definition: DescribeSecurityGroupsRequest.h:622
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupNames
DescribeSecurityGroupsRequest & WithGroupNames(const Aws::Vector< Aws::String > &value)
Definition: DescribeSecurityGroupsRequest.h:604
Filter.h
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetMaxResults
void SetMaxResults(int value)
Definition: DescribeSecurityGroupsRequest.h:739
Aws::EC2::Model::DescribeSecurityGroupsRequest::NextTokenHasBeenSet
bool NextTokenHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:684
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetGroupNames
const Aws::Vector< Aws::String > & GetGroupNames() const
Definition: DescribeSecurityGroupsRequest.h:568
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetFilters
void SetFilters(Aws::Vector< Filter > &&value)
Definition: DescribeSecurityGroupsRequest.h:271
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: DescribeSecurityGroupsRequest.h:32
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithDryRun
DescribeSecurityGroupsRequest & WithDryRun(bool value)
Definition: DescribeSecurityGroupsRequest.h:673
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithFilters
DescribeSecurityGroupsRequest & WithFilters(Aws::Vector< Filter > &&value)
Definition: DescribeSecurityGroupsRequest.h:387
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetFilters
const Aws::Vector< Filter > & GetFilters() const
Definition: DescribeSecurityGroupsRequest.h:97
EC2Request.h
Aws::EC2::Model::DescribeSecurityGroupsRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
AWSString.h
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken
void SetNextToken(const Aws::String &value)
Definition: DescribeSecurityGroupsRequest.h:689
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetNextToken
void SetNextToken(Aws::String &&value)
Definition: DescribeSecurityGroupsRequest.h:694
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithFilters
DescribeSecurityGroupsRequest & WithFilters(const Aws::Vector< Filter > &value)
Definition: DescribeSecurityGroupsRequest.h:329
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddFilters
DescribeSecurityGroupsRequest & AddFilters(Filter &&value)
Definition: DescribeSecurityGroupsRequest.h:503
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupNames
DescribeSecurityGroupsRequest & WithGroupNames(Aws::Vector< Aws::String > &&value)
Definition: DescribeSecurityGroupsRequest.h:613
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithGroupIds
DescribeSecurityGroupsRequest & WithGroupIds(Aws::Vector< Aws::String > &&value)
Definition: DescribeSecurityGroupsRequest.h:540
Aws::EC2::Model::DescribeSecurityGroupsRequest::GroupNamesHasBeenSet
bool GroupNamesHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:577
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetNextToken
const Aws::String & GetNextToken() const
Definition: DescribeSecurityGroupsRequest.h:679
Aws
Definition: AccessManagementClient.h:15
Aws::EC2::Model::DescribeSecurityGroupsRequest::FiltersHasBeenSet
bool FiltersHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:155
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetMaxResults
int GetMaxResults() const
Definition: DescribeSecurityGroupsRequest.h:723
Aws::EC2::Model::DescribeSecurityGroupsRequest::GetGroupIds
const Aws::Vector< Aws::String > & GetGroupIds() const
Definition: DescribeSecurityGroupsRequest.h:510
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetFilters
void SetFilters(const Aws::Vector< Filter > &value)
Definition: DescribeSecurityGroupsRequest.h:213
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupNames
DescribeSecurityGroupsRequest & AddGroupNames(Aws::String &&value)
Definition: DescribeSecurityGroupsRequest.h:631
Aws::EC2::Model::DescribeSecurityGroupsRequest::AddGroupIds
DescribeSecurityGroupsRequest & AddGroupIds(Aws::String &&value)
Definition: DescribeSecurityGroupsRequest.h:552
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::EC2::EC2Request
Definition: EC2Request.h:17
Aws::EC2::Model::DescribeSecurityGroupsRequest::WithNextToken
DescribeSecurityGroupsRequest & WithNextToken(const char *value)
Definition: DescribeSecurityGroupsRequest.h:714
Aws::EC2::Model::DescribeSecurityGroupsRequest::GroupIdsHasBeenSet
bool GroupIdsHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:516
EC2_EXPORTS.h
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetGroupNames
void SetGroupNames(const Aws::Vector< Aws::String > &value)
Definition: DescribeSecurityGroupsRequest.h:586
Aws::EC2::Model::DescribeSecurityGroupsRequest::SetDryRun
void SetDryRun(bool value)
Definition: DescribeSecurityGroupsRequest.h:665
Aws::EC2::Model::DescribeSecurityGroupsRequest::DryRunHasBeenSet
bool DryRunHasBeenSet() const
Definition: DescribeSecurityGroupsRequest.h:657
Aws::EC2::Model::DescribeSecurityGroupsRequest::SerializePayload
Aws::String SerializePayload() const override