Struct aws_sdk_secretsmanager::operation::put_secret_value::builders::PutSecretValueInputBuilder
source · #[non_exhaustive]pub struct PutSecretValueInputBuilder { /* private fields */ }
Expand description
A builder for PutSecretValueInput
.
Implementations§
source§impl PutSecretValueInputBuilder
impl PutSecretValueInputBuilder
sourcepub fn secret_id(self, input: impl Into<String>) -> Self
pub fn secret_id(self, input: impl Into<String>) -> Self
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
sourcepub fn set_secret_id(self, input: Option<String>) -> Self
pub fn set_secret_id(self, input: Option<String>) -> Self
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
sourcepub fn get_secret_id(&self) -> &Option<String>
pub fn get_secret_id(&self) -> &Option<String>
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
A unique identifier for the new version of the secret.
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.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
and include it in the request.
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 UUID-type value to ensure uniqueness of your versions within the specified secret.
-
If the
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. -
If a version with this value already exists and that version's
SecretString
orSecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent. -
If a version with this value already exists and the version of the
SecretString
andSecretBinary
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.
This value becomes the VersionId
of the new version.
sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
A unique identifier for the new version of the secret.
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.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
and include it in the request.
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 UUID-type value to ensure uniqueness of your versions within the specified secret.
-
If the
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. -
If a version with this value already exists and that version's
SecretString
orSecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent. -
If a version with this value already exists and the version of the
SecretString
andSecretBinary
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.
This value becomes the VersionId
of the new version.
sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
A unique identifier for the new version of the secret.
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.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
and include it in the request.
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 UUID-type value to ensure uniqueness of your versions within the specified secret.
-
If the
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. -
If a version with this value already exists and that version's
SecretString
orSecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent. -
If a version with this value already exists and the version of the
SecretString
andSecretBinary
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.
This value becomes the VersionId
of the new version.
sourcepub fn secret_binary(self, input: Blob) -> Self
pub fn secret_binary(self, input: Blob) -> Self
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.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
sourcepub fn set_secret_binary(self, input: Option<Blob>) -> Self
pub fn set_secret_binary(self, input: Option<Blob>) -> Self
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.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
sourcepub fn get_secret_binary(&self) -> &Option<Blob>
pub fn get_secret_binary(&self) -> &Option<Blob>
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.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
sourcepub fn secret_string(self, input: impl Into<String>) -> Self
pub fn secret_string(self, input: impl Into<String>) -> Self
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
sourcepub fn set_secret_string(self, input: Option<String>) -> Self
pub fn set_secret_string(self, input: Option<String>) -> Self
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
sourcepub fn get_secret_string(&self) -> &Option<String>
pub fn get_secret_string(&self) -> &Option<String>
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
sourcepub fn version_stages(self, input: impl Into<String>) -> Self
pub fn version_stages(self, input: impl Into<String>) -> Self
Appends an item to version_stages
.
To override the contents of this collection use set_version_stages
.
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.
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 AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
sourcepub fn set_version_stages(self, input: Option<Vec<String>>) -> Self
pub fn set_version_stages(self, input: Option<Vec<String>>) -> Self
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.
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 AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
sourcepub fn get_version_stages(&self) -> &Option<Vec<String>>
pub fn get_version_stages(&self) -> &Option<Vec<String>>
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.
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 AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
sourcepub fn build(self) -> Result<PutSecretValueInput, BuildError>
pub fn build(self) -> Result<PutSecretValueInput, BuildError>
Consumes the builder and constructs a PutSecretValueInput
.
source§impl PutSecretValueInputBuilder
impl PutSecretValueInputBuilder
sourcepub async fn send_with(
self,
client: &Client,
) -> Result<PutSecretValueOutput, SdkError<PutSecretValueError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<PutSecretValueOutput, SdkError<PutSecretValueError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for PutSecretValueInputBuilder
impl Clone for PutSecretValueInputBuilder
source§fn clone(&self) -> PutSecretValueInputBuilder
fn clone(&self) -> PutSecretValueInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PutSecretValueInputBuilder
impl Debug for PutSecretValueInputBuilder
source§impl Default for PutSecretValueInputBuilder
impl Default for PutSecretValueInputBuilder
source§fn default() -> PutSecretValueInputBuilder
fn default() -> PutSecretValueInputBuilder
impl StructuralPartialEq for PutSecretValueInputBuilder
Auto Trait Implementations§
impl Freeze for PutSecretValueInputBuilder
impl RefUnwindSafe for PutSecretValueInputBuilder
impl Send for PutSecretValueInputBuilder
impl Sync for PutSecretValueInputBuilder
impl Unpin for PutSecretValueInputBuilder
impl UnwindSafe for PutSecretValueInputBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)