pub struct GetSecretValue { /* private fields */ }
Expand description
Fluent builder constructing a request to GetSecretValue
.
Retrieves the contents of the encrypted fields SecretString
or SecretBinary
from the specified version of a secret, whichever contains content.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
Required permissions: secretsmanager:GetSecretValue
. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
Implementations
sourceimpl GetSecretValue
impl GetSecretValue
sourcepub async fn send(
self
) -> Result<GetSecretValueOutput, SdkError<GetSecretValueError>>
pub async fn send(
self
) -> Result<GetSecretValueOutput, SdkError<GetSecretValueError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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 retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
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 retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
sourcepub fn version_id(self, input: impl Into<String>) -> Self
pub fn version_id(self, input: impl Into<String>) -> Self
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
sourcepub fn set_version_id(self, input: Option<String>) -> Self
pub fn set_version_id(self, input: Option<String>) -> Self
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
sourcepub fn version_stage(self, input: impl Into<String>) -> Self
pub fn version_stage(self, input: impl Into<String>) -> Self
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
sourcepub fn set_version_stage(self, input: Option<String>) -> Self
pub fn set_version_stage(self, input: Option<String>) -> Self
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Trait Implementations
sourceimpl Clone for GetSecretValue
impl Clone for GetSecretValue
sourcefn clone(&self) -> GetSecretValue
fn clone(&self) -> GetSecretValue
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetSecretValue
impl Send for GetSecretValue
impl Sync for GetSecretValue
impl Unpin for GetSecretValue
impl !UnwindSafe for GetSecretValue
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more