aws_sdk_directconnect/client/
delete_bgp_peer.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 [`DeleteBGPPeer`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`virtual_interface_id(impl Into<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::virtual_interface_id) / [`set_virtual_interface_id(Option<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::set_virtual_interface_id):<br>required: **false**<br><p>The ID of the virtual interface.</p><br>
7    ///   - [`asn(i32)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::asn) / [`set_asn(Option<i32>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::set_asn):<br>required: **false**<br><p>The autonomous system number (ASN). The valid range is from 1 to 2147483646 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned. Use <code>asnLong</code> instead.</p><note>  <p>You can use <code>asnLong</code> or <code>asn</code>, but not both. We recommend using <code>asnLong</code> as it supports a greater pool of numbers.</p>  <ul>   <li>    <p>The <code>asnLong</code> attribute accepts both ASN and long ASN ranges.</p></li>   <li>    <p>If you provide a value in the same API call for both <code>asn</code> and <code>asnLong</code>, the API will only accept the value for <code>asnLong</code>.</p></li>  </ul> </note><br>
8    ///   - [`asn_long(i64)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::asn_long) / [`set_asn_long(Option<i64>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::set_asn_long):<br>required: **false**<br><p>The long ASN for the BGP peer to be deleted from a Direct Connect virtual interface. The valid range is from 1 to 4294967294 for BGP configuration.</p><note>  <p>You can use <code>asnLong</code> or <code>asn</code>, but not both. We recommend using <code>asnLong</code> as it supports a greater pool of numbers.</p>  <ul>   <li>    <p>The <code>asnLong</code> attribute accepts both ASN and long ASN ranges.</p></li>   <li>    <p>If you provide a value in the same API call for both <code>asn</code> and <code>asnLong</code>, the API will only accept the value for <code>asnLong</code>.</p></li>  </ul> </note><br>
9    ///   - [`customer_address(impl Into<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::customer_address) / [`set_customer_address(Option<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::set_customer_address):<br>required: **false**<br><p>The IP address assigned to the customer interface.</p><br>
10    ///   - [`bgp_peer_id(impl Into<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::bgp_peer_id) / [`set_bgp_peer_id(Option<String>)`](crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::set_bgp_peer_id):<br>required: **false**<br><p>The ID of the BGP peer.</p><br>
11    /// - On success, responds with [`DeleteBgpPeerOutput`](crate::operation::delete_bgp_peer::DeleteBgpPeerOutput) with field(s):
12    ///   - [`virtual_interface(Option<VirtualInterface>)`](crate::operation::delete_bgp_peer::DeleteBgpPeerOutput::virtual_interface): <p>The virtual interface.</p>
13    /// - On failure, responds with [`SdkError<DeleteBGPPeerError>`](crate::operation::delete_bgp_peer::DeleteBGPPeerError)
14    pub fn delete_bgp_peer(&self) -> crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder {
15        crate::operation::delete_bgp_peer::builders::DeleteBGPPeerFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_directconnect/client/delete_bgp_peer.rs

aws_sdk_directconnect/client/
delete_bgp_peer.rs
