aws_sdk_ssm/operation/put_parameter/
_put_parameter_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
5pub struct PutParameterInput {
6    /// <p>The fully qualified name of the parameter that you want to create or update.</p><note>
7    /// <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p>
8    /// </note>
9    /// <p>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code></p>
10    /// <p>Naming Constraints:</p>
11    /// <ul>
12    /// <li>
13    /// <p>Parameter names are case sensitive.</p></li>
14    /// <li>
15    /// <p>A parameter name must be unique within an Amazon Web Services Region</p></li>
16    /// <li>
17    /// <p>A parameter name can't be prefixed with "<code>aws</code>" or "<code>ssm</code>" (case-insensitive).</p></li>
18    /// <li>
19    /// <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code></p>
20    /// <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code></p></li>
21    /// <li>
22    /// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p></li>
23    /// <li>
24    /// <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p></li>
25    /// </ul>
26    /// <p>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
27    /// <p>The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.</p>
28    /// <p>This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p>
29    /// </note>
30    pub name: ::std::option::Option<::std::string::String>,
31    /// <p>Information about the parameter that you want to add to the system. Optional but recommended.</p><important>
32    /// <p>Don't enter personally identifiable information in this field.</p>
33    /// </important>
34    pub description: ::std::option::Option<::std::string::String>,
35    /// <p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p><note>
36    /// <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p>
37    /// </note>
38    pub value: ::std::option::Option<::std::string::String>,
39    /// <p>The type of parameter that you want to create.</p><note>
40    /// <p><code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
41    /// </note>
42    /// <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p><important>
43    /// <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p>
44    /// </important>
45    pub r#type: ::std::option::Option<crate::types::ParameterType>,
46    /// <p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
47    /// <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key.</p>
48    /// <ul>
49    /// <li>
50    /// <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p></li>
51    /// </ul>
52    pub key_id: ::std::option::Option<::std::string::String>,
53    /// <p>Overwrite an existing parameter. The default value is <code>false</code>.</p>
54    pub overwrite: ::std::option::Option<bool>,
55    /// <p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$</p>
56    pub allowed_pattern: ::std::option::Option<::std::string::String>,
57    /// <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p>
58    /// <ul>
59    /// <li>
60    /// <p><code>Key=Resource,Value=S3bucket</code></p></li>
61    /// <li>
62    /// <p><code>Key=OS,Value=Windows</code></p></li>
63    /// <li>
64    /// <p><code>Key=ParameterType,Value=LicenseKey</code></p></li>
65    /// </ul><note>
66    /// <p>To add tags to an existing Systems Manager parameter, use the <code>AddTagsToResource</code> operation.</p>
67    /// </note>
68    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
69    /// <p>The parameter tier to assign to a parameter.</p>
70    /// <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.</p>
71    /// <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
72    /// <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p>
73    /// <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.</p>
74    /// <p><b>Using the Default Tier Configuration</b></p>
75    /// <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p>
76    /// <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p>
77    /// <ul>
78    /// <li>
79    /// <p><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters.</p></li>
80    /// <li>
81    /// <p><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.</p>
82    /// <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p>
83    /// <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.</p></li>
84    /// </ul>
85    /// <p>Options that require an advanced parameter include the following:</p>
86    /// <ul>
87    /// <li>
88    /// <p>The content size of the parameter is more than 4 KB.</p></li>
89    /// <li>
90    /// <p>The parameter uses a parameter policy.</p></li>
91    /// <li>
92    /// <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p></li>
93    /// </ul>
94    /// <p>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
95    pub tier: ::std::option::Option<crate::types::ParameterTier>,
96    /// <p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p>
97    /// <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p>
98    /// <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p>
99    /// <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p>
100    /// <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>.</p>
101    pub policies: ::std::option::Option<::std::string::String>,
102    /// <p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p>
103    /// <p><b>The following data type values are supported.</b></p>
104    /// <ul>
105    /// <li>
106    /// <p><code>text</code></p></li>
107    /// <li>
108    /// <p><code>aws:ec2:image</code></p></li>
109    /// <li>
110    /// <p><code>aws:ssm:integration</code></p></li>
111    /// </ul>
112    /// <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account.</p><note>
113    /// <p>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <code>PutParameter</code> call for all cases except for data type <code>aws:ec2:image</code>. If you call <code>PutParameter</code> with <code>aws:ec2:image</code> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <code>aws:ec2:image</code> value is validated asynchronously, and the <code>PutParameter</code> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <code>aws:ec2:image</code> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>.</p>
114    /// </note>
115    pub data_type: ::std::option::Option<::std::string::String>,
116}
117impl PutParameterInput {
118    /// <p>The fully qualified name of the parameter that you want to create or update.</p><note>
119    /// <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p>
120    /// </note>
121    /// <p>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code></p>
122    /// <p>Naming Constraints:</p>
123    /// <ul>
124    /// <li>
125    /// <p>Parameter names are case sensitive.</p></li>
126    /// <li>
127    /// <p>A parameter name must be unique within an Amazon Web Services Region</p></li>
128    /// <li>
129    /// <p>A parameter name can't be prefixed with "<code>aws</code>" or "<code>ssm</code>" (case-insensitive).</p></li>
130    /// <li>
131    /// <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code></p>
132    /// <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code></p></li>
133    /// <li>
134    /// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p></li>
135    /// <li>
136    /// <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p></li>
137    /// </ul>
138    /// <p>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
139    /// <p>The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.</p>
140    /// <p>This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p>
141    /// </note>
142    pub fn name(&self) -> ::std::option::Option<&str> {
143        self.name.as_deref()
144    }
145    /// <p>Information about the parameter that you want to add to the system. Optional but recommended.</p><important>
146    /// <p>Don't enter personally identifiable information in this field.</p>
147    /// </important>
148    pub fn description(&self) -> ::std::option::Option<&str> {
149        self.description.as_deref()
150    }
151    /// <p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p><note>
152    /// <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p>
153    /// </note>
154    pub fn value(&self) -> ::std::option::Option<&str> {
155        self.value.as_deref()
156    }
157    /// <p>The type of parameter that you want to create.</p><note>
158    /// <p><code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
159    /// </note>
160    /// <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p><important>
161    /// <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p>
162    /// </important>
163    pub fn r#type(&self) -> ::std::option::Option<&crate::types::ParameterType> {
164        self.r#type.as_ref()
165    }
166    /// <p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
167    /// <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key.</p>
168    /// <ul>
169    /// <li>
170    /// <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p></li>
171    /// </ul>
172    pub fn key_id(&self) -> ::std::option::Option<&str> {
173        self.key_id.as_deref()
174    }
175    /// <p>Overwrite an existing parameter. The default value is <code>false</code>.</p>
176    pub fn overwrite(&self) -> ::std::option::Option<bool> {
177        self.overwrite
178    }
179    /// <p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$</p>
180    pub fn allowed_pattern(&self) -> ::std::option::Option<&str> {
181        self.allowed_pattern.as_deref()
182    }
183    /// <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p>
184    /// <ul>
185    /// <li>
186    /// <p><code>Key=Resource,Value=S3bucket</code></p></li>
187    /// <li>
188    /// <p><code>Key=OS,Value=Windows</code></p></li>
189    /// <li>
190    /// <p><code>Key=ParameterType,Value=LicenseKey</code></p></li>
191    /// </ul><note>
192    /// <p>To add tags to an existing Systems Manager parameter, use the <code>AddTagsToResource</code> operation.</p>
193    /// </note>
194    ///
195    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
196    pub fn tags(&self) -> &[crate::types::Tag] {
197        self.tags.as_deref().unwrap_or_default()
198    }
199    /// <p>The parameter tier to assign to a parameter.</p>
200    /// <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.</p>
201    /// <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
202    /// <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p>
203    /// <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.</p>
204    /// <p><b>Using the Default Tier Configuration</b></p>
205    /// <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p>
206    /// <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p>
207    /// <ul>
208    /// <li>
209    /// <p><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters.</p></li>
210    /// <li>
211    /// <p><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.</p>
212    /// <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p>
213    /// <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.</p></li>
214    /// </ul>
215    /// <p>Options that require an advanced parameter include the following:</p>
216    /// <ul>
217    /// <li>
218    /// <p>The content size of the parameter is more than 4 KB.</p></li>
219    /// <li>
220    /// <p>The parameter uses a parameter policy.</p></li>
221    /// <li>
222    /// <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p></li>
223    /// </ul>
224    /// <p>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
225    pub fn tier(&self) -> ::std::option::Option<&crate::types::ParameterTier> {
226        self.tier.as_ref()
227    }
228    /// <p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p>
229    /// <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p>
230    /// <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p>
231    /// <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p>
232    /// <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>.</p>
233    pub fn policies(&self) -> ::std::option::Option<&str> {
234        self.policies.as_deref()
235    }
236    /// <p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p>
237    /// <p><b>The following data type values are supported.</b></p>
238    /// <ul>
239    /// <li>
240    /// <p><code>text</code></p></li>
241    /// <li>
242    /// <p><code>aws:ec2:image</code></p></li>
243    /// <li>
244    /// <p><code>aws:ssm:integration</code></p></li>
245    /// </ul>
246    /// <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account.</p><note>
247    /// <p>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <code>PutParameter</code> call for all cases except for data type <code>aws:ec2:image</code>. If you call <code>PutParameter</code> with <code>aws:ec2:image</code> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <code>aws:ec2:image</code> value is validated asynchronously, and the <code>PutParameter</code> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <code>aws:ec2:image</code> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>.</p>
248    /// </note>
249    pub fn data_type(&self) -> ::std::option::Option<&str> {
250        self.data_type.as_deref()
251    }
252}
253impl ::std::fmt::Debug for PutParameterInput {
254    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
255        let mut formatter = f.debug_struct("PutParameterInput");
256        formatter.field("name", &self.name);
257        formatter.field("description", &self.description);
258        formatter.field("value", &"*** Sensitive Data Redacted ***");
259        formatter.field("r#type", &self.r#type);
260        formatter.field("key_id", &self.key_id);
261        formatter.field("overwrite", &self.overwrite);
262        formatter.field("allowed_pattern", &self.allowed_pattern);
263        formatter.field("tags", &self.tags);
264        formatter.field("tier", &self.tier);
265        formatter.field("policies", &self.policies);
266        formatter.field("data_type", &self.data_type);
267        formatter.finish()
268    }
269}
270impl PutParameterInput {
271    /// Creates a new builder-style object to manufacture [`PutParameterInput`](crate::operation::put_parameter::PutParameterInput).
272    pub fn builder() -> crate::operation::put_parameter::builders::PutParameterInputBuilder {
273        crate::operation::put_parameter::builders::PutParameterInputBuilder::default()
274    }
275}
276
277/// A builder for [`PutParameterInput`](crate::operation::put_parameter::PutParameterInput).
278#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
279#[non_exhaustive]
280pub struct PutParameterInputBuilder {
281    pub(crate) name: ::std::option::Option<::std::string::String>,
282    pub(crate) description: ::std::option::Option<::std::string::String>,
283    pub(crate) value: ::std::option::Option<::std::string::String>,
284    pub(crate) r#type: ::std::option::Option<crate::types::ParameterType>,
285    pub(crate) key_id: ::std::option::Option<::std::string::String>,
286    pub(crate) overwrite: ::std::option::Option<bool>,
287    pub(crate) allowed_pattern: ::std::option::Option<::std::string::String>,
288    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
289    pub(crate) tier: ::std::option::Option<crate::types::ParameterTier>,
290    pub(crate) policies: ::std::option::Option<::std::string::String>,
291    pub(crate) data_type: ::std::option::Option<::std::string::String>,
292}
293impl PutParameterInputBuilder {
294    /// <p>The fully qualified name of the parameter that you want to create or update.</p><note>
295    /// <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p>
296    /// </note>
297    /// <p>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code></p>
298    /// <p>Naming Constraints:</p>
299    /// <ul>
300    /// <li>
301    /// <p>Parameter names are case sensitive.</p></li>
302    /// <li>
303    /// <p>A parameter name must be unique within an Amazon Web Services Region</p></li>
304    /// <li>
305    /// <p>A parameter name can't be prefixed with "<code>aws</code>" or "<code>ssm</code>" (case-insensitive).</p></li>
306    /// <li>
307    /// <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code></p>
308    /// <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code></p></li>
309    /// <li>
310    /// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p></li>
311    /// <li>
312    /// <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p></li>
313    /// </ul>
314    /// <p>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
315    /// <p>The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.</p>
316    /// <p>This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p>
317    /// </note>
318    /// This field is required.
319    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
320        self.name = ::std::option::Option::Some(input.into());
321        self
322    }
323    /// <p>The fully qualified name of the parameter that you want to create or update.</p><note>
324    /// <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p>
325    /// </note>
326    /// <p>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code></p>
327    /// <p>Naming Constraints:</p>
328    /// <ul>
329    /// <li>
330    /// <p>Parameter names are case sensitive.</p></li>
331    /// <li>
332    /// <p>A parameter name must be unique within an Amazon Web Services Region</p></li>
333    /// <li>
334    /// <p>A parameter name can't be prefixed with "<code>aws</code>" or "<code>ssm</code>" (case-insensitive).</p></li>
335    /// <li>
336    /// <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code></p>
337    /// <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code></p></li>
338    /// <li>
339    /// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p></li>
340    /// <li>
341    /// <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p></li>
342    /// </ul>
343    /// <p>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
344    /// <p>The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.</p>
345    /// <p>This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p>
346    /// </note>
347    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
348        self.name = input;
349        self
350    }
351    /// <p>The fully qualified name of the parameter that you want to create or update.</p><note>
352    /// <p>You can't enter the Amazon Resource Name (ARN) for a parameter, only the parameter name itself.</p>
353    /// </note>
354    /// <p>The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code></p>
355    /// <p>Naming Constraints:</p>
356    /// <ul>
357    /// <li>
358    /// <p>Parameter names are case sensitive.</p></li>
359    /// <li>
360    /// <p>A parameter name must be unique within an Amazon Web Services Region</p></li>
361    /// <li>
362    /// <p>A parameter name can't be prefixed with "<code>aws</code>" or "<code>ssm</code>" (case-insensitive).</p></li>
363    /// <li>
364    /// <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code></p>
365    /// <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code></p></li>
366    /// <li>
367    /// <p>Parameter names can't contain spaces. The service removes any spaces specified for the beginning or end of a parameter name. If the specified name for a parameter contains spaces between characters, the request fails with a <code>ValidationException</code> error.</p></li>
368    /// <li>
369    /// <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p></li>
370    /// </ul>
371    /// <p>For additional information about valid values for parameter names, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html">Creating Systems Manager parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><note>
372    /// <p>The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by Systems Manager. The maximum length for a parameter name that you specify is 1011 characters.</p>
373    /// <p>This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region: <code>arn:aws:ssm:us-east-2:111122223333:parameter/</code>.</p>
374    /// </note>
375    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
376        &self.name
377    }
378    /// <p>Information about the parameter that you want to add to the system. Optional but recommended.</p><important>
379    /// <p>Don't enter personally identifiable information in this field.</p>
380    /// </important>
381    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
382        self.description = ::std::option::Option::Some(input.into());
383        self
384    }
385    /// <p>Information about the parameter that you want to add to the system. Optional but recommended.</p><important>
386    /// <p>Don't enter personally identifiable information in this field.</p>
387    /// </important>
388    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
389        self.description = input;
390        self
391    }
392    /// <p>Information about the parameter that you want to add to the system. Optional but recommended.</p><important>
393    /// <p>Don't enter personally identifiable information in this field.</p>
394    /// </important>
395    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
396        &self.description
397    }
398    /// <p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p><note>
399    /// <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p>
400    /// </note>
401    /// This field is required.
402    pub fn value(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
403        self.value = ::std::option::Option::Some(input.into());
404        self
405    }
406    /// <p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p><note>
407    /// <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p>
408    /// </note>
409    pub fn set_value(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
410        self.value = input;
411        self
412    }
413    /// <p>The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.</p><note>
414    /// <p>Parameters can't be referenced or nested in the values of other parameters. You can't include values wrapped in double brackets <code>{{}}</code> or <code>{{ssm:<i>parameter-name</i>}}</code> in a parameter value.</p>
415    /// </note>
416    pub fn get_value(&self) -> &::std::option::Option<::std::string::String> {
417        &self.value
418    }
419    /// <p>The type of parameter that you want to create.</p><note>
420    /// <p><code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
421    /// </note>
422    /// <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p><important>
423    /// <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p>
424    /// </important>
425    pub fn r#type(mut self, input: crate::types::ParameterType) -> Self {
426        self.r#type = ::std::option::Option::Some(input);
427        self
428    }
429    /// <p>The type of parameter that you want to create.</p><note>
430    /// <p><code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
431    /// </note>
432    /// <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p><important>
433    /// <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p>
434    /// </important>
435    pub fn set_type(mut self, input: ::std::option::Option<crate::types::ParameterType>) -> Self {
436        self.r#type = input;
437        self
438    }
439    /// <p>The type of parameter that you want to create.</p><note>
440    /// <p><code>SecureString</code> isn't currently supported for CloudFormation templates.</p>
441    /// </note>
442    /// <p>Items in a <code>StringList</code> must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the <code>String</code> data type.</p><important>
443    /// <p>Specifying a parameter type isn't required when updating a parameter. You must specify a parameter type when creating a parameter.</p>
444    /// </important>
445    pub fn get_type(&self) -> &::std::option::Option<crate::types::ParameterType> {
446        &self.r#type
447    }
448    /// <p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
449    /// <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key.</p>
450    /// <ul>
451    /// <li>
452    /// <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p></li>
453    /// </ul>
454    pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
455        self.key_id = ::std::option::Option::Some(input.into());
456        self
457    }
458    /// <p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
459    /// <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key.</p>
460    /// <ul>
461    /// <li>
462    /// <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p></li>
463    /// </ul>
464    pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
465        self.key_id = input;
466        self
467    }
468    /// <p>The Key Management Service (KMS) ID that you want to use to encrypt a parameter. Use a custom key for better security. Required for parameters that use the <code>SecureString</code> data type.</p>
469    /// <p>If you don't specify a key ID, the system uses the default key associated with your Amazon Web Services account, which is not as secure as using a custom key.</p>
470    /// <ul>
471    /// <li>
472    /// <p>To use a custom KMS key, choose the <code>SecureString</code> data type with the <code>Key ID</code> parameter.</p></li>
473    /// </ul>
474    pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
475        &self.key_id
476    }
477    /// <p>Overwrite an existing parameter. The default value is <code>false</code>.</p>
478    pub fn overwrite(mut self, input: bool) -> Self {
479        self.overwrite = ::std::option::Option::Some(input);
480        self
481    }
482    /// <p>Overwrite an existing parameter. The default value is <code>false</code>.</p>
483    pub fn set_overwrite(mut self, input: ::std::option::Option<bool>) -> Self {
484        self.overwrite = input;
485        self
486    }
487    /// <p>Overwrite an existing parameter. The default value is <code>false</code>.</p>
488    pub fn get_overwrite(&self) -> &::std::option::Option<bool> {
489        &self.overwrite
490    }
491    /// <p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$</p>
492    pub fn allowed_pattern(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
493        self.allowed_pattern = ::std::option::Option::Some(input.into());
494        self
495    }
496    /// <p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$</p>
497    pub fn set_allowed_pattern(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
498        self.allowed_pattern = input;
499        self
500    }
501    /// <p>A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$</p>
502    pub fn get_allowed_pattern(&self) -> &::std::option::Option<::std::string::String> {
503        &self.allowed_pattern
504    }
505    /// Appends an item to `tags`.
506    ///
507    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
508    ///
509    /// <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p>
510    /// <ul>
511    /// <li>
512    /// <p><code>Key=Resource,Value=S3bucket</code></p></li>
513    /// <li>
514    /// <p><code>Key=OS,Value=Windows</code></p></li>
515    /// <li>
516    /// <p><code>Key=ParameterType,Value=LicenseKey</code></p></li>
517    /// </ul><note>
518    /// <p>To add tags to an existing Systems Manager parameter, use the <code>AddTagsToResource</code> operation.</p>
519    /// </note>
520    pub fn tags(mut self, input: crate::types::Tag) -> Self {
521        let mut v = self.tags.unwrap_or_default();
522        v.push(input);
523        self.tags = ::std::option::Option::Some(v);
524        self
525    }
526    /// <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p>
527    /// <ul>
528    /// <li>
529    /// <p><code>Key=Resource,Value=S3bucket</code></p></li>
530    /// <li>
531    /// <p><code>Key=OS,Value=Windows</code></p></li>
532    /// <li>
533    /// <p><code>Key=ParameterType,Value=LicenseKey</code></p></li>
534    /// </ul><note>
535    /// <p>To add tags to an existing Systems Manager parameter, use the <code>AddTagsToResource</code> operation.</p>
536    /// </note>
537    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
538        self.tags = input;
539        self
540    }
541    /// <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key-value pairs:</p>
542    /// <ul>
543    /// <li>
544    /// <p><code>Key=Resource,Value=S3bucket</code></p></li>
545    /// <li>
546    /// <p><code>Key=OS,Value=Windows</code></p></li>
547    /// <li>
548    /// <p><code>Key=ParameterType,Value=LicenseKey</code></p></li>
549    /// </ul><note>
550    /// <p>To add tags to an existing Systems Manager parameter, use the <code>AddTagsToResource</code> operation.</p>
551    /// </note>
552    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
553        &self.tags
554    }
555    /// <p>The parameter tier to assign to a parameter.</p>
556    /// <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.</p>
557    /// <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
558    /// <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p>
559    /// <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.</p>
560    /// <p><b>Using the Default Tier Configuration</b></p>
561    /// <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p>
562    /// <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p>
563    /// <ul>
564    /// <li>
565    /// <p><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters.</p></li>
566    /// <li>
567    /// <p><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.</p>
568    /// <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p>
569    /// <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.</p></li>
570    /// </ul>
571    /// <p>Options that require an advanced parameter include the following:</p>
572    /// <ul>
573    /// <li>
574    /// <p>The content size of the parameter is more than 4 KB.</p></li>
575    /// <li>
576    /// <p>The parameter uses a parameter policy.</p></li>
577    /// <li>
578    /// <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p></li>
579    /// </ul>
580    /// <p>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
581    pub fn tier(mut self, input: crate::types::ParameterTier) -> Self {
582        self.tier = ::std::option::Option::Some(input);
583        self
584    }
585    /// <p>The parameter tier to assign to a parameter.</p>
586    /// <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.</p>
587    /// <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
588    /// <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p>
589    /// <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.</p>
590    /// <p><b>Using the Default Tier Configuration</b></p>
591    /// <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p>
592    /// <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p>
593    /// <ul>
594    /// <li>
595    /// <p><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters.</p></li>
596    /// <li>
597    /// <p><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.</p>
598    /// <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p>
599    /// <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.</p></li>
600    /// </ul>
601    /// <p>Options that require an advanced parameter include the following:</p>
602    /// <ul>
603    /// <li>
604    /// <p>The content size of the parameter is more than 4 KB.</p></li>
605    /// <li>
606    /// <p>The parameter uses a parameter policy.</p></li>
607    /// <li>
608    /// <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p></li>
609    /// </ul>
610    /// <p>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
611    pub fn set_tier(mut self, input: ::std::option::Option<crate::types::ParameterTier>) -> Self {
612        self.tier = input;
613        self
614    }
615    /// <p>The parameter tier to assign to a parameter.</p>
616    /// <p>Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an Amazon Web Services account. Standard parameters are offered at no additional cost.</p>
617    /// <p>Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an Amazon Web Services account. Advanced parameters incur a charge. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html">Managing parameter tiers</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
618    /// <p>You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.</p>
619    /// <p>If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.</p>
620    /// <p><b>Using the Default Tier Configuration</b></p>
621    /// <p>In <code>PutParameter</code> requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you don't specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.</p>
622    /// <p>The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:</p>
623    /// <ul>
624    /// <li>
625    /// <p><b>Advanced</b>: With this option, Parameter Store evaluates all requests as advanced parameters.</p></li>
626    /// <li>
627    /// <p><b>Intelligent-Tiering</b>: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.</p>
628    /// <p>If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.</p>
629    /// <p>This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.</p></li>
630    /// </ul>
631    /// <p>Options that require an advanced parameter include the following:</p>
632    /// <ul>
633    /// <li>
634    /// <p>The content size of the parameter is more than 4 KB.</p></li>
635    /// <li>
636    /// <p>The parameter uses a parameter policy.</p></li>
637    /// <li>
638    /// <p>More than 10,000 parameters already exist in your Amazon Web Services account in the current Amazon Web Services Region.</p></li>
639    /// </ul>
640    /// <p>For more information about configuring the default tier option, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-advanced-parameters.html#ps-default-tier">Specifying a default parameter tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
641    pub fn get_tier(&self) -> &::std::option::Option<crate::types::ParameterTier> {
642        &self.tier
643    }
644    /// <p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p>
645    /// <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p>
646    /// <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p>
647    /// <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p>
648    /// <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>.</p>
649    pub fn policies(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
650        self.policies = ::std::option::Option::Some(input.into());
651        self
652    }
653    /// <p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p>
654    /// <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p>
655    /// <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p>
656    /// <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p>
657    /// <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>.</p>
658    pub fn set_policies(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
659        self.policies = input;
660        self
661    }
662    /// <p>One or more policies to apply to a parameter. This operation takes a JSON array. Parameter Store, a tool in Amazon Web Services Systems Manager supports the following policy types:</p>
663    /// <p>Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the <i>parameter</i> doesn't affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.</p>
664    /// <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.</p>
665    /// <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it hasn't been changed.</p>
666    /// <p>All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html">Assigning parameter policies</a>.</p>
667    pub fn get_policies(&self) -> &::std::option::Option<::std::string::String> {
668        &self.policies
669    }
670    /// <p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p>
671    /// <p><b>The following data type values are supported.</b></p>
672    /// <ul>
673    /// <li>
674    /// <p><code>text</code></p></li>
675    /// <li>
676    /// <p><code>aws:ec2:image</code></p></li>
677    /// <li>
678    /// <p><code>aws:ssm:integration</code></p></li>
679    /// </ul>
680    /// <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account.</p><note>
681    /// <p>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <code>PutParameter</code> call for all cases except for data type <code>aws:ec2:image</code>. If you call <code>PutParameter</code> with <code>aws:ec2:image</code> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <code>aws:ec2:image</code> value is validated asynchronously, and the <code>PutParameter</code> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <code>aws:ec2:image</code> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>.</p>
682    /// </note>
683    pub fn data_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
684        self.data_type = ::std::option::Option::Some(input.into());
685        self
686    }
687    /// <p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p>
688    /// <p><b>The following data type values are supported.</b></p>
689    /// <ul>
690    /// <li>
691    /// <p><code>text</code></p></li>
692    /// <li>
693    /// <p><code>aws:ec2:image</code></p></li>
694    /// <li>
695    /// <p><code>aws:ssm:integration</code></p></li>
696    /// </ul>
697    /// <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account.</p><note>
698    /// <p>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <code>PutParameter</code> call for all cases except for data type <code>aws:ec2:image</code>. If you call <code>PutParameter</code> with <code>aws:ec2:image</code> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <code>aws:ec2:image</code> value is validated asynchronously, and the <code>PutParameter</code> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <code>aws:ec2:image</code> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>.</p>
699    /// </note>
700    pub fn set_data_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
701        self.data_type = input;
702        self
703    }
704    /// <p>The data type for a <code>String</code> parameter. Supported data types include plain text and Amazon Machine Image (AMI) IDs.</p>
705    /// <p><b>The following data type values are supported.</b></p>
706    /// <ul>
707    /// <li>
708    /// <p><code>text</code></p></li>
709    /// <li>
710    /// <p><code>aws:ec2:image</code></p></li>
711    /// <li>
712    /// <p><code>aws:ssm:integration</code></p></li>
713    /// </ul>
714    /// <p>When you create a <code>String</code> parameter and specify <code>aws:ec2:image</code>, Amazon Web Services Systems Manager validates the parameter value is in the required format, such as <code>ami-12345abcdeEXAMPLE</code>, and that the specified AMI is available in your Amazon Web Services account.</p><note>
715    /// <p>If the action is successful, the service sends back an HTTP 200 response which indicates a successful <code>PutParameter</code> call for all cases except for data type <code>aws:ec2:image</code>. If you call <code>PutParameter</code> with <code>aws:ec2:image</code> data type, a successful HTTP 200 response does not guarantee that your parameter was successfully created or updated. The <code>aws:ec2:image</code> value is validated asynchronously, and the <code>PutParameter</code> call returns before the validation is complete. If you submit an invalid AMI value, the PutParameter operation will return success, but the asynchronous validation will fail and the parameter will not be created or updated. To monitor whether your <code>aws:ec2:image</code> parameters are created successfully, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-cwe.html">Setting up notifications or trigger actions based on Parameter Store events</a>. For more information about AMI format validation , see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html">Native parameter support for Amazon Machine Image IDs</a>.</p>
716    /// </note>
717    pub fn get_data_type(&self) -> &::std::option::Option<::std::string::String> {
718        &self.data_type
719    }
720    /// Consumes the builder and constructs a [`PutParameterInput`](crate::operation::put_parameter::PutParameterInput).
721    pub fn build(
722        self,
723    ) -> ::std::result::Result<crate::operation::put_parameter::PutParameterInput, ::aws_smithy_types::error::operation::BuildError> {
724        ::std::result::Result::Ok(crate::operation::put_parameter::PutParameterInput {
725            name: self.name,
726            description: self.description,
727            value: self.value,
728            r#type: self.r#type,
729            key_id: self.key_id,
730            overwrite: self.overwrite,
731            allowed_pattern: self.allowed_pattern,
732            tags: self.tags,
733            tier: self.tier,
734            policies: self.policies,
735            data_type: self.data_type,
736        })
737    }
738}
739impl ::std::fmt::Debug for PutParameterInputBuilder {
740    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
741        let mut formatter = f.debug_struct("PutParameterInputBuilder");
742        formatter.field("name", &self.name);
743        formatter.field("description", &self.description);
744        formatter.field("value", &"*** Sensitive Data Redacted ***");
745        formatter.field("r#type", &self.r#type);
746        formatter.field("key_id", &self.key_id);
747        formatter.field("overwrite", &self.overwrite);
748        formatter.field("allowed_pattern", &self.allowed_pattern);
749        formatter.field("tags", &self.tags);
750        formatter.field("tier", &self.tier);
751        formatter.field("policies", &self.policies);
752        formatter.field("data_type", &self.data_type);
753        formatter.finish()
754    }
755}