/aws-cpp-sdk-rds/include/aws/rds/model/CreateDBParameterGroupRequest.h

https://github.com/aws/aws-sdk-cpp · C Header · 312 lines · 67 code · 48 blank · 197 comment · 0 complexity · 189709f012f5e00c611e3b5d860cc581 MD5 · raw file 

    

  1. /**
    2. 

  2.  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
    3. 

  3.  * SPDX-License-Identifier: Apache-2.0.
    4. 

  4.  */
    5. 

  5. 

  6. #pragma once
    7. 

  7. #include <aws/rds/RDS_EXPORTS.h>
    8. 

  8. #include <aws/rds/RDSRequest.h>
    9. 

  9. #include <aws/core/utils/memory/stl/AWSString.h>
    10. 

  10. #include <aws/core/utils/memory/stl/AWSVector.h>
    11. 

  11. #include <aws/rds/model/Tag.h>
    12. 

  12. #include <utility>
    13. 

  13. 

  14. namespace Aws
    15. 

  15. {
    16. 

  16. namespace RDS
    17. 

  17. {
    18. 

  18. namespace Model
    19. 

  19. {
    20. 

  20. 

  21.   /**
    22. 

  22.    * <p/><p><h3>See Also:</h3>   <a
    23. 

  23.    * href="http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBParameterGroupMessage">AWS
    24. 

  24.    * API Reference</a></p>
    25. 

  25.    */
    26. 

  26.   class AWS_RDS_API CreateDBParameterGroupRequest : public RDSRequest
    27. 

  27.   {
    28. 

  28.   public:
    29. 

  29.     CreateDBParameterGroupRequest();
    30. 

  30. 

  31.     // Service request name is the Operation name which will send this request out,
    32. 

  32.     // each operation should has unique request name, so that we can get operation's name from this request.
    33. 

  33.     // Note: this is not true for response, multiple operations may have the same response name,
    34. 

  34.     // so we can not get operation's name from response.
    35. 

  35.     inline virtual const char* GetServiceRequestName() const override { return "CreateDBParameterGroup"; }
    36. 

  36. 

  37.     Aws::String SerializePayload() const override;
    38. 

  38. 

  39.   protected:
    40. 

  40.     void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
    41. 

  41. 

  42.   public:
    43. 

  43. 

  44.     /**
    45. 

  45.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    46. 

  46.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    47. 

  47.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    48. 

  48.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    49. 

  49.      * string.</p> 
    50. 

  50.      */
    51. 

  51.     inline const Aws::String& GetDBParameterGroupName() const{ return m_dBParameterGroupName; }
    52. 

  52. 

  53.     /**
    54. 

  54.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    55. 

  55.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    56. 

  56.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    57. 

  57.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    58. 

  58.      * string.</p> 
    59. 

  59.      */
    60. 

  60.     inline bool DBParameterGroupNameHasBeenSet() const { return m_dBParameterGroupNameHasBeenSet; }
    61. 

  61. 

  62.     /**
    63. 

  63.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    64. 

  64.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    65. 

  65.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    66. 

  66.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    67. 

  67.      * string.</p> 
    68. 

  68.      */
    69. 

  69.     inline void SetDBParameterGroupName(const Aws::String& value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName = value; }
    70. 

  70. 

  71.     /**
    72. 

  72.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    73. 

  73.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    74. 

  74.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    75. 

  75.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    76. 

  76.      * string.</p> 
    77. 

  77.      */
    78. 

  78.     inline void SetDBParameterGroupName(Aws::String&& value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName = std::move(value); }
    79. 

  79. 

  80.     /**
    81. 

  81.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    82. 

  82.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    83. 

  83.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    84. 

  84.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    85. 

  85.      * string.</p> 
    86. 

  86.      */
    87. 

  87.     inline void SetDBParameterGroupName(const char* value) { m_dBParameterGroupNameHasBeenSet = true; m_dBParameterGroupName.assign(value); }
    88. 

  88. 

  89.     /**
    90. 

  90.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    91. 

  91.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    92. 

  92.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    93. 

  93.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    94. 

  94.      * string.</p> 
    95. 

  95.      */
    96. 

  96.     inline CreateDBParameterGroupRequest& WithDBParameterGroupName(const Aws::String& value) { SetDBParameterGroupName(value); return *this;}
    97. 

  97. 

  98.     /**
    99. 

  99.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    100. 

  100.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    101. 

  101.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    102. 

  102.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    103. 

  103.      * string.</p> 
    104. 

  104.      */
    105. 

  105.     inline CreateDBParameterGroupRequest& WithDBParameterGroupName(Aws::String&& value) { SetDBParameterGroupName(std::move(value)); return *this;}
    106. 

  106. 

  107.     /**
    108. 

  108.      * <p>The name of the DB parameter group.</p> <p>Constraints:</p> <ul> <li> <p>Must
    109. 

  109.      * be 1 to 255 letters, numbers, or hyphens.</p> </li> <li> <p>First character must
    110. 

  110.      * be a letter</p> </li> <li> <p>Can't end with a hyphen or contain two consecutive
    111. 

  111.      * hyphens</p> </li> </ul>  <p>This value is stored as a lowercase
    112. 

  112.      * string.</p> 
    113. 

  113.      */
    114. 

  114.     inline CreateDBParameterGroupRequest& WithDBParameterGroupName(const char* value) { SetDBParameterGroupName(value); return *this;}
    115. 

  115. 

  116. 

  117.     /**
    118. 

  118.      * <p>The DB parameter group family name. A DB parameter group can be associated
    119. 

  119.      * with one and only one DB parameter group family, and can be applied only to a DB
    120. 

  120.      * instance running a database engine and engine version compatible with that DB
    121. 

  121.      * parameter group family.</p> <p>To list all of the available parameter group
    122. 

  122.      * families, use the following command:</p> <p> <code>aws rds
    123. 

  123.      * describe-db-engine-versions --query
    124. 

  124.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    125. 

  125.      * contains duplicates.</p> 
    126. 

  126.      */
    127. 

  127.     inline const Aws::String& GetDBParameterGroupFamily() const{ return m_dBParameterGroupFamily; }
    128. 

  128. 

  129.     /**
    130. 

  130.      * <p>The DB parameter group family name. A DB parameter group can be associated
    131. 

  131.      * with one and only one DB parameter group family, and can be applied only to a DB
    132. 

  132.      * instance running a database engine and engine version compatible with that DB
    133. 

  133.      * parameter group family.</p> <p>To list all of the available parameter group
    134. 

  134.      * families, use the following command:</p> <p> <code>aws rds
    135. 

  135.      * describe-db-engine-versions --query
    136. 

  136.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    137. 

  137.      * contains duplicates.</p> 
    138. 

  138.      */
    139. 

  139.     inline bool DBParameterGroupFamilyHasBeenSet() const { return m_dBParameterGroupFamilyHasBeenSet; }
    140. 

  140. 

  141.     /**
    142. 

  142.      * <p>The DB parameter group family name. A DB parameter group can be associated
    143. 

  143.      * with one and only one DB parameter group family, and can be applied only to a DB
    144. 

  144.      * instance running a database engine and engine version compatible with that DB
    145. 

  145.      * parameter group family.</p> <p>To list all of the available parameter group
    146. 

  146.      * families, use the following command:</p> <p> <code>aws rds
    147. 

  147.      * describe-db-engine-versions --query
    148. 

  148.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    149. 

  149.      * contains duplicates.</p> 
    150. 

  150.      */
    151. 

  151.     inline void SetDBParameterGroupFamily(const Aws::String& value) { m_dBParameterGroupFamilyHasBeenSet = true; m_dBParameterGroupFamily = value; }
    152. 

  152. 

  153.     /**
    154. 

  154.      * <p>The DB parameter group family name. A DB parameter group can be associated
    155. 

  155.      * with one and only one DB parameter group family, and can be applied only to a DB
    156. 

  156.      * instance running a database engine and engine version compatible with that DB
    157. 

  157.      * parameter group family.</p> <p>To list all of the available parameter group
    158. 

  158.      * families, use the following command:</p> <p> <code>aws rds
    159. 

  159.      * describe-db-engine-versions --query
    160. 

  160.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    161. 

  161.      * contains duplicates.</p> 
    162. 

  162.      */
    163. 

  163.     inline void SetDBParameterGroupFamily(Aws::String&& value) { m_dBParameterGroupFamilyHasBeenSet = true; m_dBParameterGroupFamily = std::move(value); }
    164. 

  164. 

  165.     /**
    166. 

  166.      * <p>The DB parameter group family name. A DB parameter group can be associated
    167. 

  167.      * with one and only one DB parameter group family, and can be applied only to a DB
    168. 

  168.      * instance running a database engine and engine version compatible with that DB
    169. 

  169.      * parameter group family.</p> <p>To list all of the available parameter group
    170. 

  170.      * families, use the following command:</p> <p> <code>aws rds
    171. 

  171.      * describe-db-engine-versions --query
    172. 

  172.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    173. 

  173.      * contains duplicates.</p> 
    174. 

  174.      */
    175. 

  175.     inline void SetDBParameterGroupFamily(const char* value) { m_dBParameterGroupFamilyHasBeenSet = true; m_dBParameterGroupFamily.assign(value); }
    176. 

  176. 

  177.     /**
    178. 

  178.      * <p>The DB parameter group family name. A DB parameter group can be associated
    179. 

  179.      * with one and only one DB parameter group family, and can be applied only to a DB
    180. 

  180.      * instance running a database engine and engine version compatible with that DB
    181. 

  181.      * parameter group family.</p> <p>To list all of the available parameter group
    182. 

  182.      * families, use the following command:</p> <p> <code>aws rds
    183. 

  183.      * describe-db-engine-versions --query
    184. 

  184.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    185. 

  185.      * contains duplicates.</p> 
    186. 

  186.      */
    187. 

  187.     inline CreateDBParameterGroupRequest& WithDBParameterGroupFamily(const Aws::String& value) { SetDBParameterGroupFamily(value); return *this;}
    188. 

  188. 

  189.     /**
    190. 

  190.      * <p>The DB parameter group family name. A DB parameter group can be associated
    191. 

  191.      * with one and only one DB parameter group family, and can be applied only to a DB
    192. 

  192.      * instance running a database engine and engine version compatible with that DB
    193. 

  193.      * parameter group family.</p> <p>To list all of the available parameter group
    194. 

  194.      * families, use the following command:</p> <p> <code>aws rds
    195. 

  195.      * describe-db-engine-versions --query
    196. 

  196.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    197. 

  197.      * contains duplicates.</p> 
    198. 

  198.      */
    199. 

  199.     inline CreateDBParameterGroupRequest& WithDBParameterGroupFamily(Aws::String&& value) { SetDBParameterGroupFamily(std::move(value)); return *this;}
    200. 

  200. 

  201.     /**
    202. 

  202.      * <p>The DB parameter group family name. A DB parameter group can be associated
    203. 

  203.      * with one and only one DB parameter group family, and can be applied only to a DB
    204. 

  204.      * instance running a database engine and engine version compatible with that DB
    205. 

  205.      * parameter group family.</p> <p>To list all of the available parameter group
    206. 

  206.      * families, use the following command:</p> <p> <code>aws rds
    207. 

  207.      * describe-db-engine-versions --query
    208. 

  208.      * "DBEngineVersions[].DBParameterGroupFamily"</code> </p>  <p>The output
    209. 

  209.      * contains duplicates.</p> 
    210. 

  210.      */
    211. 

  211.     inline CreateDBParameterGroupRequest& WithDBParameterGroupFamily(const char* value) { SetDBParameterGroupFamily(value); return *this;}
    212. 

  212. 

  213. 

  214.     /**
    215. 

  215.      * <p>The description for the DB parameter group.</p>
    216. 

  216.      */
    217. 

  217.     inline const Aws::String& GetDescription() const{ return m_description; }
    218. 

  218. 

  219.     /**
    220. 

  220.      * <p>The description for the DB parameter group.</p>
    221. 

  221.      */
    222. 

  222.     inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
    223. 

  223. 

  224.     /**
    225. 

  225.      * <p>The description for the DB parameter group.</p>
    226. 

  226.      */
    227. 

  227.     inline void SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; }
    228. 

  228. 

  229.     /**
    230. 

  230.      * <p>The description for the DB parameter group.</p>
    231. 

  231.      */
    232. 

  232.     inline void SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); }
    233. 

  233. 

  234.     /**
    235. 

  235.      * <p>The description for the DB parameter group.</p>
    236. 

  236.      */
    237. 

  237.     inline void SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); }
    238. 

  238. 

  239.     /**
    240. 

  240.      * <p>The description for the DB parameter group.</p>
    241. 

  241.      */
    242. 

  242.     inline CreateDBParameterGroupRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;}
    243. 

  243. 

  244.     /**
    245. 

  245.      * <p>The description for the DB parameter group.</p>
    246. 

  246.      */
    247. 

  247.     inline CreateDBParameterGroupRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;}
    248. 

  248. 

  249.     /**
    250. 

  250.      * <p>The description for the DB parameter group.</p>
    251. 

  251.      */
    252. 

  252.     inline CreateDBParameterGroupRequest& WithDescription(const char* value) { SetDescription(value); return *this;}
    253. 

  253. 

  254. 

  255.     /**
    256. 

  256.      * <p>Tags to assign to the DB parameter group.</p>
    257. 

  257.      */
    258. 

  258.     inline const Aws::Vector<Tag>& GetTags() const{ return m_tags; }
    259. 

  259. 

  260.     /**
    261. 

  261.      * <p>Tags to assign to the DB parameter group.</p>
    262. 

  262.      */
    263. 

  263.     inline bool TagsHasBeenSet() const { return m_tagsHasBeenSet; }
    264. 

  264. 

  265.     /**
    266. 

  266.      * <p>Tags to assign to the DB parameter group.</p>
    267. 

  267.      */
    268. 

  268.     inline void SetTags(const Aws::Vector<Tag>& value) { m_tagsHasBeenSet = true; m_tags = value; }
    269. 

  269. 

  270.     /**
    271. 

  271.      * <p>Tags to assign to the DB parameter group.</p>
    272. 

  272.      */
    273. 

  273.     inline void SetTags(Aws::Vector<Tag>&& value) { m_tagsHasBeenSet = true; m_tags = std::move(value); }
    274. 

  274. 

  275.     /**
    276. 

  276.      * <p>Tags to assign to the DB parameter group.</p>
    277. 

  277.      */
    278. 

  278.     inline CreateDBParameterGroupRequest& WithTags(const Aws::Vector<Tag>& value) { SetTags(value); return *this;}
    279. 

  279. 

  280.     /**
    281. 

  281.      * <p>Tags to assign to the DB parameter group.</p>
    282. 

  282.      */
    283. 

  283.     inline CreateDBParameterGroupRequest& WithTags(Aws::Vector<Tag>&& value) { SetTags(std::move(value)); return *this;}
    284. 

  284. 

  285.     /**
    286. 

  286.      * <p>Tags to assign to the DB parameter group.</p>
    287. 

  287.      */
    288. 

  288.     inline CreateDBParameterGroupRequest& AddTags(const Tag& value) { m_tagsHasBeenSet = true; m_tags.push_back(value); return *this; }
    289. 

  289. 

  290.     /**
    291. 

  291.      * <p>Tags to assign to the DB parameter group.</p>
    292. 

  292.      */
    293. 

  293.     inline CreateDBParameterGroupRequest& AddTags(Tag&& value) { m_tagsHasBeenSet = true; m_tags.push_back(std::move(value)); return *this; }
    294. 

  294. 

  295.   private:
    296. 

  296. 

  297.     Aws::String m_dBParameterGroupName;
    298. 

  298.     bool m_dBParameterGroupNameHasBeenSet;
    299. 

  299. 

  300.     Aws::String m_dBParameterGroupFamily;
    301. 

  301.     bool m_dBParameterGroupFamilyHasBeenSet;
    302. 

  302. 

  303.     Aws::String m_description;
    304. 

  304.     bool m_descriptionHasBeenSet;
    305. 

  305. 

  306.     Aws::Vector<Tag> m_tags;
    307. 

  307.     bool m_tagsHasBeenSet;
    308. 

  308.   };
    309. 

  309. 

  310. } // namespace Model
    311. 

  311. } // namespace RDS
    312. 

  312. } // namespace Aws
    313.