pub struct Client { /* private fields */ }
Expand description

Client for AWS Global Accelerator

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

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_globalaccelerator::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_globalaccelerator::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_globalaccelerator::Client::from_conf(config);

Implementations

Creates a client with the given service configuration.

Returns the client’s configuration.

Constructs a fluent builder for the AddCustomRoutingEndpoints operation.

Constructs a fluent builder for the AdvertiseByoipCidr operation.

Constructs a fluent builder for the AllowCustomRoutingTraffic operation.

Constructs a fluent builder for the CreateAccelerator operation.

Constructs a fluent builder for the CreateCustomRoutingAccelerator operation.

Constructs a fluent builder for the CreateCustomRoutingEndpointGroup operation.

Constructs a fluent builder for the CreateCustomRoutingListener operation.

Constructs a fluent builder for the CreateEndpointGroup operation.

Constructs a fluent builder for the CreateListener operation.

  • The fluent builder is configurable:
    • accelerator_arn(impl Into<String>) / set_accelerator_arn(Option<String>):

      The Amazon Resource Name (ARN) of your accelerator.

    • port_ranges(Vec<PortRange>) / set_port_ranges(Option<Vec<PortRange>>):

      The list of port ranges to support for connections from clients to your accelerator.

    • protocol(Protocol) / set_protocol(Option<Protocol>):

      The protocol for connections from clients to your accelerator.

    • client_affinity(ClientAffinity) / set_client_affinity(Option<ClientAffinity>):

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

      AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the “five-tuple” (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the “two-tuple” (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.

    • idempotency_token(impl Into<String>) / set_idempotency_token(Option<String>):

      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

  • On success, responds with CreateListenerOutput with field(s):
  • On failure, responds with SdkError<CreateListenerError>

Constructs a fluent builder for the DeleteAccelerator operation.

Constructs a fluent builder for the DeleteCustomRoutingAccelerator operation.

Constructs a fluent builder for the DeleteCustomRoutingEndpointGroup operation.

Constructs a fluent builder for the DeleteCustomRoutingListener operation.

Constructs a fluent builder for the DeleteEndpointGroup operation.

Constructs a fluent builder for the DeleteListener operation.

Constructs a fluent builder for the DenyCustomRoutingTraffic operation.

Constructs a fluent builder for the DeprovisionByoipCidr operation.

Constructs a fluent builder for the DescribeAccelerator operation.

Constructs a fluent builder for the DescribeAcceleratorAttributes operation.

Constructs a fluent builder for the DescribeCustomRoutingAccelerator operation.

Constructs a fluent builder for the DescribeCustomRoutingAcceleratorAttributes operation.

Constructs a fluent builder for the DescribeCustomRoutingEndpointGroup operation.

Constructs a fluent builder for the DescribeCustomRoutingListener operation.

Constructs a fluent builder for the DescribeEndpointGroup operation.

Constructs a fluent builder for the DescribeListener operation.

Constructs a fluent builder for the ListAccelerators operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListByoipCidrs operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCustomRoutingAccelerators operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCustomRoutingEndpointGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCustomRoutingListeners operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCustomRoutingPortMappings operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListCustomRoutingPortMappingsByDestination operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListEndpointGroups operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListListeners operation. This operation supports pagination; See into_paginator().

Constructs a fluent builder for the ListTagsForResource operation.

Constructs a fluent builder for the ProvisionByoipCidr operation.

Constructs a fluent builder for the RemoveCustomRoutingEndpoints operation.

Constructs a fluent builder for the TagResource operation.

Constructs a fluent builder for the UntagResource operation.

Constructs a fluent builder for the UpdateAccelerator operation.

Constructs a fluent builder for the UpdateAcceleratorAttributes operation.

Constructs a fluent builder for the UpdateCustomRoutingAccelerator operation.

Constructs a fluent builder for the UpdateCustomRoutingAcceleratorAttributes operation.

Constructs a fluent builder for the UpdateCustomRoutingListener operation.

Constructs a fluent builder for the UpdateEndpointGroup operation.

Constructs a fluent builder for the UpdateListener operation.

  • The fluent builder is configurable:
    • listener_arn(impl Into<String>) / set_listener_arn(Option<String>):

      The Amazon Resource Name (ARN) of the listener to update.

    • port_ranges(Vec<PortRange>) / set_port_ranges(Option<Vec<PortRange>>):

      The updated list of port ranges for the connections from clients to the accelerator.

    • protocol(Protocol) / set_protocol(Option<Protocol>):

      The updated protocol for the connections from clients to the accelerator.

    • client_affinity(ClientAffinity) / set_client_affinity(Option<ClientAffinity>):

      Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

      AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the “five-tuple” (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

      If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the “two-tuple” (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

      The default value is NONE.

  • On success, responds with UpdateListenerOutput with field(s):
  • On failure, responds with SdkError<UpdateListenerError>

Constructs a fluent builder for the WithdrawByoipCidr operation.

Creates a client with the given service config and connector override.

Creates a new client from a shared config.

Creates a new client from the service Config.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more