Struct Client

pub struct Client { /* private fields */ }

Client for AWS Direct Connect

Client for invoking operations on AWS Direct Connect. Each operation on AWS Direct Connect is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_directconnect::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_directconnect::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AcceptDirectConnectGatewayAssociationProposal operation has a Client::accept_direct_connect_gateway_association_proposal, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.accept_direct_connect_gateway_association_proposal()
    .direct_connect_gateway_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn accept_direct_connect_gateway_association_proposal( &self, ) -> AcceptDirectConnectGatewayAssociationProposalFluentBuilder

Constructs a fluent builder for the AcceptDirectConnectGatewayAssociationProposal operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway.

    
    
  • proposal_id(impl Into<String>) / set_proposal_id(Option<String>):
    required: true
    

    The ID of the request proposal.

    
    
  • associated_gateway_owner_account(impl Into<String>) / set_associated_gateway_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.

    
    
  • override_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_override_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

    For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

    
    
• On success, responds with AcceptDirectConnectGatewayAssociationProposalOutput with field(s):
  • direct_connect_gateway_association(Option<DirectConnectGatewayAssociation>):

    Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.

• On failure, responds with SdkError<AcceptDirectConnectGatewayAssociationProposalError>

impl Client

pub fn allocate_connection_on_interconnect( &self, ) -> AllocateConnectionOnInterconnectFluentBuilder

👎Deprecated

Constructs a fluent builder for the AllocateConnectionOnInterconnect operation.

• The fluent builder is configurable:
  • bandwidth(impl Into<String>) / set_bandwidth(Option<String>):
    required: true
    

    The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

    
    
  • connection_name(impl Into<String>) / set_connection_name(Option<String>):
    required: true
    

    The name of the provisioned connection.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

    
    
  • interconnect_id(impl Into<String>) / set_interconnect_id(Option<String>):
    required: true
    

    The ID of the interconnect on which the connection will be provisioned.

    
    
  • vlan(i32) / set_vlan(Option<i32>):
    required: true
    

    The dedicated VLAN provisioned to the connection.

    
    
• On success, responds with AllocateConnectionOnInterconnectOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<AllocateConnectionOnInterconnectError>

impl Client

pub fn allocate_hosted_connection( &self, ) -> AllocateHostedConnectionFluentBuilder

Constructs a fluent builder for the AllocateHostedConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the interconnect or LAG.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account ID of the customer for the connection.

    
    
  • bandwidth(impl Into<String>) / set_bandwidth(Option<String>):
    required: true
    

    The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.

    
    
  • connection_name(impl Into<String>) / set_connection_name(Option<String>):
    required: true
    

    The name of the hosted connection.

    
    
  • vlan(i32) / set_vlan(Option<i32>):
    required: true
    

    The dedicated VLAN provisioned to the hosted connection.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags associated with the connection.

    
    
• On success, responds with AllocateHostedConnectionOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<AllocateHostedConnectionError>

impl Client

pub fn allocate_private_virtual_interface( &self, ) -> AllocatePrivateVirtualInterfaceFluentBuilder

Constructs a fluent builder for the AllocatePrivateVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection on which the private virtual interface is provisioned.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that owns the virtual private interface.

    
    
  • new_private_virtual_interface_allocation(NewPrivateVirtualInterfaceAllocation) / set_new_private_virtual_interface_allocation(Option<NewPrivateVirtualInterfaceAllocation>):
    required: true
    

    Information about the private virtual interface.

    
    
• On success, responds with AllocatePrivateVirtualInterfaceOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<AllocatePrivateVirtualInterfaceError>

impl Client

pub fn allocate_public_virtual_interface( &self, ) -> AllocatePublicVirtualInterfaceFluentBuilder

Constructs a fluent builder for the AllocatePublicVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection on which the public virtual interface is provisioned.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that owns the public virtual interface.

    
    
  • new_public_virtual_interface_allocation(NewPublicVirtualInterfaceAllocation) / set_new_public_virtual_interface_allocation(Option<NewPublicVirtualInterfaceAllocation>):
    required: true
    

    Information about the public virtual interface.

    
    
• On success, responds with AllocatePublicVirtualInterfaceOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<AllocatePublicVirtualInterfaceError>

impl Client

pub fn allocate_transit_virtual_interface( &self, ) -> AllocateTransitVirtualInterfaceFluentBuilder

Constructs a fluent builder for the AllocateTransitVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection on which the transit virtual interface is provisioned.

    
    
  • owner_account(impl Into<String>) / set_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that owns the transit virtual interface.

    
    
  • new_transit_virtual_interface_allocation(NewTransitVirtualInterfaceAllocation) / set_new_transit_virtual_interface_allocation(Option<NewTransitVirtualInterfaceAllocation>):
    required: true
    

    Information about the transit virtual interface.

    
    
• On success, responds with AllocateTransitVirtualInterfaceOutput with field(s):
  • virtual_interface(Option<VirtualInterface>):

    Information about the transit virtual interface.

• On failure, responds with SdkError<AllocateTransitVirtualInterfaceError>

impl Client

pub fn associate_connection_with_lag( &self, ) -> AssociateConnectionWithLagFluentBuilder

Constructs a fluent builder for the AssociateConnectionWithLag operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: true
    

    The ID of the LAG with which to associate the connection.

    
    
• On success, responds with AssociateConnectionWithLagOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<AssociateConnectionWithLagError>

impl Client

pub fn associate_hosted_connection( &self, ) -> AssociateHostedConnectionFluentBuilder

Constructs a fluent builder for the AssociateHostedConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the hosted connection.

    
    
  • parent_connection_id(impl Into<String>) / set_parent_connection_id(Option<String>):
    required: true
    

    The ID of the interconnect or the LAG.

    
    
• On success, responds with AssociateHostedConnectionOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<AssociateHostedConnectionError>

impl Client

pub fn associate_mac_sec_key(&self) -> AssociateMacSecKeyFluentBuilder

