aws_sdk_lightsail/operation/update_instance_metadata_options/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_instance_metadata_options::_update_instance_metadata_options_output::UpdateInstanceMetadataOptionsOutputBuilder;
3
4pub use crate::operation::update_instance_metadata_options::_update_instance_metadata_options_input::UpdateInstanceMetadataOptionsInputBuilder;
5
6impl crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsInputBuilder {
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::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_instance_metadata_options();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateInstanceMetadataOptions`.
24///
25/// <p>Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the <code>GetInstance</code> or <code>GetInstances</code> API operation initially responds with a state of <code>pending</code>. After the parameter modifications are successfully applied, the state changes to <code>applied</code> in subsequent <code>GetInstance</code> or <code>GetInstances</code> API calls. For more information, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-instance-metadata-service">Use IMDSv2 with an Amazon Lightsail instance</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct UpdateInstanceMetadataOptionsFluentBuilder {
28 handle: ::std::sync::Arc<crate::client::Handle>,
29 inner: crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsInputBuilder,
30 config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33 crate::client::customize::internal::CustomizableSend<
34 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput,
35 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError,
36 > for UpdateInstanceMetadataOptionsFluentBuilder
37{
38 fn send(
39 self,
40 config_override: crate::config::Builder,
41 ) -> crate::client::customize::internal::BoxFuture<
42 crate::client::customize::internal::SendResult<
43 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput,
44 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError,
45 >,
46 > {
47 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48 }
49}
50impl UpdateInstanceMetadataOptionsFluentBuilder {
51 /// Creates a new `UpdateInstanceMetadataOptionsFluentBuilder`.
52 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53 Self {
54 handle,
55 inner: ::std::default::Default::default(),
56 config_override: ::std::option::Option::None,
57 }
58 }
59 /// Access the UpdateInstanceMetadataOptions as a reference.
60 pub fn as_input(&self) -> &crate::operation::update_instance_metadata_options::builders::UpdateInstanceMetadataOptionsInputBuilder {
61 &self.inner
62 }
63 /// Sends the request and returns the response.
64 ///
65 /// If an error occurs, an `SdkError` will be returned with additional details that
66 /// can be matched against.
67 ///
68 /// By default, any retryable failures will be retried twice. Retry behavior
69 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70 /// set when configuring the client.
71 pub async fn send(
72 self,
73 ) -> ::std::result::Result<
74 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput,
75 ::aws_smithy_runtime_api::client::result::SdkError<
76 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError,
77 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78 >,
79 > {
80 let input = self
81 .inner
82 .build()
83 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84 let runtime_plugins = crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptions::operation_runtime_plugins(
85 self.handle.runtime_plugins.clone(),
86 &self.handle.conf,
87 self.config_override,
88 );
89 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptions::orchestrate(&runtime_plugins, input).await
90 }
91
92 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93 pub fn customize(
94 self,
95 ) -> crate::client::customize::CustomizableOperation<
96 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsOutput,
97 crate::operation::update_instance_metadata_options::UpdateInstanceMetadataOptionsError,
98 Self,
99 > {
100 crate::client::customize::CustomizableOperation::new(self)
101 }
102 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103 self.set_config_override(::std::option::Option::Some(config_override.into()));
104 self
105 }
106
107 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108 self.config_override = config_override;
109 self
110 }
111 /// <p>The name of the instance for which to update metadata parameters.</p>
112 pub fn instance_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113 self.inner = self.inner.instance_name(input.into());
114 self
115 }
116 /// <p>The name of the instance for which to update metadata parameters.</p>
117 pub fn set_instance_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118 self.inner = self.inner.set_instance_name(input);
119 self
120 }
121 /// <p>The name of the instance for which to update metadata parameters.</p>
122 pub fn get_instance_name(&self) -> &::std::option::Option<::std::string::String> {
123 self.inner.get_instance_name()
124 }
125 /// <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p>
126 /// <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p>
127 /// <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p>
128 pub fn http_tokens(mut self, input: crate::types::HttpTokens) -> Self {
129 self.inner = self.inner.http_tokens(input);
130 self
131 }
132 /// <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p>
133 /// <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p>
134 /// <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p>
135 pub fn set_http_tokens(mut self, input: ::std::option::Option<crate::types::HttpTokens>) -> Self {
136 self.inner = self.inner.set_http_tokens(input);
137 self
138 }
139 /// <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p>
140 /// <p>If the state is <code>optional</code>, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.</p>
141 /// <p>If the state is <code>required</code>, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.</p>
142 pub fn get_http_tokens(&self) -> &::std::option::Option<crate::types::HttpTokens> {
143 self.inner.get_http_tokens()
144 }
145 /// <p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.</p>
146 /// <p>If you specify a value of <code>disabled</code>, you cannot access your instance metadata.</p>
147 pub fn http_endpoint(mut self, input: crate::types::HttpEndpoint) -> Self {
148 self.inner = self.inner.http_endpoint(input);
149 self
150 }
151 /// <p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.</p>
152 /// <p>If you specify a value of <code>disabled</code>, you cannot access your instance metadata.</p>
153 pub fn set_http_endpoint(mut self, input: ::std::option::Option<crate::types::HttpEndpoint>) -> Self {
154 self.inner = self.inner.set_http_endpoint(input);
155 self
156 }
157 /// <p>Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.</p>
158 /// <p>If you specify a value of <code>disabled</code>, you cannot access your instance metadata.</p>
159 pub fn get_http_endpoint(&self) -> &::std::option::Option<crate::types::HttpEndpoint> {
160 self.inner.get_http_endpoint()
161 }
162 /// <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.</p>
163 pub fn http_put_response_hop_limit(mut self, input: i32) -> Self {
164 self.inner = self.inner.http_put_response_hop_limit(input);
165 self
166 }
167 /// <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.</p>
168 pub fn set_http_put_response_hop_limit(mut self, input: ::std::option::Option<i32>) -> Self {
169 self.inner = self.inner.set_http_put_response_hop_limit(input);
170 self
171 }
172 /// <p>The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.</p>
173 pub fn get_http_put_response_hop_limit(&self) -> &::std::option::Option<i32> {
174 self.inner.get_http_put_response_hop_limit()
175 }
176 /// <p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.</p><note>
177 /// <p>This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (<code>eu-north-1</code>).</p>
178 /// </note>
179 pub fn http_protocol_ipv6(mut self, input: crate::types::HttpProtocolIpv6) -> Self {
180 self.inner = self.inner.http_protocol_ipv6(input);
181 self
182 }
183 /// <p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.</p><note>
184 /// <p>This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (<code>eu-north-1</code>).</p>
185 /// </note>
186 pub fn set_http_protocol_ipv6(mut self, input: ::std::option::Option<crate::types::HttpProtocolIpv6>) -> Self {
187 self.inner = self.inner.set_http_protocol_ipv6(input);
188 self
189 }
190 /// <p>Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.</p><note>
191 /// <p>This parameter is available only for instances in the Europe (Stockholm) Amazon Web Services Region (<code>eu-north-1</code>).</p>
192 /// </note>
193 pub fn get_http_protocol_ipv6(&self) -> &::std::option::Option<crate::types::HttpProtocolIpv6> {
194 self.inner.get_http_protocol_ipv6()
195 }
196}