aws_sdk_ec2/operation/modify_ebs_default_kms_key_id/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::modify_ebs_default_kms_key_id::_modify_ebs_default_kms_key_id_output::ModifyEbsDefaultKmsKeyIdOutputBuilder;
3
4pub use crate::operation::modify_ebs_default_kms_key_id::_modify_ebs_default_kms_key_id_input::ModifyEbsDefaultKmsKeyIdInputBuilder;
5
6impl crate::operation::modify_ebs_default_kms_key_id::builders::ModifyEbsDefaultKmsKeyIdInputBuilder {
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::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.modify_ebs_default_kms_key_id();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ModifyEbsDefaultKmsKeyId`.
24///
25/// <p>Changes the default KMS key for EBS encryption by default for your account in this Region.</p>
26/// <p>Amazon Web Services creates a unique Amazon Web Services managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the Amazon Web Services managed KMS key. To reset the default KMS key to the Amazon Web Services managed KMS key for EBS, use <code>ResetEbsDefaultKmsKeyId</code>. Amazon EBS does not support asymmetric KMS keys.</p>
27/// <p>If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch.</p>
28/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html">Amazon EBS encryption</a> in the <i>Amazon EBS User Guide</i>.</p>
29#[derive(::std::clone::Clone, ::std::fmt::Debug)]
30pub struct ModifyEbsDefaultKmsKeyIdFluentBuilder {
31    handle: ::std::sync::Arc<crate::client::Handle>,
32    inner: crate::operation::modify_ebs_default_kms_key_id::builders::ModifyEbsDefaultKmsKeyIdInputBuilder,
33    config_override: ::std::option::Option<crate::config::Builder>,
34}
35impl
36    crate::client::customize::internal::CustomizableSend<
37        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdOutput,
38        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdError,
39    > for ModifyEbsDefaultKmsKeyIdFluentBuilder
40{
41    fn send(
42        self,
43        config_override: crate::config::Builder,
44    ) -> crate::client::customize::internal::BoxFuture<
45        crate::client::customize::internal::SendResult<
46            crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdOutput,
47            crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdError,
48        >,
49    > {
50        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
51    }
52}
53impl ModifyEbsDefaultKmsKeyIdFluentBuilder {
54    /// Creates a new `ModifyEbsDefaultKmsKeyIdFluentBuilder`.
55    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
56        Self {
57            handle,
58            inner: ::std::default::Default::default(),
59            config_override: ::std::option::Option::None,
60        }
61    }
62    /// Access the ModifyEbsDefaultKmsKeyId as a reference.
63    pub fn as_input(&self) -> &crate::operation::modify_ebs_default_kms_key_id::builders::ModifyEbsDefaultKmsKeyIdInputBuilder {
64        &self.inner
65    }
66    /// Sends the request and returns the response.
67    ///
68    /// If an error occurs, an `SdkError` will be returned with additional details that
69    /// can be matched against.
70    ///
71    /// By default, any retryable failures will be retried twice. Retry behavior
72    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
73    /// set when configuring the client.
74    pub async fn send(
75        self,
76    ) -> ::std::result::Result<
77        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdOutput,
78        ::aws_smithy_runtime_api::client::result::SdkError<
79            crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdError,
80            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
81        >,
82    > {
83        let input = self
84            .inner
85            .build()
86            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
87        let runtime_plugins = crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyId::operation_runtime_plugins(
88            self.handle.runtime_plugins.clone(),
89            &self.handle.conf,
90            self.config_override,
91        );
92        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyId::orchestrate(&runtime_plugins, input).await
93    }
94
95    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
96    pub fn customize(
97        self,
98    ) -> crate::client::customize::CustomizableOperation<
99        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdOutput,
100        crate::operation::modify_ebs_default_kms_key_id::ModifyEbsDefaultKmsKeyIdError,
101        Self,
102    > {
103        crate::client::customize::CustomizableOperation::new(self)
104    }
105    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
106        self.set_config_override(::std::option::Option::Some(config_override.into()));
107        self
108    }
109
110    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
111        self.config_override = config_override;
112        self
113    }
114    /// <p>The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If <code>KmsKeyId</code> is specified, the encrypted state must be <code>true</code>.</p>
115    /// <p>You can specify the KMS key using any of the following:</p>
116    /// <ul>
117    /// <li>
118    /// <p>Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
119    /// <li>
120    /// <p>Key alias. For example, alias/ExampleAlias.</p></li>
121    /// <li>
122    /// <p>Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
123    /// <li>
124    /// <p>Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.</p></li>
125    /// </ul>
126    /// <p>Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.</p>
127    /// <p>Amazon EBS does not support asymmetric KMS keys.</p>
128    pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129        self.inner = self.inner.kms_key_id(input.into());
130        self
131    }
132    /// <p>The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If <code>KmsKeyId</code> is specified, the encrypted state must be <code>true</code>.</p>
133    /// <p>You can specify the KMS key using any of the following:</p>
134    /// <ul>
135    /// <li>
136    /// <p>Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
137    /// <li>
138    /// <p>Key alias. For example, alias/ExampleAlias.</p></li>
139    /// <li>
140    /// <p>Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
141    /// <li>
142    /// <p>Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.</p></li>
143    /// </ul>
144    /// <p>Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.</p>
145    /// <p>Amazon EBS does not support asymmetric KMS keys.</p>
146    pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
147        self.inner = self.inner.set_kms_key_id(input);
148        self
149    }
150    /// <p>The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If <code>KmsKeyId</code> is specified, the encrypted state must be <code>true</code>.</p>
151    /// <p>You can specify the KMS key using any of the following:</p>
152    /// <ul>
153    /// <li>
154    /// <p>Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
155    /// <li>
156    /// <p>Key alias. For example, alias/ExampleAlias.</p></li>
157    /// <li>
158    /// <p>Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.</p></li>
159    /// <li>
160    /// <p>Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.</p></li>
161    /// </ul>
162    /// <p>Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.</p>
163    /// <p>Amazon EBS does not support asymmetric KMS keys.</p>
164    pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_kms_key_id()
166    }
167    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
168    pub fn dry_run(mut self, input: bool) -> Self {
169        self.inner = self.inner.dry_run(input);
170        self
171    }
172    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
173    pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
174        self.inner = self.inner.set_dry_run(input);
175        self
176    }
177    /// <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
178    pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
179        self.inner.get_dry_run()
180    }
181}