1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct PutSecretValueInput {
/// <p>The ARN or name of the secret to add a new version to.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
pub secret_id: ::std::option::Option<::std::string::String>,
/// <p>A unique identifier for the new version of the secret.</p><note>
/// <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.</p>
/// </note>
/// <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
/// <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret.</p>
/// <ul>
/// <li>
/// <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created.</p></li>
/// <li>
/// <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored. The operation is idempotent.</p></li>
/// <li>
/// <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.</p></li>
/// </ul>
/// <p>This value becomes the <code>VersionId</code> of the new version.</p>
pub client_request_token: ::std::option::Option<::std::string::String>,
/// <p>The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>You can't access this value from the Secrets Manager console.</p>
pub secret_binary: ::std::option::Option<::aws_smithy_types::Blob>,
/// <p>The text to encrypt and store in the new version of the secret.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
pub secret_string: ::std::option::Option<::std::string::String>,
/// <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
/// <p>If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version.</p>
pub version_stages: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl PutSecretValueInput {
/// <p>The ARN or name of the secret to add a new version to.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
pub fn secret_id(&self) -> ::std::option::Option<&str> {
self.secret_id.as_deref()
}
/// <p>A unique identifier for the new version of the secret.</p><note>
/// <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.</p>
/// </note>
/// <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
/// <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret.</p>
/// <ul>
/// <li>
/// <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created.</p></li>
/// <li>
/// <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored. The operation is idempotent.</p></li>
/// <li>
/// <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.</p></li>
/// </ul>
/// <p>This value becomes the <code>VersionId</code> of the new version.</p>
pub fn client_request_token(&self) -> ::std::option::Option<&str> {
self.client_request_token.as_deref()
}
/// <p>The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>You can't access this value from the Secrets Manager console.</p>
pub fn secret_binary(&self) -> ::std::option::Option<&::aws_smithy_types::Blob> {
self.secret_binary.as_ref()
}
/// <p>The text to encrypt and store in the new version of the secret.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
pub fn secret_string(&self) -> ::std::option::Option<&str> {
self.secret_string.as_deref()
}
/// <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
/// <p>If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.version_stages.is_none()`.
pub fn version_stages(&self) -> &[::std::string::String] {
self.version_stages.as_deref().unwrap_or_default()
}
}
impl ::std::fmt::Debug for PutSecretValueInput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("PutSecretValueInput");
formatter.field("secret_id", &self.secret_id);
formatter.field("client_request_token", &self.client_request_token);
formatter.field("secret_binary", &"*** Sensitive Data Redacted ***");
formatter.field("secret_string", &"*** Sensitive Data Redacted ***");
formatter.field("version_stages", &self.version_stages);
formatter.finish()
}
}
impl PutSecretValueInput {
/// Creates a new builder-style object to manufacture [`PutSecretValueInput`](crate::operation::put_secret_value::PutSecretValueInput).
pub fn builder() -> crate::operation::put_secret_value::builders::PutSecretValueInputBuilder {
crate::operation::put_secret_value::builders::PutSecretValueInputBuilder::default()
}
}
/// A builder for [`PutSecretValueInput`](crate::operation::put_secret_value::PutSecretValueInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
pub struct PutSecretValueInputBuilder {
pub(crate) secret_id: ::std::option::Option<::std::string::String>,
pub(crate) client_request_token: ::std::option::Option<::std::string::String>,
pub(crate) secret_binary: ::std::option::Option<::aws_smithy_types::Blob>,
pub(crate) secret_string: ::std::option::Option<::std::string::String>,
pub(crate) version_stages: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
}
impl PutSecretValueInputBuilder {
/// <p>The ARN or name of the secret to add a new version to.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
/// This field is required.
pub fn secret_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.secret_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN or name of the secret to add a new version to.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
pub fn set_secret_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.secret_id = input;
self
}
/// <p>The ARN or name of the secret to add a new version to.</p>
/// <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
/// <p>If the secret doesn't already exist, use <code>CreateSecret</code> instead.</p>
pub fn get_secret_id(&self) -> &::std::option::Option<::std::string::String> {
&self.secret_id
}
/// <p>A unique identifier for the new version of the secret.</p><note>
/// <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.</p>
/// </note>
/// <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
/// <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret.</p>
/// <ul>
/// <li>
/// <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created.</p></li>
/// <li>
/// <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored. The operation is idempotent.</p></li>
/// <li>
/// <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.</p></li>
/// </ul>
/// <p>This value becomes the <code>VersionId</code> of the new version.</p>
pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_request_token = ::std::option::Option::Some(input.into());
self
}
/// <p>A unique identifier for the new version of the secret.</p><note>
/// <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.</p>
/// </note>
/// <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
/// <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret.</p>
/// <ul>
/// <li>
/// <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created.</p></li>
/// <li>
/// <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored. The operation is idempotent.</p></li>
/// <li>
/// <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.</p></li>
/// </ul>
/// <p>This value becomes the <code>VersionId</code> of the new version.</p>
pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_request_token = input;
self
}
/// <p>A unique identifier for the new version of the secret.</p><note>
/// <p>If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.</p>
/// </note>
/// <p>If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> and include it in the request.</p>
/// <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value to ensure uniqueness of your versions within the specified secret.</p>
/// <ul>
/// <li>
/// <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created.</p></li>
/// <li>
/// <p>If a version with this value already exists and that version's <code>SecretString</code> or <code>SecretBinary</code> values are the same as those in the request then the request is ignored. The operation is idempotent.</p></li>
/// <li>
/// <p>If a version with this value already exists and the version of the <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.</p></li>
/// </ul>
/// <p>This value becomes the <code>VersionId</code> of the new version.</p>
pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_request_token
}
/// <p>The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>You can't access this value from the Secrets Manager console.</p>
pub fn secret_binary(mut self, input: ::aws_smithy_types::Blob) -> Self {
self.secret_binary = ::std::option::Option::Some(input);
self
}
/// <p>The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>You can't access this value from the Secrets Manager console.</p>
pub fn set_secret_binary(mut self, input: ::std::option::Option<::aws_smithy_types::Blob>) -> Self {
self.secret_binary = input;
self
}
/// <p>The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>You can't access this value from the Secrets Manager console.</p>
pub fn get_secret_binary(&self) -> &::std::option::Option<::aws_smithy_types::Blob> {
&self.secret_binary
}
/// <p>The text to encrypt and store in the new version of the secret.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
pub fn secret_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.secret_string = ::std::option::Option::Some(input.into());
self
}
/// <p>The text to encrypt and store in the new version of the secret.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
pub fn set_secret_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.secret_string = input;
self
}
/// <p>The text to encrypt and store in the new version of the secret.</p>
/// <p>You must include <code>SecretBinary</code> or <code>SecretString</code>, but not both.</p>
/// <p>We recommend you create the secret string as JSON key/value pairs, as shown in the example.</p>
pub fn get_secret_string(&self) -> &::std::option::Option<::std::string::String> {
&self.secret_string
}
/// Appends an item to `version_stages`.
///
/// To override the contents of this collection use [`set_version_stages`](Self::set_version_stages).
///
/// <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
/// <p>If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version.</p>
pub fn version_stages(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.version_stages.unwrap_or_default();
v.push(input.into());
self.version_stages = ::std::option::Option::Some(v);
self
}
/// <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
/// <p>If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version.</p>
pub fn set_version_stages(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.version_stages = input;
self
}
/// <p>A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.</p>
/// <p>If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify <code>AWSCURRENT</code>, and it is already attached to another version, then Secrets Manager also moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p>
/// <p>If you don't include <code>VersionStages</code>, then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this version.</p>
pub fn get_version_stages(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.version_stages
}
/// Consumes the builder and constructs a [`PutSecretValueInput`](crate::operation::put_secret_value::PutSecretValueInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::put_secret_value::PutSecretValueInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::put_secret_value::PutSecretValueInput {
secret_id: self.secret_id,
client_request_token: self.client_request_token,
secret_binary: self.secret_binary,
secret_string: self.secret_string,
version_stages: self.version_stages,
})
}
}
impl ::std::fmt::Debug for PutSecretValueInputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("PutSecretValueInputBuilder");
formatter.field("secret_id", &self.secret_id);
formatter.field("client_request_token", &self.client_request_token);
formatter.field("secret_binary", &"*** Sensitive Data Redacted ***");
formatter.field("secret_string", &"*** Sensitive Data Redacted ***");
formatter.field("version_stages", &self.version_stages);
formatter.finish()
}
}