aws_sdk_ec2/client/modify_instance_connect_endpoint.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`ModifyInstanceConnectEndpoint`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`dry_run(bool)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the operation, 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><br>
7 /// - [`instance_connect_endpoint_id(impl Into<String>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::instance_connect_endpoint_id) / [`set_instance_connect_endpoint_id(Option<String>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::set_instance_connect_endpoint_id):<br>required: **true**<br><p>The ID of the EC2 Instance Connect Endpoint to modify.</p><br>
8 /// - [`ip_address_type(IpAddressType)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::ip_address_type) / [`set_ip_address_type(Option<IpAddressType>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::set_ip_address_type):<br>required: **false**<br><p>The new IP address type for the EC2 Instance Connect Endpoint.</p><note> <p><code>PreserveClientIp</code> is only supported on IPv4 EC2 Instance Connect Endpoints. To use <code>PreserveClientIp</code>, the value for <code>IpAddressType</code> must be <code>ipv4</code>.</p> </note><br>
9 /// - [`security_group_ids(impl Into<String>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::security_group_ids) / [`set_security_group_ids(Option<Vec::<String>>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::set_security_group_ids):<br>required: **false**<br><p>Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.</p><br>
10 /// - [`preserve_client_ip(bool)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::preserve_client_ip) / [`set_preserve_client_ip(Option<bool>)`](crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::set_preserve_client_ip):<br>required: **false**<br><p>Indicates whether the client IP address is preserved as the source when you connect to a resource. The following are the possible values.</p> <ul> <li> <p><code>true</code> - Use the IP address of the client. Your instance must have an IPv4 address.</p></li> <li> <p><code>false</code> - Use the IP address of the network interface.</p></li> </ul><br>
11 /// - On success, responds with [`ModifyInstanceConnectEndpointOutput`](crate::operation::modify_instance_connect_endpoint::ModifyInstanceConnectEndpointOutput) with field(s):
12 /// - [`r#return(Option<bool>)`](crate::operation::modify_instance_connect_endpoint::ModifyInstanceConnectEndpointOutput::return): <p>Is <code>true</code> if the request succeeds and an error otherwise.</p>
13 /// - On failure, responds with [`SdkError<ModifyInstanceConnectEndpointError>`](crate::operation::modify_instance_connect_endpoint::ModifyInstanceConnectEndpointError)
14 pub fn modify_instance_connect_endpoint(
15 &self,
16 ) -> crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder {
17 crate::operation::modify_instance_connect_endpoint::builders::ModifyInstanceConnectEndpointFluentBuilder::new(self.handle.clone())
18 }
19}