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
// 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, ::std::fmt::Debug)]
pub struct GetSecretValueInput {
/// <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</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>
pub secret_id: ::std::option::Option<::std::string::String>,
/// <p>The unique identifier of the version of the secret to retrieve. If you include both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
/// <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with 32 hexadecimal digits.</p>
pub version_id: ::std::option::Option<::std::string::String>,
/// <p>The staging label of the version of the secret to retrieve.</p>
/// <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
pub version_stage: ::std::option::Option<::std::string::String>,
}
impl GetSecretValueInput {
/// <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</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>
pub fn secret_id(&self) -> ::std::option::Option<&str> {
self.secret_id.as_deref()
}
/// <p>The unique identifier of the version of the secret to retrieve. If you include both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
/// <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with 32 hexadecimal digits.</p>
pub fn version_id(&self) -> ::std::option::Option<&str> {
self.version_id.as_deref()
}
/// <p>The staging label of the version of the secret to retrieve.</p>
/// <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
pub fn version_stage(&self) -> ::std::option::Option<&str> {
self.version_stage.as_deref()
}
}
impl GetSecretValueInput {
/// Creates a new builder-style object to manufacture [`GetSecretValueInput`](crate::operation::get_secret_value::GetSecretValueInput).
pub fn builder() -> crate::operation::get_secret_value::builders::GetSecretValueInputBuilder {
crate::operation::get_secret_value::builders::GetSecretValueInputBuilder::default()
}
}
/// A builder for [`GetSecretValueInput`](crate::operation::get_secret_value::GetSecretValueInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetSecretValueInputBuilder {
pub(crate) secret_id: ::std::option::Option<::std::string::String>,
pub(crate) version_id: ::std::option::Option<::std::string::String>,
pub(crate) version_stage: ::std::option::Option<::std::string::String>,
}
impl GetSecretValueInputBuilder {
/// <p>The ARN or name of the secret to retrieve. To retrieve a secret from another account, you must use an ARN.</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>
/// 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 retrieve. To retrieve a secret from another account, you must use an ARN.</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>
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 retrieve. To retrieve a secret from another account, you must use an ARN.</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>
pub fn get_secret_id(&self) -> &::std::option::Option<::std::string::String> {
&self.secret_id
}
/// <p>The unique identifier of the version of the secret to retrieve. If you include both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
/// <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with 32 hexadecimal digits.</p>
pub fn version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier of the version of the secret to retrieve. If you include both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
/// <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with 32 hexadecimal digits.</p>
pub fn set_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_id = input;
self
}
/// <p>The unique identifier of the version of the secret to retrieve. If you include both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
/// <p>This value is typically a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID-type</a> value with 32 hexadecimal digits.</p>
pub fn get_version_id(&self) -> &::std::option::Option<::std::string::String> {
&self.version_id
}
/// <p>The staging label of the version of the secret to retrieve.</p>
/// <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
pub fn version_stage(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_stage = ::std::option::Option::Some(input.into());
self
}
/// <p>The staging label of the version of the secret to retrieve.</p>
/// <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
pub fn set_version_stage(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_stage = input;
self
}
/// <p>The staging label of the version of the secret to retrieve.</p>
/// <p>Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, Secrets Manager returns the <code>AWSCURRENT</code> version.</p>
pub fn get_version_stage(&self) -> &::std::option::Option<::std::string::String> {
&self.version_stage
}
/// Consumes the builder and constructs a [`GetSecretValueInput`](crate::operation::get_secret_value::GetSecretValueInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_secret_value::GetSecretValueInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::get_secret_value::GetSecretValueInput {
secret_id: self.secret_id,
version_id: self.version_id,
version_stage: self.version_stage,
})
}
}