Struct aws_sdk_globalaccelerator::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* 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
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the AddCustomRoutingEndpoints
operation.
- The fluent builder is configurable:
endpoint_configurations(Vec<CustomRoutingEndpointConfiguration>)
/set_endpoint_configurations(Option<Vec<CustomRoutingEndpointConfiguration>>)
:The list of endpoint objects to add to a custom routing accelerator.
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
- On success, responds with
AddCustomRoutingEndpointsOutput
with field(s):endpoint_descriptions(Option<Vec<CustomRoutingEndpointDescription>>)
:The endpoint objects added to the custom routing accelerator.
endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.
- On failure, responds with
SdkError<AddCustomRoutingEndpointsError>
Constructs a fluent builder for the AdvertiseByoipCidr
operation.
- The fluent builder is configurable:
cidr(impl Into<String>)
/set_cidr(Option<String>)
:The address range, in CIDR notation. This must be the exact range that you provisioned. You can’t advertise only a portion of the provisioned range.
- On success, responds with
AdvertiseByoipCidrOutput
with field(s):byoip_cidr(Option<ByoipCidr>)
:Information about the address range.
- On failure, responds with
SdkError<AdvertiseByoipCidrError>
Constructs a fluent builder for the AllowCustomRoutingTraffic
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group.
endpoint_id(impl Into<String>)
/set_endpoint_id(Option<String>)
:An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
destination_addresses(Vec<String>)
/set_destination_addresses(Option<Vec<String>>)
:A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to allow to receive traffic. The IP addresses must be a subset of the IP addresses that you specified for the endpoint group.
DestinationAddresses
is required ifAllowAllTrafficToEndpoint
isFALSE
or is not specified.destination_ports(Vec<i32>)
/set_destination_ports(Option<Vec<i32>>)
:A list of specific Amazon EC2 instance ports (destination ports) that you want to allow to receive traffic.
allow_all_traffic_to_endpoint(bool)
/set_allow_all_traffic_to_endpoint(Option<bool>)
:Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint can receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, all destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that are allowed to receive traffic. A list of ports is optional. If you don’t specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
- On success, responds with
AllowCustomRoutingTrafficOutput
- On failure, responds with
SdkError<AllowCustomRoutingTrafficError>
Constructs a fluent builder for the CreateAccelerator
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The value for the address type must be IPv4.
ip_addresses(Vec<String>)
/set_ip_addresses(Option<Vec<String>>)
:Optionally, if you’ve added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator’s static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.
Note that you can’t update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
enabled(bool)
/set_enabled(Option<bool>)
:Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
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 an accelerator.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Create tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
- On success, responds with
CreateAcceleratorOutput
with field(s):accelerator(Option<Accelerator>)
:The accelerator that is created by specifying a listener and the supported IP address types.
- On failure, responds with
SdkError<CreateAcceleratorError>
Constructs a fluent builder for the CreateCustomRoutingAccelerator
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of a custom routing accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The value for the address type must be IPv4.
ip_addresses(Vec<String>)
/set_ip_addresses(Option<Vec<String>>)
:Optionally, if you’ve added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator’s static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.
Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.
Note that you can’t update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.
For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide.
enabled(bool)
/set_enabled(Option<bool>)
:Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
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.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:Create tags for an accelerator.
For more information, see Tagging in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
- On success, responds with
CreateCustomRoutingAcceleratorOutput
with field(s):accelerator(Option<CustomRoutingAccelerator>)
:The accelerator that is created.
- On failure, responds with
SdkError<CreateCustomRoutingAcceleratorError>
pub fn create_custom_routing_endpoint_group(
&self
) -> CreateCustomRoutingEndpointGroup<C, M, R>
pub fn create_custom_routing_endpoint_group(
&self
) -> CreateCustomRoutingEndpointGroup<C, M, R>
Constructs a fluent builder for the CreateCustomRoutingEndpointGroup
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
endpoint_group_region(impl Into<String>)
/set_endpoint_group_region(Option<String>)
:The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
destination_configurations(Vec<CustomRoutingDestinationConfiguration>)
/set_destination_configurations(Option<Vec<CustomRoutingDestinationConfiguration>>)
:Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
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
CreateCustomRoutingEndpointGroupOutput
with field(s):endpoint_group(Option<CustomRoutingEndpointGroup>)
:The information about the endpoint group created for a custom routing accelerator.
- On failure, responds with
SdkError<CreateCustomRoutingEndpointGroupError>
Constructs a fluent builder for the CreateCustomRoutingListener
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
port_ranges(Vec<PortRange>)
/set_port_ranges(Option<Vec<PortRange>>)
:The port range to support for connections from clients to your accelerator.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
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
CreateCustomRoutingListenerOutput
with field(s):listener(Option<CustomRoutingListener>)
:The listener that you’ve created for a custom routing accelerator.
- On failure, responds with
SdkError<CreateCustomRoutingListenerError>
Constructs a fluent builder for the CreateEndpointGroup
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
endpoint_group_region(impl Into<String>)
/set_endpoint_group_region(Option<String>)
:The AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
endpoint_configurations(Vec<EndpointConfiguration>)
/set_endpoint_configurations(Option<Vec<EndpointConfiguration>>)
:The list of endpoint objects.
traffic_dial_percentage(f32)
/set_traffic_dial_percentage(Option<f32>)
:The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
health_check_port(i32)
/set_health_check_port(Option<i32>)
:The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.
health_check_protocol(HealthCheckProtocol)
/set_health_check_protocol(Option<HealthCheckProtocol>)
:The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
health_check_path(impl Into<String>)
/set_health_check_path(Option<String>)
:If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
health_check_interval_seconds(i32)
/set_health_check_interval_seconds(Option<i32>)
:The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
threshold_count(i32)
/set_threshold_count(Option<i32>)
:The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
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.
port_overrides(Vec<PortOverride>)
/set_port_overrides(Option<Vec<PortOverride>>)
:Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
- On success, responds with
CreateEndpointGroupOutput
with field(s):endpoint_group(Option<EndpointGroup>)
:The information about the endpoint group that was created.
- On failure, responds with
SdkError<CreateEndpointGroupError>
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 theSOURCE_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):listener(Option<Listener>)
:The listener that you’ve created.
- On failure, responds with
SdkError<CreateListenerError>
Constructs a fluent builder for the DeleteAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of an accelerator.
- On success, responds with
DeleteAcceleratorOutput
- On failure, responds with
SdkError<DeleteAcceleratorError>
Constructs a fluent builder for the DeleteCustomRoutingAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the custom routing accelerator to delete.
- On success, responds with
DeleteCustomRoutingAcceleratorOutput
- On failure, responds with
SdkError<DeleteCustomRoutingAcceleratorError>
pub fn delete_custom_routing_endpoint_group(
&self
) -> DeleteCustomRoutingEndpointGroup<C, M, R>
pub fn delete_custom_routing_endpoint_group(
&self
) -> DeleteCustomRoutingEndpointGroup<C, M, R>
Constructs a fluent builder for the DeleteCustomRoutingEndpointGroup
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to delete.
- On success, responds with
DeleteCustomRoutingEndpointGroupOutput
- On failure, responds with
SdkError<DeleteCustomRoutingEndpointGroupError>
Constructs a fluent builder for the DeleteCustomRoutingListener
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 delete.
- On success, responds with
DeleteCustomRoutingListenerOutput
- On failure, responds with
SdkError<DeleteCustomRoutingListenerError>
Constructs a fluent builder for the DeleteEndpointGroup
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to delete.
- On success, responds with
DeleteEndpointGroupOutput
- On failure, responds with
SdkError<DeleteEndpointGroupError>
Constructs a fluent builder for the DeleteListener
operation.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
- On success, responds with
DeleteListenerOutput
- On failure, responds with
SdkError<DeleteListenerError>
Constructs a fluent builder for the DenyCustomRoutingTraffic
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group.
endpoint_id(impl Into<String>)
/set_endpoint_id(Option<String>)
:An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
destination_addresses(Vec<String>)
/set_destination_addresses(Option<Vec<String>>)
:A list of specific Amazon EC2 instance IP addresses (destination addresses) in a subnet that you want to prevent from receiving traffic. The IP addresses must be a subset of the IP addresses allowed for the VPC subnet associated with the endpoint group.
destination_ports(Vec<i32>)
/set_destination_ports(Option<Vec<i32>>)
:A list of specific Amazon EC2 instance ports (destination ports) in a subnet endpoint that you want to prevent from receiving traffic.
deny_all_traffic_to_endpoint(bool)
/set_deny_all_traffic_to_endpoint(Option<bool>)
:Indicates whether all destination IP addresses and ports for a specified VPC subnet endpoint cannot receive traffic from a custom routing accelerator. The value is TRUE or FALSE.
When set to TRUE, no destinations in the custom routing VPC subnet can receive traffic. Note that you cannot specify destination IP addresses and ports when the value is set to TRUE.
When set to FALSE (or not specified), you must specify a list of destination IP addresses that cannot receive traffic. A list of ports is optional. If you don’t specify a list of ports, the ports that can accept traffic is the same as the ports configured for the endpoint group.
The default value is FALSE.
- On success, responds with
DenyCustomRoutingTrafficOutput
- On failure, responds with
SdkError<DenyCustomRoutingTrafficError>
Constructs a fluent builder for the DeprovisionByoipCidr
operation.
- The fluent builder is configurable:
cidr(impl Into<String>)
/set_cidr(Option<String>)
:The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.
- On success, responds with
DeprovisionByoipCidrOutput
with field(s):byoip_cidr(Option<ByoipCidr>)
:Information about the address range.
- On failure, responds with
SdkError<DeprovisionByoipCidrError>
Constructs a fluent builder for the DescribeAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to describe.
- On success, responds with
DescribeAcceleratorOutput
with field(s):accelerator(Option<Accelerator>)
:The description of the accelerator.
- On failure, responds with
SdkError<DescribeAcceleratorError>
Constructs a fluent builder for the DescribeAcceleratorAttributes
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
- On success, responds with
DescribeAcceleratorAttributesOutput
with field(s):accelerator_attributes(Option<AcceleratorAttributes>)
:The attributes of the accelerator.
- On failure, responds with
SdkError<DescribeAcceleratorAttributesError>
pub fn describe_custom_routing_accelerator(
&self
) -> DescribeCustomRoutingAccelerator<C, M, R>
pub fn describe_custom_routing_accelerator(
&self
) -> DescribeCustomRoutingAccelerator<C, M, R>
Constructs a fluent builder for the DescribeCustomRoutingAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to describe.
- On success, responds with
DescribeCustomRoutingAcceleratorOutput
with field(s):accelerator(Option<CustomRoutingAccelerator>)
:The description of the custom routing accelerator.
- On failure, responds with
SdkError<DescribeCustomRoutingAcceleratorError>
pub fn describe_custom_routing_accelerator_attributes(
&self
) -> DescribeCustomRoutingAcceleratorAttributes<C, M, R>
pub fn describe_custom_routing_accelerator_attributes(
&self
) -> DescribeCustomRoutingAcceleratorAttributes<C, M, R>
Constructs a fluent builder for the DescribeCustomRoutingAcceleratorAttributes
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the custom routing accelerator to describe the attributes for.
- On success, responds with
DescribeCustomRoutingAcceleratorAttributesOutput
with field(s):accelerator_attributes(Option<CustomRoutingAcceleratorAttributes>)
:The attributes of the custom routing accelerator.
- On failure, responds with
SdkError<DescribeCustomRoutingAcceleratorAttributesError>
pub fn describe_custom_routing_endpoint_group(
&self
) -> DescribeCustomRoutingEndpointGroup<C, M, R>
pub fn describe_custom_routing_endpoint_group(
&self
) -> DescribeCustomRoutingEndpointGroup<C, M, R>
Constructs a fluent builder for the DescribeCustomRoutingEndpointGroup
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to describe.
- On success, responds with
DescribeCustomRoutingEndpointGroupOutput
with field(s):endpoint_group(Option<CustomRoutingEndpointGroup>)
:The description of an endpoint group for a custom routing accelerator.
- On failure, responds with
SdkError<DescribeCustomRoutingEndpointGroupError>
Constructs a fluent builder for the DescribeCustomRoutingListener
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 describe.
- On success, responds with
DescribeCustomRoutingListenerOutput
with field(s):listener(Option<CustomRoutingListener>)
:The description of a listener for a custom routing accelerator.
- On failure, responds with
SdkError<DescribeCustomRoutingListenerError>
Constructs a fluent builder for the DescribeEndpointGroup
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to describe.
- On success, responds with
DescribeEndpointGroupOutput
with field(s):endpoint_group(Option<EndpointGroup>)
:The description of an endpoint group.
- On failure, responds with
SdkError<DescribeEndpointGroupError>
Constructs a fluent builder for the DescribeListener
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 describe.
- On success, responds with
DescribeListenerOutput
with field(s):listener(Option<Listener>)
:The description of a listener.
- On failure, responds with
SdkError<DescribeListenerError>
Constructs a fluent builder for the ListAccelerators
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:The number of Global Accelerator objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListAcceleratorsOutput
with field(s):accelerators(Option<Vec<Accelerator>>)
:The list of accelerators for a customer account.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListAcceleratorsError>
Constructs a fluent builder for the ListByoipCidrs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next page of results.
- On success, responds with
ListByoipCidrsOutput
with field(s):byoip_cidrs(Option<Vec<ByoipCidr>>)
:Information about your address ranges.
next_token(Option<String>)
:The token for the next page of results.
- On failure, responds with
SdkError<ListByoipCidrsError>
Constructs a fluent builder for the ListCustomRoutingAccelerators
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:The number of custom routing Global Accelerator objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListCustomRoutingAcceleratorsOutput
with field(s):accelerators(Option<Vec<CustomRoutingAccelerator>>)
:The list of custom routing accelerators for a customer account.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListCustomRoutingAcceleratorsError>
pub fn list_custom_routing_endpoint_groups(
&self
) -> ListCustomRoutingEndpointGroups<C, M, R>
pub fn list_custom_routing_endpoint_groups(
&self
) -> ListCustomRoutingEndpointGroups<C, M, R>
Constructs a fluent builder for the ListCustomRoutingEndpointGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
max_results(i32)
/set_max_results(Option<i32>)
:The number of endpoint group objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListCustomRoutingEndpointGroupsOutput
with field(s):endpoint_groups(Option<Vec<CustomRoutingEndpointGroup>>)
:The list of the endpoint groups associated with a listener for a custom routing accelerator.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListCustomRoutingEndpointGroupsError>
Constructs a fluent builder for the ListCustomRoutingListeners
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to list listeners for.
max_results(i32)
/set_max_results(Option<i32>)
:The number of listener objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListCustomRoutingListenersOutput
with field(s):listeners(Option<Vec<CustomRoutingListener>>)
:The list of listeners for a custom routing accelerator.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListCustomRoutingListenersError>
Constructs a fluent builder for the ListCustomRoutingPortMappings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to list the custom routing port mappings for.
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to list the custom routing port mappings for.
max_results(i32)
/set_max_results(Option<i32>)
:The number of destination port mappings that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListCustomRoutingPortMappingsOutput
with field(s):port_mappings(Option<Vec<PortMapping>>)
:The port mappings for a custom routing accelerator.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListCustomRoutingPortMappingsError>
pub fn list_custom_routing_port_mappings_by_destination(
&self
) -> ListCustomRoutingPortMappingsByDestination<C, M, R>
pub fn list_custom_routing_port_mappings_by_destination(
&self
) -> ListCustomRoutingPortMappingsByDestination<C, M, R>
Constructs a fluent builder for the ListCustomRoutingPortMappingsByDestination
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
endpoint_id(impl Into<String>)
/set_endpoint_id(Option<String>)
:The ID for the virtual private cloud (VPC) subnet.
destination_address(impl Into<String>)
/set_destination_address(Option<String>)
:The endpoint IP address in a virtual private cloud (VPC) subnet for which you want to receive back port mappings.
max_results(i32)
/set_max_results(Option<i32>)
:The number of destination port mappings that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListCustomRoutingPortMappingsByDestinationOutput
with field(s):destination_port_mappings(Option<Vec<DestinationPortMapping>>)
:The port mappings for the endpoint IP address that you specified in the request.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListCustomRoutingPortMappingsByDestinationError>
Constructs a fluent builder for the ListEndpointGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
listener_arn(impl Into<String>)
/set_listener_arn(Option<String>)
:The Amazon Resource Name (ARN) of the listener.
max_results(i32)
/set_max_results(Option<i32>)
:The number of endpoint group objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListEndpointGroupsOutput
with field(s):endpoint_groups(Option<Vec<EndpointGroup>>)
:The list of the endpoint groups associated with a listener.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListEndpointGroupsError>
Constructs a fluent builder for the ListListeners
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
max_results(i32)
/set_max_results(Option<i32>)
:The number of listener objects that you want to return with this call. The default value is 10.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On success, responds with
ListListenersOutput
with field(s):listeners(Option<Vec<Listener>>)
:The list of listeners for an accelerator.
next_token(Option<String>)
:The token for the next set of results. You receive this token from a previous call.
- On failure, responds with
SdkError<ListListenersError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN uniquely identifies an accelerator.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec<Tag>>)
:Root level tag for the Tags parameters.
- On failure, responds with
SdkError<ListTagsForResourceError>
Constructs a fluent builder for the ProvisionByoipCidr
operation.
- The fluent builder is configurable:
cidr(impl Into<String>)
/set_cidr(Option<String>)
:The public IPv4 address range, in CIDR notation. The most specific IP prefix that you can specify is /24. The address range cannot overlap with another address range that you’ve brought to this or another Region.
cidr_authorization_context(CidrAuthorizationContext)
/set_cidr_authorization_context(Option<CidrAuthorizationContext>)
:A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
- On success, responds with
ProvisionByoipCidrOutput
with field(s):byoip_cidr(Option<ByoipCidr>)
:Information about the address range.
- On failure, responds with
SdkError<ProvisionByoipCidrError>
Constructs a fluent builder for the RemoveCustomRoutingEndpoints
operation.
- The fluent builder is configurable:
endpoint_ids(Vec<String>)
/set_endpoint_ids(Option<Vec<String>>)
:The IDs for the endpoints. For custom routing accelerators, endpoint IDs are the virtual private cloud (VPC) subnet IDs.
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
- On success, responds with
RemoveCustomRoutingEndpointsOutput
- On failure, responds with
SdkError<RemoveCustomRoutingEndpointsError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags to. An ARN uniquely identifies a resource.
tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
:The tags to add to a resource. A tag consists of a key and a value that you define.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the Global Accelerator resource to remove tags from. An ARN uniquely identifies a resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag key pairs that you want to remove from the specified resources.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to update.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The IP address type, which must be IPv4.
enabled(bool)
/set_enabled(Option<bool>)
:Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
- On success, responds with
UpdateAcceleratorOutput
with field(s):accelerator(Option<Accelerator>)
:Information about the updated accelerator.
- On failure, responds with
SdkError<UpdateAcceleratorError>
Constructs a fluent builder for the UpdateAcceleratorAttributes
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator that you want to update.
flow_logs_enabled(bool)
/set_flow_logs_enabled(Option<bool>)
:Update whether flow logs are enabled. The default value is false. If the value is true,
FlowLogsS3Bucket
andFlowLogsS3Prefix
must be specified.For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.
flow_logs_s3_bucket(impl Into<String>)
/set_flow_logs_s3_bucket(Option<String>)
:The name of the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled
istrue
. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.flow_logs_s3_prefix(impl Into<String>)
/set_flow_logs_s3_prefix(Option<String>)
:Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled
istrue
.If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
s3-bucket_name//AWSLogs/aws_account_id
- On success, responds with
UpdateAcceleratorAttributesOutput
with field(s):accelerator_attributes(Option<AcceleratorAttributes>)
:Updated attributes for the accelerator.
- On failure, responds with
SdkError<UpdateAcceleratorAttributesError>
Constructs a fluent builder for the UpdateCustomRoutingAccelerator
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the accelerator to update.
name(impl Into<String>)
/set_name(Option<String>)
:The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.
ip_address_type(IpAddressType)
/set_ip_address_type(Option<IpAddressType>)
:The value for the address type must be IPv4.
enabled(bool)
/set_enabled(Option<bool>)
:Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
- On success, responds with
UpdateCustomRoutingAcceleratorOutput
with field(s):accelerator(Option<CustomRoutingAccelerator>)
:Information about the updated custom routing accelerator.
- On failure, responds with
SdkError<UpdateCustomRoutingAcceleratorError>
pub fn update_custom_routing_accelerator_attributes(
&self
) -> UpdateCustomRoutingAcceleratorAttributes<C, M, R>
pub fn update_custom_routing_accelerator_attributes(
&self
) -> UpdateCustomRoutingAcceleratorAttributes<C, M, R>
Constructs a fluent builder for the UpdateCustomRoutingAcceleratorAttributes
operation.
- The fluent builder is configurable:
accelerator_arn(impl Into<String>)
/set_accelerator_arn(Option<String>)
:The Amazon Resource Name (ARN) of the custom routing accelerator to update attributes for.
flow_logs_enabled(bool)
/set_flow_logs_enabled(Option<bool>)
:Update whether flow logs are enabled. The default value is false. If the value is true,
FlowLogsS3Bucket
andFlowLogsS3Prefix
must be specified.For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.
flow_logs_s3_bucket(impl Into<String>)
/set_flow_logs_s3_bucket(Option<String>)
:The name of the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled
istrue
. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.flow_logs_s3_prefix(impl Into<String>)
/set_flow_logs_s3_prefix(Option<String>)
:Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
FlowLogsEnabled
istrue
.If you don’t specify a prefix, the flow logs are stored in the root of the bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:
DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
- On success, responds with
UpdateCustomRoutingAcceleratorAttributesOutput
with field(s):accelerator_attributes(Option<CustomRoutingAcceleratorAttributes>)
:Updated custom routing accelerator.
- On failure, responds with
SdkError<UpdateCustomRoutingAcceleratorAttributesError>
Constructs a fluent builder for the UpdateCustomRoutingListener
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 port range to support for connections from clients to your accelerator. If you remove ports that are currently being used by a subnet endpoint, the call fails.
Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
- On success, responds with
UpdateCustomRoutingListenerOutput
with field(s):listener(Option<CustomRoutingListener>)
:Information for the updated listener for a custom routing accelerator.
- On failure, responds with
SdkError<UpdateCustomRoutingListenerError>
Constructs a fluent builder for the UpdateEndpointGroup
operation.
- The fluent builder is configurable:
endpoint_group_arn(impl Into<String>)
/set_endpoint_group_arn(Option<String>)
:The Amazon Resource Name (ARN) of the endpoint group.
endpoint_configurations(Vec<EndpointConfiguration>)
/set_endpoint_configurations(Option<Vec<EndpointConfiguration>>)
:The list of endpoint objects. A resource must be valid and active when you add it as an endpoint.
traffic_dial_percentage(f32)
/set_traffic_dial_percentage(Option<f32>)
:The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.
Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
The default value is 100.
health_check_port(i32)
/set_health_check_port(Option<i32>)
:The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.
health_check_protocol(HealthCheckProtocol)
/set_health_check_protocol(Option<HealthCheckProtocol>)
:The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.
health_check_path(impl Into<String>)
/set_health_check_path(Option<String>)
:If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).
health_check_interval_seconds(i32)
/set_health_check_interval_seconds(Option<i32>)
:The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
threshold_count(i32)
/set_threshold_count(Option<i32>)
:The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
port_overrides(Vec<PortOverride>)
/set_port_overrides(Option<Vec<PortOverride>>)
:Override specific listener ports used to route traffic to endpoints that are part of this endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide.
- On success, responds with
UpdateEndpointGroupOutput
with field(s):endpoint_group(Option<EndpointGroup>)
:The information about the endpoint group that was updated.
- On failure, responds with
SdkError<UpdateEndpointGroupError>
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 theSOURCE_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):listener(Option<Listener>)
:Information for the updated listener.
- On failure, responds with
SdkError<UpdateListenerError>
Constructs a fluent builder for the WithdrawByoipCidr
operation.
- The fluent builder is configurable:
cidr(impl Into<String>)
/set_cidr(Option<String>)
:The address range, in CIDR notation.
- On success, responds with
WithdrawByoipCidrOutput
with field(s):byoip_cidr(Option<ByoipCidr>)
:Information about the address pool.
- On failure, responds with
SdkError<WithdrawByoipCidrError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
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