aws_sdk_kms/operation/get_key_rotation_status/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_key_rotation_status::_get_key_rotation_status_output::GetKeyRotationStatusOutputBuilder;
3
4pub use crate::operation::get_key_rotation_status::_get_key_rotation_status_input::GetKeyRotationStatusInputBuilder;
5
6impl crate::operation::get_key_rotation_status::builders::GetKeyRotationStatusInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::get_key_rotation_status::GetKeyRotationStatusOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::get_key_rotation_status::GetKeyRotationStatusError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.get_key_rotation_status();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `GetKeyRotationStatus`.
24///
25/// <p>Provides detailed information about the rotation status for a KMS key, including whether <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html">automatic rotation of the key material</a> is enabled for the specified KMS key, the <a href="https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotation-period">rotation period</a>, and the next scheduled rotation date.</p>
26/// <p>Automatic key rotation is supported only on <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#symmetric-cmks">symmetric encryption KMS keys</a>. You cannot enable automatic rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">asymmetric KMS keys</a>, <a href="https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html">HMAC KMS keys</a>, KMS keys with <a href="https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html">imported key material</a>, or KMS keys in a <a href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom key store</a>. To enable or disable automatic rotation of a set of related <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate">multi-Region keys</a>, set the property on the primary key..</p>
27/// <p>You can enable (<code>EnableKeyRotation</code>) and disable automatic rotation (<code>DisableKeyRotation</code>) of the key material in customer managed KMS keys. Key material rotation of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk">Amazon Web Services managed KMS keys</a> is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always <code>true</code>.</p>
28/// <p>You can perform on-demand (<code>RotateKeyOnDemand</code>) rotation of the key material in customer managed KMS keys, regardless of whether or not automatic key rotation is enabled. You can use GetKeyRotationStatus to identify the date and time that an in progress on-demand rotation was initiated. You can use <code>ListKeyRotations</code> to view the details of completed rotations.</p><note>
29/// <p>In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see <code>EnableKeyRotation</code>.</p>
30/// </note>
31/// <p>The KMS key that you use for this operation must be in a compatible key state. For details, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html">Key states of KMS keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
32/// <ul>
33/// <li>
34/// <p>Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.</p></li>
35/// <li>
36/// <p>Pending deletion: While a KMS key is pending deletion, its key rotation status is <code>false</code> and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status returns to <code>true</code>.</p></li>
37/// </ul>
38/// <p><b>Cross-account use</b>: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the <code>KeyId</code> parameter.</p>
39/// <p><b>Required permissions</b>: <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html">kms:GetKeyRotationStatus</a> (key policy)</p>
40/// <p><b>Related operations:</b></p>
41/// <ul>
42/// <li>
43/// <p><code>DisableKeyRotation</code></p></li>
44/// <li>
45/// <p><code>EnableKeyRotation</code></p></li>
46/// <li>
47/// <p><code>ListKeyRotations</code></p></li>
48/// <li>
49/// <p><code>RotateKeyOnDemand</code></p></li>
50/// </ul>
51/// <p><b>Eventual consistency</b>: The KMS API follows an eventual consistency model. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/programming-eventual-consistency.html">KMS eventual consistency</a>.</p>
52#[derive(::std::clone::Clone, ::std::fmt::Debug)]
53pub struct GetKeyRotationStatusFluentBuilder {
54 handle: ::std::sync::Arc<crate::client::Handle>,
55 inner: crate::operation::get_key_rotation_status::builders::GetKeyRotationStatusInputBuilder,
56 config_override: ::std::option::Option<crate::config::Builder>,
57}
58impl
59 crate::client::customize::internal::CustomizableSend<
60 crate::operation::get_key_rotation_status::GetKeyRotationStatusOutput,
61 crate::operation::get_key_rotation_status::GetKeyRotationStatusError,
62 > for GetKeyRotationStatusFluentBuilder
63{
64 fn send(
65 self,
66 config_override: crate::config::Builder,
67 ) -> crate::client::customize::internal::BoxFuture<
68 crate::client::customize::internal::SendResult<
69 crate::operation::get_key_rotation_status::GetKeyRotationStatusOutput,
70 crate::operation::get_key_rotation_status::GetKeyRotationStatusError,
71 >,
72 > {
73 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
74 }
75}
76impl GetKeyRotationStatusFluentBuilder {
77 /// Creates a new `GetKeyRotationStatusFluentBuilder`.
78 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
79 Self {
80 handle,
81 inner: ::std::default::Default::default(),
82 config_override: ::std::option::Option::None,
83 }
84 }
85 /// Access the GetKeyRotationStatus as a reference.
86 pub fn as_input(&self) -> &crate::operation::get_key_rotation_status::builders::GetKeyRotationStatusInputBuilder {
87 &self.inner
88 }
89 /// Sends the request and returns the response.
90 ///
91 /// If an error occurs, an `SdkError` will be returned with additional details that
92 /// can be matched against.
93 ///
94 /// By default, any retryable failures will be retried twice. Retry behavior
95 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
96 /// set when configuring the client.
97 pub async fn send(
98 self,
99 ) -> ::std::result::Result<
100 crate::operation::get_key_rotation_status::GetKeyRotationStatusOutput,
101 ::aws_smithy_runtime_api::client::result::SdkError<
102 crate::operation::get_key_rotation_status::GetKeyRotationStatusError,
103 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
104 >,
105 > {
106 let input = self
107 .inner
108 .build()
109 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
110 let runtime_plugins = crate::operation::get_key_rotation_status::GetKeyRotationStatus::operation_runtime_plugins(
111 self.handle.runtime_plugins.clone(),
112 &self.handle.conf,
113 self.config_override,
114 );
115 crate::operation::get_key_rotation_status::GetKeyRotationStatus::orchestrate(&runtime_plugins, input).await
116 }
117
118 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
119 pub fn customize(
120 self,
121 ) -> crate::client::customize::CustomizableOperation<
122 crate::operation::get_key_rotation_status::GetKeyRotationStatusOutput,
123 crate::operation::get_key_rotation_status::GetKeyRotationStatusError,
124 Self,
125 > {
126 crate::client::customize::CustomizableOperation::new(self)
127 }
128 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
129 self.set_config_override(::std::option::Option::Some(config_override.into()));
130 self
131 }
132
133 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
134 self.config_override = config_override;
135 self
136 }
137 /// <p>Gets the rotation status for the specified KMS key.</p>
138 /// <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.</p>
139 /// <p>For example:</p>
140 /// <ul>
141 /// <li>
142 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
143 /// <li>
144 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
145 /// </ul>
146 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
147 pub fn key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148 self.inner = self.inner.key_id(input.into());
149 self
150 }
151 /// <p>Gets the rotation status for the specified KMS key.</p>
152 /// <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.</p>
153 /// <p>For example:</p>
154 /// <ul>
155 /// <li>
156 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
157 /// <li>
158 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
159 /// </ul>
160 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
161 pub fn set_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
162 self.inner = self.inner.set_key_id(input);
163 self
164 }
165 /// <p>Gets the rotation status for the specified KMS key.</p>
166 /// <p>Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.</p>
167 /// <p>For example:</p>
168 /// <ul>
169 /// <li>
170 /// <p>Key ID: <code>1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
171 /// <li>
172 /// <p>Key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code></p></li>
173 /// </ul>
174 /// <p>To get the key ID and key ARN for a KMS key, use <code>ListKeys</code> or <code>DescribeKey</code>.</p>
175 pub fn get_key_id(&self) -> &::std::option::Option<::std::string::String> {
176 self.inner.get_key_id()
177 }
178}