Constructs a fluent builder for the AssociateMacSecKey operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

    You can use DescribeConnections or DescribeLags to retrieve connection ID.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

    You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

    If you use this request parameter, you do not use the ckn and cak request parameters.

    
    
  • ckn(impl Into<String>) / set_ckn(Option<String>):
    required: false
    

    The MAC Security (MACsec) CKN to associate with the dedicated connection.

    You can create the CKN/CAK pair using an industry standard tool.

    The valid values are 64 hexadecimal characters (0-9, A-E).

    If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

    
    
  • cak(impl Into<String>) / set_cak(Option<String>):
    required: false
    

    The MAC Security (MACsec) CAK to associate with the dedicated connection.

    You can create the CKN/CAK pair using an industry standard tool.

    The valid values are 64 hexadecimal characters (0-9, A-E).

    If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

    
    
• On success, responds with AssociateMacSecKeyOutput with field(s):
  • connection_id(Option<String>):

    The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the dedicated connection.

• On failure, responds with SdkError<AssociateMacSecKeyError>

impl Client

pub fn associate_virtual_interface( &self, ) -> AssociateVirtualInterfaceFluentBuilder

Constructs a fluent builder for the AssociateVirtualInterface operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the LAG or connection.

    
    
• On success, responds with AssociateVirtualInterfaceOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<AssociateVirtualInterfaceError>

impl Client

pub fn confirm_connection(&self) -> ConfirmConnectionFluentBuilder

Constructs a fluent builder for the ConfirmConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the hosted connection.

    
    
• On success, responds with ConfirmConnectionOutput with field(s):
  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

• On failure, responds with SdkError<ConfirmConnectionError>

impl Client

pub fn confirm_customer_agreement( &self, ) -> ConfirmCustomerAgreementFluentBuilder

Constructs a fluent builder for the ConfirmCustomerAgreement operation.

• The fluent builder is configurable:
  • agreement_name(impl Into<String>) / set_agreement_name(Option<String>):
    required: false
    

    The name of the customer agreement.

    
    
• On success, responds with ConfirmCustomerAgreementOutput with field(s):
  • status(Option<String>):

    The status of the customer agreement when the connection was created. This will be either signed or unsigned.

• On failure, responds with SdkError<ConfirmCustomerAgreementError>

impl Client

pub fn confirm_private_virtual_interface( &self, ) -> ConfirmPrivateVirtualInterfaceFluentBuilder

Constructs a fluent builder for the ConfirmPrivateVirtualInterface operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
  • virtual_gateway_id(impl Into<String>) / set_virtual_gateway_id(Option<String>):
    required: false
    

    The ID of the virtual private gateway.

    
    
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
• On success, responds with ConfirmPrivateVirtualInterfaceOutput with field(s):
  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

• On failure, responds with SdkError<ConfirmPrivateVirtualInterfaceError>

impl Client

pub fn confirm_public_virtual_interface( &self, ) -> ConfirmPublicVirtualInterfaceFluentBuilder

Constructs a fluent builder for the ConfirmPublicVirtualInterface operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
• On success, responds with ConfirmPublicVirtualInterfaceOutput with field(s):
  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

• On failure, responds with SdkError<ConfirmPublicVirtualInterfaceError>

impl Client

pub fn confirm_transit_virtual_interface( &self, ) -> ConfirmTransitVirtualInterfaceFluentBuilder

Constructs a fluent builder for the ConfirmTransitVirtualInterface operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway.

    
    
• On success, responds with ConfirmTransitVirtualInterfaceOutput with field(s):
  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

• On failure, responds with SdkError<ConfirmTransitVirtualInterfaceError>

impl Client

pub fn create_bgp_peer(&self) -> CreateBGPPeerFluentBuilder

Constructs a fluent builder for the CreateBGPPeer operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: false
    

    The ID of the virtual interface.

    
    
  • new_bgp_peer(NewBgpPeer) / set_new_bgp_peer(Option<NewBgpPeer>):
    required: false
    

    Information about the BGP peer.

    
    
• On success, responds with CreateBgpPeerOutput with field(s):
  • virtual_interface(Option<VirtualInterface>):

    The virtual interface.

• On failure, responds with SdkError<CreateBGPPeerError>

impl Client

pub fn create_connection(&self) -> CreateConnectionFluentBuilder

Constructs a fluent builder for the CreateConnection operation.

• The fluent builder is configurable:
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The location of the connection.

    
    
  • bandwidth(impl Into<String>) / set_bandwidth(Option<String>):
    required: true
    

    The bandwidth of the connection.

    
    
  • connection_name(impl Into<String>) / set_connection_name(Option<String>):
    required: true
    

    The name of the connection.

    
    
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: false
    

    The ID of the LAG.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the lag.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the service provider associated with the requested connection.

    
    
  • request_mac_sec(bool) / set_request_mac_sec(Option<bool>):
    required: false
    

    Indicates whether you want the connection to support MAC Security (MACsec).

    MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

    
    
• On success, responds with CreateConnectionOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<CreateConnectionError>

impl Client

pub fn create_direct_connect_gateway( &self, ) -> CreateDirectConnectGatewayFluentBuilder

Constructs a fluent builder for the CreateDirectConnectGateway operation.

• The fluent builder is configurable:
  • direct_connect_gateway_name(impl Into<String>) / set_direct_connect_gateway_name(Option<String>):
    required: true
    

    The name of the Direct Connect gateway.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The key-value pair tags associated with the request.

    
    
  • amazon_side_asn(i64) / set_amazon_side_asn(Option<i64>):
    required: false
    

    The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

    
    
• On success, responds with CreateDirectConnectGatewayOutput with field(s):
  • direct_connect_gateway(Option<DirectConnectGateway>):

    The Direct Connect gateway.

• On failure, responds with SdkError<CreateDirectConnectGatewayError>

impl Client

pub fn create_direct_connect_gateway_association( &self, ) -> CreateDirectConnectGatewayAssociationFluentBuilder

