aws_sdk_ec2/client/
modify_traffic_mirror_session.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 [`ModifyTrafficMirrorSession`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`traffic_mirror_session_id(impl Into<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::traffic_mirror_session_id) / [`set_traffic_mirror_session_id(Option<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_traffic_mirror_session_id):<br>required: **true**<br><p>The ID of the Traffic Mirror session.</p><br>
7    ///   - [`traffic_mirror_target_id(impl Into<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::traffic_mirror_target_id) / [`set_traffic_mirror_target_id(Option<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_traffic_mirror_target_id):<br>required: **false**<br><p>The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.</p><br>
8    ///   - [`traffic_mirror_filter_id(impl Into<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::traffic_mirror_filter_id) / [`set_traffic_mirror_filter_id(Option<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_traffic_mirror_filter_id):<br>required: **false**<br><p>The ID of the Traffic Mirror filter.</p><br>
9    ///   - [`packet_length(i32)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::packet_length) / [`set_packet_length(Option<i32>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_packet_length):<br>required: **false**<br><p>The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.</p> <p>For sessions with Network Load Balancer (NLB) traffic mirror targets, the default <code>PacketLength</code> will be set to 8500. Valid values are 1-8500. Setting a <code>PacketLength</code> greater than 8500 will result in an error response.</p><br>
10    ///   - [`session_number(i32)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::session_number) / [`set_session_number(Option<i32>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_session_number):<br>required: **false**<br><p>The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.</p> <p>Valid values are 1-32766.</p><br>
11    ///   - [`virtual_network_id(i32)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::virtual_network_id) / [`set_virtual_network_id(Option<i32>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_virtual_network_id):<br>required: **false**<br><p>The virtual network ID of the Traffic Mirror session.</p><br>
12    ///   - [`description(impl Into<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_description):<br>required: **false**<br><p>The description to assign to the Traffic Mirror session.</p><br>
13    ///   - [`remove_fields(TrafficMirrorSessionField)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::remove_fields) / [`set_remove_fields(Option<Vec::<TrafficMirrorSessionField>>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_remove_fields):<br>required: **false**<br><p>The properties that you want to remove from the Traffic Mirror session.</p> <p>When you remove a property from a Traffic Mirror session, the property is set to the default.</p><br>
14    ///   - [`dry_run(bool)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::set_dry_run):<br>required: **false**<br><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><br>
15    /// - On success, responds with [`ModifyTrafficMirrorSessionOutput`](crate::operation::modify_traffic_mirror_session::ModifyTrafficMirrorSessionOutput) with field(s):
16    ///   - [`traffic_mirror_session(Option<TrafficMirrorSession>)`](crate::operation::modify_traffic_mirror_session::ModifyTrafficMirrorSessionOutput::traffic_mirror_session): <p>Information about the Traffic Mirror session.</p>
17    /// - On failure, responds with [`SdkError<ModifyTrafficMirrorSessionError>`](crate::operation::modify_traffic_mirror_session::ModifyTrafficMirrorSessionError)
18    pub fn modify_traffic_mirror_session(
19        &self,
20    ) -> crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder {
21        crate::operation::modify_traffic_mirror_session::builders::ModifyTrafficMirrorSessionFluentBuilder::new(self.handle.clone())
22    }
23}