aws-sdk-kms 1.129.0

AWS SDK for AWS Key Management Service
Documentation 
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

// 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 DecapsulateOutput {
    /// <p>The identifier of the ML-KEM KMS key used to decapsulate the shared secret.</p>
    pub key_id: ::std::option::Option<::std::string::String>,
    /// <p>The plaintext shared secret recovered from the encapsulated form. It is a 32-byte value that matches the shared secret held by the encapsulating party. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
    pub shared_secret: ::std::option::Option<::aws_smithy_types::Blob>,
    /// <p>The key encapsulation algorithm used to recover the shared secret.</p>
    pub encapsulation_algorithm: ::std::option::Option<crate::types::EncapsulationAlgorithmSpec>,
    _request_id: Option<String>,
}
impl DecapsulateOutput {
    /// <p>The identifier of the ML-KEM KMS key used to decapsulate the shared secret.</p>
    pub fn key_id(&self) -> ::std::option::Option<&str> {
        self.key_id.as_deref()
    }
    /// <p>The plaintext shared secret recovered from the encapsulated form. It is a 32-byte value that matches the shared secret held by the encapsulating party. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
    pub fn shared_secret(&self) -> ::std::option::Option<&::aws_smithy_types::Blob> {
        self.shared_secret.as_ref()
    }
    /// <p>The key encapsulation algorithm used to recover the shared secret.</p>
    pub fn encapsulation_algorithm(&self) -> ::std::option::Option<&crate::types::EncapsulationAlgorithmSpec> {
        self.encapsulation_algorithm.as_ref()
    }
}
impl ::std::fmt::Debug for DecapsulateOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("DecapsulateOutput");
        formatter.field("key_id", &self.key_id);
        formatter.field("shared_secret", &"*** Sensitive Data Redacted ***");
        formatter.field("encapsulation_algorithm", &self.encapsulation_algorithm);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for DecapsulateOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DecapsulateOutput {
    /// Creates a new builder-style object to manufacture [`DecapsulateOutput`](crate::operation::decapsulate::DecapsulateOutput).
    pub fn builder() -> crate::operation::decapsulate::builders::DecapsulateOutputBuilder {
        crate::operation::decapsulate::builders::DecapsulateOutputBuilder::default()
    }
}

/// A builder for [`DecapsulateOutput`](crate::operation::decapsulate::DecapsulateOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct DecapsulateOutputBuilder {
    pub(crate) key_id: ::std::option::Option<::std::string::String>,
    pub(crate) shared_secret: ::std::option::Option<::aws_smithy_types::Blob>,
    pub(crate) encapsulation_algorithm: ::std::option::Option<crate::types::EncapsulationAlgorithmSpec>,
    _request_id: Option<String>,
}
impl DecapsulateOutputBuilder {
    /// <p>The identifier of the ML-KEM KMS key used to decapsulate the shared secret.</p>
    pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the ML-KEM KMS key used to decapsulate the shared secret.</p>
    pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key_id = input;
        self
    }
    /// <p>The identifier of the ML-KEM KMS key used to decapsulate the shared secret.</p>
    pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.key_id
    }
    /// <p>The plaintext shared secret recovered from the encapsulated form. It is a 32-byte value that matches the shared secret held by the encapsulating party. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
    pub fn shared_secret(mut self, input: ::aws_smithy_types::Blob) -> Self {
        self.shared_secret = ::std::option::Option::Some(input);
        self
    }
    /// <p>The plaintext shared secret recovered from the encapsulated form. It is a 32-byte value that matches the shared secret held by the encapsulating party. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
    pub fn set_shared_secret(mut self, input: ::std::option::Option<::aws_smithy_types::Blob>) -> Self {
        self.shared_secret = input;
        self
    }
    /// <p>The plaintext shared secret recovered from the encapsulated form. It is a 32-byte value that matches the shared secret held by the encapsulating party. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.</p>
    pub fn get_shared_secret(&self) -> &::std::option::Option<::aws_smithy_types::Blob> {
        &self.shared_secret
    }
    /// <p>The key encapsulation algorithm used to recover the shared secret.</p>
    pub fn encapsulation_algorithm(mut self, input: crate::types::EncapsulationAlgorithmSpec) -> Self {
        self.encapsulation_algorithm = ::std::option::Option::Some(input);
        self
    }
    /// <p>The key encapsulation algorithm used to recover the shared secret.</p>
    pub fn set_encapsulation_algorithm(mut self, input: ::std::option::Option<crate::types::EncapsulationAlgorithmSpec>) -> Self {
        self.encapsulation_algorithm = input;
        self
    }
    /// <p>The key encapsulation algorithm used to recover the shared secret.</p>
    pub fn get_encapsulation_algorithm(&self) -> &::std::option::Option<crate::types::EncapsulationAlgorithmSpec> {
        &self.encapsulation_algorithm
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`DecapsulateOutput`](crate::operation::decapsulate::DecapsulateOutput).
    pub fn build(self) -> crate::operation::decapsulate::DecapsulateOutput {
        crate::operation::decapsulate::DecapsulateOutput {
            key_id: self.key_id,
            shared_secret: self.shared_secret,
            encapsulation_algorithm: self.encapsulation_algorithm,
            _request_id: self._request_id,
        }
    }
}
impl ::std::fmt::Debug for DecapsulateOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("DecapsulateOutputBuilder");
        formatter.field("key_id", &self.key_id);
        formatter.field("shared_secret", &"*** Sensitive Data Redacted ***");
        formatter.field("encapsulation_algorithm", &self.encapsulation_algorithm);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}