Constructs a fluent builder for the CreateDirectConnectGatewayAssociation operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: false
    

    The ID of the virtual private gateway or transit gateway.

    
    
  • add_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_add_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    The Amazon VPC prefixes to advertise to the Direct Connect gateway

    This parameter is required when you create an association to a transit gateway.

    For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

    
    
  • virtual_gateway_id(impl Into<String>) / set_virtual_gateway_id(Option<String>):
    required: false
    

    The ID of the virtual private gateway.

    
    
• On success, responds with CreateDirectConnectGatewayAssociationOutput with field(s):
  • direct_connect_gateway_association(Option<DirectConnectGatewayAssociation>):

    The association to be created.

• On failure, responds with SdkError<CreateDirectConnectGatewayAssociationError>

impl Client

pub fn create_direct_connect_gateway_association_proposal( &self, ) -> CreateDirectConnectGatewayAssociationProposalFluentBuilder

Constructs a fluent builder for the CreateDirectConnectGatewayAssociationProposal operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway.

    
    
  • direct_connect_gateway_owner_account(impl Into<String>) / set_direct_connect_gateway_owner_account(Option<String>):
    required: true
    

    The ID of the Amazon Web Services account that owns the Direct Connect gateway.

    
    
  • gateway_id(impl Into<String>) / set_gateway_id(Option<String>):
    required: true
    

    The ID of the virtual private gateway or transit gateway.

    
    
  • add_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_add_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    The Amazon VPC prefixes to advertise to the Direct Connect gateway.

    
    
  • remove_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_remove_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

    
    
• On success, responds with CreateDirectConnectGatewayAssociationProposalOutput with field(s):
  • direct_connect_gateway_association_proposal(Option<DirectConnectGatewayAssociationProposal>):

    Information about the Direct Connect gateway proposal.

• On failure, responds with SdkError<CreateDirectConnectGatewayAssociationProposalError>

impl Client

pub fn create_interconnect(&self) -> CreateInterconnectFluentBuilder

Constructs a fluent builder for the CreateInterconnect operation.

• The fluent builder is configurable:
  • interconnect_name(impl Into<String>) / set_interconnect_name(Option<String>):
    required: true
    

    The name of the interconnect.

    
    
  • bandwidth(impl Into<String>) / set_bandwidth(Option<String>):
    required: true
    

    The port bandwidth, in Gbps. The possible values are 1, 10, and 100.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The location of the interconnect.

    
    
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: false
    

    The ID of the LAG.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the interconnect.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the service provider associated with the interconnect.

    
    
• On success, responds with CreateInterconnectOutput with field(s):
  • interconnect_id(Option<String>):

    The ID of the interconnect.

  • interconnect_name(Option<String>):

    The name of the interconnect.

  • interconnect_state(Option<InterconnectState>):

    The state of the interconnect. The following are the possible values:

    • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The interconnect is approved, and is being initialized.

    • available: The network link is up, and the interconnect is ready for use.

    • down: The network link is down.

    • deleting: The interconnect is being deleted.

    • deleted: The interconnect is deleted.

    • unknown: The state of the interconnect is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the interconnect.

  • provider_name(Option<String>):

    The name of the service provider associated with the interconnect.

• On failure, responds with SdkError<CreateInterconnectError>

impl Client

pub fn create_lag(&self) -> CreateLagFluentBuilder

Constructs a fluent builder for the CreateLag operation.

• The fluent builder is configurable:
  • number_of_connections(i32) / set_number_of_connections(Option<i32>):
    required: true
    

    The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The location for the LAG.

    
    
  • connections_bandwidth(impl Into<String>) / set_connections_bandwidth(Option<String>):
    required: true
    

    The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.

    
    
  • lag_name(impl Into<String>) / set_lag_name(Option<String>):
    required: true
    

    The name of the LAG.

    
    
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: false
    

    The ID of an existing dedicated connection to migrate to the LAG.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the LAG.

    
    
  • child_connection_tags(Tag) / set_child_connection_tags(Option<Vec::<Tag>>):
    required: false
    

    The tags to associate with the automtically created LAGs.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the service provider associated with the LAG.

    
    
  • request_mac_sec(bool) / set_request_mac_sec(Option<bool>):
    required: false
    

    Indicates whether the connection will support MAC Security (MACsec).

    All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

    
    
• On success, responds with CreateLagOutput with field(s):
  • connections_bandwidth(Option<String>):

    The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

  • number_of_connections(i32):

    The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

  • lag_id(Option<String>):

    The ID of the LAG.

  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the LAG.

  • lag_name(Option<String>):

    The name of the LAG.

  • lag_state(Option<LagState>):

    The state of the LAG. The following are the possible values:

    • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

    • pending: The LAG has been approved and is being initialized.

    • available: The network link is established and the LAG is ready for use.

    • down: The network link is down.

    • deleting: The LAG is being deleted.

    • deleted: The LAG is deleted.

    • unknown: The state of the LAG is not available.

  • location(Option<String>):

    The location of the LAG.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • minimum_links(i32):

    The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

  • aws_device(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • connections(Option<Vec::<Connection>>):

    The connections bundled by the LAG.

  • allows_hosted_connections(bool):

    Indicates whether the LAG can host other connections.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the LAG.

  • provider_name(Option<String>):

    The name of the service provider associated with the LAG.

  • mac_sec_capable(Option<bool>):

    Indicates whether the LAG supports MAC Security (MACsec).

  • encryption_mode(Option<String>):

    The LAG MAC Security (MACsec) encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the LAG.

• On failure, responds with SdkError<CreateLagError>

impl Client

pub fn create_private_virtual_interface( &self, ) -> CreatePrivateVirtualInterfaceFluentBuilder

Constructs a fluent builder for the CreatePrivateVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • new_private_virtual_interface(NewPrivateVirtualInterface) / set_new_private_virtual_interface(Option<NewPrivateVirtualInterface>):
    required: true
    

    Information about the private virtual interface.

    
    
• On success, responds with CreatePrivateVirtualInterfaceOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<CreatePrivateVirtualInterfaceError>

impl Client

pub fn create_public_virtual_interface( &self, ) -> CreatePublicVirtualInterfaceFluentBuilder

Constructs a fluent builder for the CreatePublicVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • new_public_virtual_interface(NewPublicVirtualInterface) / set_new_public_virtual_interface(Option<NewPublicVirtualInterface>):
    required: true
    

    Information about the public virtual interface.

    
    
• On success, responds with CreatePublicVirtualInterfaceOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<CreatePublicVirtualInterfaceError>

impl Client

pub fn create_transit_virtual_interface( &self, ) -> CreateTransitVirtualInterfaceFluentBuilder

Constructs a fluent builder for the CreateTransitVirtualInterface operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • new_transit_virtual_interface(NewTransitVirtualInterface) / set_new_transit_virtual_interface(Option<NewTransitVirtualInterface>):
    required: true
    

    Information about the transit virtual interface.

    
    
• On success, responds with CreateTransitVirtualInterfaceOutput with field(s):
  • virtual_interface(Option<VirtualInterface>):

    Information about a virtual interface.

• On failure, responds with SdkError<CreateTransitVirtualInterfaceError>

impl Client

pub fn delete_bgp_peer(&self) -> DeleteBGPPeerFluentBuilder

Constructs a fluent builder for the DeleteBGPPeer operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: false
    

    The ID of the virtual interface.

    
    
  • asn(i32) / set_asn(Option<i32>):
    required: false
    

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    
    
  • customer_address(impl Into<String>) / set_customer_address(Option<String>):
    required: false
    

    The IP address assigned to the customer interface.

    
    
  • bgp_peer_id(impl Into<String>) / set_bgp_peer_id(Option<String>):
    required: false
    

    The ID of the BGP peer.

    
    
• On success, responds with DeleteBgpPeerOutput with field(s):
  • virtual_interface(Option<VirtualInterface>):

    The virtual interface.

• On failure, responds with SdkError<DeleteBGPPeerError>

impl Client

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
• On success, responds with DeleteConnectionOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<DeleteConnectionError>

impl Client

pub fn delete_direct_connect_gateway( &self, ) -> DeleteDirectConnectGatewayFluentBuilder

Constructs a fluent builder for the DeleteDirectConnectGateway operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway.

    
    
• On success, responds with DeleteDirectConnectGatewayOutput with field(s):
  • direct_connect_gateway(Option<DirectConnectGateway>):

    The Direct Connect gateway.

• On failure, responds with SdkError<DeleteDirectConnectGatewayError>

impl Client

pub fn delete_direct_connect_gateway_association( &self, ) -> DeleteDirectConnectGatewayAssociationFluentBuilder

Constructs a fluent builder for the DeleteDirectConnectGatewayAssociation operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway association.

    
    
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
  • virtual_gateway_id(impl Into<String>) / set_virtual_gateway_id(Option<String>):
    required: false
    

    The ID of the virtual private gateway.

    
    
• On success, responds with DeleteDirectConnectGatewayAssociationOutput with field(s):
  • direct_connect_gateway_association(Option<DirectConnectGatewayAssociation>):

    Information about the deleted association.

• On failure, responds with SdkError<DeleteDirectConnectGatewayAssociationError>

impl Client

pub fn delete_direct_connect_gateway_association_proposal( &self, ) -> DeleteDirectConnectGatewayAssociationProposalFluentBuilder

Constructs a fluent builder for the DeleteDirectConnectGatewayAssociationProposal operation.

• The fluent builder is configurable:
  • proposal_id(impl Into<String>) / set_proposal_id(Option<String>):
    required: true
    

    The ID of the proposal.

    
    
• On success, responds with DeleteDirectConnectGatewayAssociationProposalOutput with field(s):
  • direct_connect_gateway_association_proposal(Option<DirectConnectGatewayAssociationProposal>):

    The ID of the associated gateway.

• On failure, responds with SdkError<DeleteDirectConnectGatewayAssociationProposalError>

impl Client

pub fn delete_interconnect(&self) -> DeleteInterconnectFluentBuilder

Constructs a fluent builder for the DeleteInterconnect operation.

• The fluent builder is configurable:
  • interconnect_id(impl Into<String>) / set_interconnect_id(Option<String>):
    required: true
    

    The ID of the interconnect.

    
    
• On success, responds with DeleteInterconnectOutput with field(s):
  • interconnect_state(Option<InterconnectState>):

    The state of the interconnect. The following are the possible values:

    • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The interconnect is approved, and is being initialized.

    • available: The network link is up, and the interconnect is ready for use.

    • down: The network link is down.

    • deleting: The interconnect is being deleted.

    • deleted: The interconnect is deleted.

    • unknown: The state of the interconnect is not available.

• On failure, responds with SdkError<DeleteInterconnectError>

impl Client

pub fn delete_lag(&self) -> DeleteLagFluentBuilder

Constructs a fluent builder for the DeleteLag operation.

• The fluent builder is configurable:
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: true
    

    The ID of the LAG.

    
    
• On success, responds with DeleteLagOutput with field(s):
  • connections_bandwidth(Option<String>):

    The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

  • number_of_connections(i32):

    The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

  • lag_id(Option<String>):

    The ID of the LAG.

  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the LAG.

  • lag_name(Option<String>):

    The name of the LAG.

  • lag_state(Option<LagState>):

    The state of the LAG. The following are the possible values:

    • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

    • pending: The LAG has been approved and is being initialized.

    • available: The network link is established and the LAG is ready for use.

    • down: The network link is down.

    • deleting: The LAG is being deleted.

    • deleted: The LAG is deleted.

    • unknown: The state of the LAG is not available.

  • location(Option<String>):

    The location of the LAG.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • minimum_links(i32):

    The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

  • aws_device(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • connections(Option<Vec::<Connection>>):

    The connections bundled by the LAG.

  • allows_hosted_connections(bool):

    Indicates whether the LAG can host other connections.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the LAG.

  • provider_name(Option<String>):

    The name of the service provider associated with the LAG.

  • mac_sec_capable(Option<bool>):

    Indicates whether the LAG supports MAC Security (MACsec).

  • encryption_mode(Option<String>):

    The LAG MAC Security (MACsec) encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the LAG.

• On failure, responds with SdkError<DeleteLagError>

impl Client

pub fn delete_virtual_interface(&self) -> DeleteVirtualInterfaceFluentBuilder

Constructs a fluent builder for the DeleteVirtualInterface operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
• On success, responds with DeleteVirtualInterfaceOutput with field(s):
  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

• On failure, responds with SdkError<DeleteVirtualInterfaceError>

impl Client

pub fn describe_connection_loa(&self) -> DescribeConnectionLoaFluentBuilder

👎Deprecated

Constructs a fluent builder for the DescribeConnectionLoa operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

    
    
  • loa_content_type(LoaContentType) / set_loa_content_type(Option<LoaContentType>):
    required: false
    

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

    
    
• On success, responds with DescribeConnectionLoaOutput with field(s):
  • loa(Option<Loa>):

    The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

• On failure, responds with SdkError<DescribeConnectionLoaError>

impl Client

pub fn describe_connections(&self) -> DescribeConnectionsFluentBuilder

Constructs a fluent builder for the DescribeConnections operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: false
    

    The ID of the connection.

    
    
• On success, responds with DescribeConnectionsOutput with field(s):
  • connections(Option<Vec::<Connection>>):

    The connections.

• On failure, responds with SdkError<DescribeConnectionsError>

impl Client

pub fn describe_connections_on_interconnect( &self, ) -> DescribeConnectionsOnInterconnectFluentBuilder

👎Deprecated

Constructs a fluent builder for the DescribeConnectionsOnInterconnect operation.

• The fluent builder is configurable:
  • interconnect_id(impl Into<String>) / set_interconnect_id(Option<String>):
    required: true
    

    The ID of the interconnect.

    
    
• On success, responds with DescribeConnectionsOnInterconnectOutput with field(s):
  • connections(Option<Vec::<Connection>>):

    The connections.

• On failure, responds with SdkError<DescribeConnectionsOnInterconnectError>

impl Client

pub fn describe_customer_metadata( &self, ) -> DescribeCustomerMetadataFluentBuilder

Constructs a fluent builder for the DescribeCustomerMetadata operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeCustomerMetadataOutput with field(s):
  • agreements(Option<Vec::<CustomerAgreement>>):

    The list of customer agreements.

  • nni_partner_type(Option<NniPartnerType>):

    The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

    • V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.

    • V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.

    • nonPartner: The customer is not a partner.

• On failure, responds with SdkError<DescribeCustomerMetadataError>

impl Client

pub fn describe_direct_connect_gateway_association_proposals( &self, ) -> DescribeDirectConnectGatewayAssociationProposalsFluentBuilder

Constructs a fluent builder for the DescribeDirectConnectGatewayAssociationProposals operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
  • proposal_id(impl Into<String>) / set_proposal_id(Option<String>):
    required: false
    

    The ID of the proposal.

    
    
  • associated_gateway_id(impl Into<String>) / set_associated_gateway_id(Option<String>):
    required: false
    

    The ID of the associated gateway.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
• On success, responds with DescribeDirectConnectGatewayAssociationProposalsOutput with field(s):
  • direct_connect_gateway_association_proposals(Option<Vec::<DirectConnectGatewayAssociationProposal>>):

    Describes the Direct Connect gateway association proposals.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<DescribeDirectConnectGatewayAssociationProposalsError>

impl Client

pub fn describe_direct_connect_gateway_associations( &self, ) -> DescribeDirectConnectGatewayAssociationsFluentBuilder

Constructs a fluent builder for the DescribeDirectConnectGatewayAssociations operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway association.

    
    
  • associated_gateway_id(impl Into<String>) / set_associated_gateway_id(Option<String>):
    required: false
    

    The ID of the associated gateway.

    
    
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token provided in the previous call to retrieve the next page.

    
    
  • virtual_gateway_id(impl Into<String>) / set_virtual_gateway_id(Option<String>):
    required: false
    

    The ID of the virtual private gateway or transit gateway.

    
    
• On success, responds with DescribeDirectConnectGatewayAssociationsOutput with field(s):
  • direct_connect_gateway_associations(Option<Vec::<DirectConnectGatewayAssociation>>):

    Information about the associations.

  • next_token(Option<String>):

    The token to retrieve the next page.

• On failure, responds with SdkError<DescribeDirectConnectGatewayAssociationsError>

impl Client

pub fn describe_direct_connect_gateway_attachments( &self, ) -> DescribeDirectConnectGatewayAttachmentsFluentBuilder

Constructs a fluent builder for the DescribeDirectConnectGatewayAttachments operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: false
    

    The ID of the virtual interface.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token provided in the previous call to retrieve the next page.

    
    
• On success, responds with DescribeDirectConnectGatewayAttachmentsOutput with field(s):
  • direct_connect_gateway_attachments(Option<Vec::<DirectConnectGatewayAttachment>>):

    The attachments.

  • next_token(Option<String>):

    The token to retrieve the next page.

• On failure, responds with SdkError<DescribeDirectConnectGatewayAttachmentsError>

impl Client

pub fn describe_direct_connect_gateways( &self, ) -> DescribeDirectConnectGatewaysFluentBuilder

Constructs a fluent builder for the DescribeDirectConnectGateways operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token provided in the previous call to retrieve the next page.

    
    
• On success, responds with DescribeDirectConnectGatewaysOutput with field(s):
  • direct_connect_gateways(Option<Vec::<DirectConnectGateway>>):

    The Direct Connect gateways.

  • next_token(Option<String>):

    The token to retrieve the next page.

• On failure, responds with SdkError<DescribeDirectConnectGatewaysError>

impl Client

pub fn describe_hosted_connections( &self, ) -> DescribeHostedConnectionsFluentBuilder

Constructs a fluent builder for the DescribeHostedConnections operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the interconnect or LAG.

    
    
• On success, responds with DescribeHostedConnectionsOutput with field(s):
  • connections(Option<Vec::<Connection>>):

    The connections.

• On failure, responds with SdkError<DescribeHostedConnectionsError>

impl Client

pub fn describe_interconnect_loa(&self) -> DescribeInterconnectLoaFluentBuilder

👎Deprecated

Constructs a fluent builder for the DescribeInterconnectLoa operation.

• The fluent builder is configurable:
  • interconnect_id(impl Into<String>) / set_interconnect_id(Option<String>):
    required: true
    

    The ID of the interconnect.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

    
    
  • loa_content_type(LoaContentType) / set_loa_content_type(Option<LoaContentType>):
    required: false
    

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

    
    
• On success, responds with DescribeInterconnectLoaOutput with field(s):
  • loa(Option<Loa>):

    The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

• On failure, responds with SdkError<DescribeInterconnectLoaError>

impl Client

pub fn describe_interconnects(&self) -> DescribeInterconnectsFluentBuilder

Constructs a fluent builder for the DescribeInterconnects operation.

• The fluent builder is configurable:
  • interconnect_id(impl Into<String>) / set_interconnect_id(Option<String>):
    required: false
    

    The ID of the interconnect.

    
    
• On success, responds with DescribeInterconnectsOutput with field(s):
  • interconnects(Option<Vec::<Interconnect>>):

    The interconnects.

• On failure, responds with SdkError<DescribeInterconnectsError>

impl Client

pub fn describe_lags(&self) -> DescribeLagsFluentBuilder

Constructs a fluent builder for the DescribeLags operation.

• The fluent builder is configurable:
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: false
    

    The ID of the LAG.

    
    
• On success, responds with DescribeLagsOutput with field(s):
  • lags(Option<Vec::<Lag>>):

    The LAGs.

• On failure, responds with SdkError<DescribeLagsError>

impl Client

pub fn describe_loa(&self) -> DescribeLoaFluentBuilder

Constructs a fluent builder for the DescribeLoa operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of a connection, LAG, or interconnect.

    
    
  • provider_name(impl Into<String>) / set_provider_name(Option<String>):
    required: false
    

    The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

    
    
  • loa_content_type(LoaContentType) / set_loa_content_type(Option<LoaContentType>):
    required: false
    

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

    
    
• On success, responds with DescribeLoaOutput with field(s):
  • loa_content(Option<Blob>):

    The binary contents of the LOA-CFA document.

  • loa_content_type(Option<LoaContentType>):

    The standard media type for the LOA-CFA document. The only supported value is application/pdf.

• On failure, responds with SdkError<DescribeLoaError>

impl Client

pub fn describe_locations(&self) -> DescribeLocationsFluentBuilder

Constructs a fluent builder for the DescribeLocations operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeLocationsOutput with field(s):
  • locations(Option<Vec::<Location>>):

    The locations.

• On failure, responds with SdkError<DescribeLocationsError>

impl Client

pub fn describe_router_configuration( &self, ) -> DescribeRouterConfigurationFluentBuilder

Constructs a fluent builder for the DescribeRouterConfiguration operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface.

    
    
  • router_type_identifier(impl Into<String>) / set_router_type_identifier(Option<String>):
    required: false
    

    Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

    
    
• On success, responds with DescribeRouterConfigurationOutput with field(s):
  • customer_router_config(Option<String>):

    The customer router configuration.

  • router(Option<RouterType>):

    The details about the router.

  • virtual_interface_id(Option<String>):

    The ID assigned to the virtual interface.

  • virtual_interface_name(Option<String>):

    Provides the details about a virtual interface’s router.

• On failure, responds with SdkError<DescribeRouterConfigurationError>

impl Client

pub fn describe_tags(&self) -> DescribeTagsFluentBuilder

Constructs a fluent builder for the DescribeTags operation.

• The fluent builder is configurable:
  • resource_arns(impl Into<String>) / set_resource_arns(Option<Vec::<String>>):
    required: true
    

    The Amazon Resource Names (ARNs) of the resources.

    
    
• On success, responds with DescribeTagsOutput with field(s):
  • resource_tags(Option<Vec::<ResourceTag>>):

    Information about the tags.

• On failure, responds with SdkError<DescribeTagsError>

impl Client

pub fn describe_virtual_gateways(&self) -> DescribeVirtualGatewaysFluentBuilder

Constructs a fluent builder for the DescribeVirtualGateways operation.

• The fluent builder takes no input, just send it.
• On success, responds with DescribeVirtualGatewaysOutput with field(s):
  • virtual_gateways(Option<Vec::<VirtualGateway>>):

    The virtual private gateways.

• On failure, responds with SdkError<DescribeVirtualGatewaysError>

impl Client

pub fn describe_virtual_interfaces( &self, ) -> DescribeVirtualInterfacesFluentBuilder

Constructs a fluent builder for the DescribeVirtualInterfaces operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: false
    

    The ID of the connection.

    
    
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: false
    

    The ID of the virtual interface.

    
    
• On success, responds with DescribeVirtualInterfacesOutput with field(s):
  • virtual_interfaces(Option<Vec::<VirtualInterface>>):

    The virtual interfaces

• On failure, responds with SdkError<DescribeVirtualInterfacesError>

impl Client

pub fn disassociate_connection_from_lag( &self, ) -> DisassociateConnectionFromLagFluentBuilder

Constructs a fluent builder for the DisassociateConnectionFromLag operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the connection.

    
    
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: true
    

    The ID of the LAG.

    
    
• On success, responds with DisassociateConnectionFromLagOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<DisassociateConnectionFromLagError>

impl Client

pub fn disassociate_mac_sec_key(&self) -> DisassociateMacSecKeyFluentBuilder

Constructs a fluent builder for the DisassociateMacSecKey operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

    You can use DescribeConnections or DescribeLags to retrieve connection ID.

    
    
  • secret_arn(impl Into<String>) / set_secret_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

    You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

    
    
• On success, responds with DisassociateMacSecKeyOutput with field(s):
  • connection_id(Option<String>):

    The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

• On failure, responds with SdkError<DisassociateMacSecKeyError>

impl Client

pub fn list_virtual_interface_test_history( &self, ) -> ListVirtualInterfaceTestHistoryFluentBuilder

Constructs a fluent builder for the ListVirtualInterfaceTestHistory operation.

• The fluent builder is configurable:
  • test_id(impl Into<String>) / set_test_id(Option<String>):
    required: false
    

    The ID of the virtual interface failover test.

    
    
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: false
    

    The ID of the virtual interface that was tested.

    
    
  • bgp_peers(impl Into<String>) / set_bgp_peers(Option<Vec::<String>>):
    required: false
    

    The BGP peers that were placed in the DOWN state during the virtual interface failover test.

    
    
  • status(impl Into<String>) / set_status(Option<String>):
    required: false
    

    The status of the virtual interface failover test.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token for the next page of results.

    
    
• On success, responds with ListVirtualInterfaceTestHistoryOutput with field(s):
  • virtual_interface_test_history(Option<Vec::<VirtualInterfaceTestHistory>>):

    The ID of the tested virtual interface.

  • next_token(Option<String>):

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListVirtualInterfaceTestHistoryError>

impl Client

pub fn start_bgp_failover_test(&self) -> StartBgpFailoverTestFluentBuilder

Constructs a fluent builder for the StartBgpFailoverTest operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface you want to test.

    
    
  • bgp_peers(impl Into<String>) / set_bgp_peers(Option<Vec::<String>>):
    required: false
    

    The BGP peers to place in the DOWN state.

    
    
  • test_duration_in_minutes(i32) / set_test_duration_in_minutes(Option<i32>):
    required: false
    

    The time in minutes that the virtual interface failover test will last.

    Maximum value: 4,320 minutes (72 hours).

    Default: 180 minutes (3 hours).

    
    
• On success, responds with StartBgpFailoverTestOutput with field(s):
  • virtual_interface_test(Option<VirtualInterfaceTestHistory>):

    Information about the virtual interface failover test.

• On failure, responds with SdkError<StartBgpFailoverTestError>

impl Client

pub fn stop_bgp_failover_test(&self) -> StopBgpFailoverTestFluentBuilder

Constructs a fluent builder for the StopBgpFailoverTest operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual interface you no longer want to test.

    
    
• On success, responds with StopBgpFailoverTestOutput with field(s):
  • virtual_interface_test(Option<VirtualInterfaceTestHistory>):

    Information about the virtual interface failover test.

• On failure, responds with SdkError<StopBgpFailoverTestError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The tags to add.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys of the tags to remove.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_connection(&self) -> UpdateConnectionFluentBuilder

Constructs a fluent builder for the UpdateConnection operation.

• The fluent builder is configurable:
  • connection_id(impl Into<String>) / set_connection_id(Option<String>):
    required: true
    

    The ID of the dedicated connection.

    You can use DescribeConnections to retrieve the connection ID.

    
    
  • connection_name(impl Into<String>) / set_connection_name(Option<String>):
    required: false
    

    The name of the connection.

    
    
  • encryption_mode(impl Into<String>) / set_encryption_mode(Option<String>):
    required: false
    

    The connection MAC Security (MACsec) encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

    
    
• On success, responds with UpdateConnectionOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • connection_name(Option<String>):

    The name of the connection.

  • connection_state(Option<ConnectionState>):

    The state of the connection. The following are the possible values:

    • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

    • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

    • pending: The connection has been approved and is being initialized.

    • available: The network link is up and the connection is ready for use.

    • down: The network link is down.

    • deleting: The connection is being deleted.

    • deleted: The connection has been deleted.

    • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

    • unknown: The state of the connection is not available.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • location(Option<String>):

    The location of the connection.

  • bandwidth(Option<String>):

    The bandwidth of the connection.

  • vlan(i32):

    The ID of the VLAN.

  • partner_name(Option<String>):

    The name of the Direct Connect service provider associated with the connection.

  • loa_issue_time(Option<DateTime>):

    The time of the most recent call to DescribeLoa for this connection.

  • lag_id(Option<String>):

    The ID of the LAG.

  • aws_device(Option<String>):

    The Direct Connect endpoint on which the physical connection terminates.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the connection.

  • provider_name(Option<String>):

    The name of the service provider associated with the connection.

  • mac_sec_capable(Option<bool>):

    Indicates whether the connection supports MAC Security (MACsec).

  • port_encryption_status(Option<String>):

    The MAC Security (MACsec) port link status of the connection.

    The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

  • encryption_mode(Option<String>):

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the connection.

• On failure, responds with SdkError<UpdateConnectionError>

impl Client

pub fn update_direct_connect_gateway( &self, ) -> UpdateDirectConnectGatewayFluentBuilder

Constructs a fluent builder for the UpdateDirectConnectGateway operation.

• The fluent builder is configurable:
  • direct_connect_gateway_id(impl Into<String>) / set_direct_connect_gateway_id(Option<String>):
    required: true
    

    The ID of the Direct Connect gateway to update.

    
    
  • new_direct_connect_gateway_name(impl Into<String>) / set_new_direct_connect_gateway_name(Option<String>):
    required: true
    

    The new name for the Direct Connect gateway.

    
    
• On success, responds with UpdateDirectConnectGatewayOutput with field(s):
  • direct_connect_gateway(Option<DirectConnectGateway>):

    Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways or transit gateways.

• On failure, responds with SdkError<UpdateDirectConnectGatewayError>

impl Client

pub fn update_direct_connect_gateway_association( &self, ) -> UpdateDirectConnectGatewayAssociationFluentBuilder

Constructs a fluent builder for the UpdateDirectConnectGatewayAssociation operation.

• The fluent builder is configurable:
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: false
    

    The ID of the Direct Connect gateway association.

    
    
  • add_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_add_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    The Amazon VPC prefixes to advertise to the Direct Connect gateway.

    
    
  • remove_allowed_prefixes_to_direct_connect_gateway(RouteFilterPrefix) / set_remove_allowed_prefixes_to_direct_connect_gateway(Option<Vec::<RouteFilterPrefix>>):
    required: false
    

    The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

    
    
• On success, responds with UpdateDirectConnectGatewayAssociationOutput with field(s):
  • direct_connect_gateway_association(Option<DirectConnectGatewayAssociation>):

    Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

• On failure, responds with SdkError<UpdateDirectConnectGatewayAssociationError>

impl Client

pub fn update_lag(&self) -> UpdateLagFluentBuilder

Constructs a fluent builder for the UpdateLag operation.

• The fluent builder is configurable:
  • lag_id(impl Into<String>) / set_lag_id(Option<String>):
    required: true
    

    The ID of the LAG.

    
    
  • lag_name(impl Into<String>) / set_lag_name(Option<String>):
    required: false
    

    The name of the LAG.

    
    
  • minimum_links(i32) / set_minimum_links(Option<i32>):
    required: false
    

    The minimum number of physical connections that must be operational for the LAG itself to be operational.

    
    
  • encryption_mode(impl Into<String>) / set_encryption_mode(Option<String>):
    required: false
    

    The LAG MAC Security (MACsec) encryption mode.

    Amazon Web Services applies the value to all connections which are part of the LAG.

    
    
• On success, responds with UpdateLagOutput with field(s):
  • connections_bandwidth(Option<String>):

    The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

  • number_of_connections(i32):

    The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

  • lag_id(Option<String>):

    The ID of the LAG.

  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the LAG.

  • lag_name(Option<String>):

    The name of the LAG.

  • lag_state(Option<LagState>):

    The state of the LAG. The following are the possible values:

    • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

    • pending: The LAG has been approved and is being initialized.

    • available: The network link is established and the LAG is ready for use.

    • down: The network link is down.

    • deleting: The LAG is being deleted.

    • deleted: The LAG is deleted.

    • unknown: The state of the LAG is not available.

  • location(Option<String>):

    The location of the LAG.

  • region(Option<String>):

    The Amazon Web Services Region where the connection is located.

  • minimum_links(i32):

    The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

  • aws_device(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that hosts the LAG.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • connections(Option<Vec::<Connection>>):

    The connections bundled by the LAG.

  • allows_hosted_connections(bool):

    Indicates whether the LAG can host other connections.

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • has_logical_redundancy(Option<HasLogicalRedundancy>):

    Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

  • tags(Option<Vec::<Tag>>):

    The tags associated with the LAG.

  • provider_name(Option<String>):

    The name of the service provider associated with the LAG.

  • mac_sec_capable(Option<bool>):

    Indicates whether the LAG supports MAC Security (MACsec).

  • encryption_mode(Option<String>):

    The LAG MAC Security (MACsec) encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • mac_sec_keys(Option<Vec::<MacSecKey>>):

    The MAC Security (MACsec) security keys associated with the LAG.

• On failure, responds with SdkError<UpdateLagError>

impl Client

pub fn update_virtual_interface_attributes( &self, ) -> UpdateVirtualInterfaceAttributesFluentBuilder

Constructs a fluent builder for the UpdateVirtualInterfaceAttributes operation.

• The fluent builder is configurable:
  • virtual_interface_id(impl Into<String>) / set_virtual_interface_id(Option<String>):
    required: true
    

    The ID of the virtual private interface.

    
    
  • mtu(i32) / set_mtu(Option<i32>):
    required: false
    

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

    
    
  • enable_site_link(bool) / set_enable_site_link(Option<bool>):
    required: false
    

    Indicates whether to enable or disable SiteLink.

    
    
  • virtual_interface_name(impl Into<String>) / set_virtual_interface_name(Option<String>):
    required: false
    

    The name of the virtual private interface.

    
    
• On success, responds with UpdateVirtualInterfaceAttributesOutput with field(s):
  • owner_account(Option<String>):

    The ID of the Amazon Web Services account that owns the virtual interface.

  • virtual_interface_id(Option<String>):

    The ID of the virtual interface.

  • location(Option<String>):

    The location of the connection.

  • connection_id(Option<String>):

    The ID of the connection.

  • virtual_interface_type(Option<String>):

    The type of virtual interface. The possible values are private, public and transit.

  • virtual_interface_name(Option<String>):

    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

  • vlan(i32):

    The ID of the VLAN.

  • asn(i32):

    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

    The valid values are 1-2147483647.

  • amazon_side_asn(Option<i64>):

    The autonomous system number (ASN) for the Amazon side of the connection.

  • auth_key(Option<String>):

    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

  • amazon_address(Option<String>):

    The IP address assigned to the Amazon interface.

  • customer_address(Option<String>):

    The IP address assigned to the customer interface.

  • address_family(Option<AddressFamily>):

    The address family for the BGP peer.

  • virtual_interface_state(Option<VirtualInterfaceState>):

    The state of the virtual interface. The following are the possible values:

    • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

    • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

    • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

    • available: A virtual interface that is able to forward traffic.

    • down: A virtual interface that is BGP down.

    • testing: A virtual interface is in this state immediately after calling StartBgpFailoverTest and remains in this state during the duration of the test.

    • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

    • deleted: A virtual interface that cannot forward traffic.

    • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

    • unknown: The state of the virtual interface is not available.

  • customer_router_config(Option<String>):

    The customer router configuration.

  • mtu(Option<i32>):

    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

  • jumbo_frame_capable(Option<bool>):

    Indicates whether jumbo frames are supported.

  • virtual_gateway_id(Option<String>):

    The ID of the virtual private gateway. Applies only to private virtual interfaces.

  • direct_connect_gateway_id(Option<String>):

    The ID of the Direct Connect gateway.

  • route_filter_prefixes(Option<Vec::<RouteFilterPrefix>>):

    The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

  • bgp_peers(Option<Vec::<BgpPeer>>):

    The BGP peers configured on this virtual interface.

  • region(Option<String>):

    The Amazon Web Services Region where the virtual interface is located.

  • aws_device_v2(Option<String>):

    The Direct Connect endpoint that terminates the physical connection.

  • aws_logical_device_id(Option<String>):

    The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

  • tags(Option<Vec::<Tag>>):

    The tags associated with the virtual interface.

  • site_link_enabled(Option<bool>):

    Indicates whether SiteLink is enabled.

• On failure, responds with SdkError<UpdateVirtualInterfaceAttributesError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.