GlobalAccelerator class

This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.

Constructors

GlobalAccelerator({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addCustomRoutingEndpoints({required List<CustomRoutingEndpointConfiguration> endpointConfigurations, required String endpointGroupArn}) → Future<AddCustomRoutingEndpointsResponse>
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
advertiseByoipCidr({required String cidr}) → Future<AdvertiseByoipCidrResponse>
Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS because of propagation delays.
allowCustomRoutingTraffic({required String endpointGroupArn, required String endpointId, bool? allowAllTrafficToEndpoint, List<String>? destinationAddresses, List<int>? destinationPorts}) → Future<void>
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createAccelerator({required String name, bool? enabled, String? idempotencyToken, IpAddressType? ipAddressType, List<String>? ipAddresses, List<Tag>? tags}) → Future<CreateAcceleratorResponse>
Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers.
createCustomRoutingAccelerator({required String name, bool? enabled, String? idempotencyToken, IpAddressType? ipAddressType, List<Tag>? tags}) → Future<CreateCustomRoutingAcceleratorResponse>
Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.
createCustomRoutingEndpointGroup({required List<CustomRoutingDestinationConfiguration> destinationConfigurations, required String endpointGroupRegion, required String listenerArn, String? idempotencyToken}) → Future<CreateCustomRoutingEndpointGroupResponse>
Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one AWS Region.
createCustomRoutingListener({required String acceleratorArn, required List<PortRange> portRanges, String? idempotencyToken}) → Future<CreateCustomRoutingListenerResponse>
Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
createEndpointGroup({required String endpointGroupRegion, required String listenerArn, List<EndpointConfiguration>? endpointConfigurations, int? healthCheckIntervalSeconds, String? healthCheckPath, int? healthCheckPort, HealthCheckProtocol? healthCheckProtocol, String? idempotencyToken, List<PortOverride>? portOverrides, int? thresholdCount, double? trafficDialPercentage}) → Future<CreateEndpointGroupResponse>
Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. A resource must be valid and active when you add it as an endpoint.
createListener({required String acceleratorArn, required List<PortRange> portRanges, required Protocol protocol, ClientAffinity? clientAffinity, String? idempotencyToken}) → Future<CreateListenerResponse>
Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify.
deleteAccelerator({required String acceleratorArn}) → Future<void>
Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
deleteCustomRoutingAccelerator({required String acceleratorArn}) → Future<void>
Delete a custom routing accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
deleteCustomRoutingEndpointGroup({required String endpointGroupArn}) → Future<void>
Delete an endpoint group from a listener for a custom routing accelerator.
deleteCustomRoutingListener({required String listenerArn}) → Future<void>
Delete a listener for a custom routing accelerator.
deleteEndpointGroup({required String endpointGroupArn}) → Future<void>
Delete an endpoint group from a listener.
deleteListener({required String listenerArn}) → Future<void>
Delete a listener from an accelerator.
denyCustomRoutingTraffic({required String endpointGroupArn, required String endpointId, bool? denyAllTrafficToEndpoint, List<String>? destinationAddresses, List<int>? destinationPorts}) → Future<void>
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group.
deprovisionByoipCidr({required String cidr}) → Future<DeprovisionByoipCidrResponse>
Releases the specified address range that you provisioned to use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
describeAccelerator({required String acceleratorArn}) → Future<DescribeAcceleratorResponse>
Describe an accelerator.
describeAcceleratorAttributes({required String acceleratorArn}) → Future<DescribeAcceleratorAttributesResponse>
Describe the attributes of an accelerator.
describeCustomRoutingAccelerator({required String acceleratorArn}) → Future<DescribeCustomRoutingAcceleratorResponse>
Describe a custom routing accelerator.
describeCustomRoutingAcceleratorAttributes({required String acceleratorArn}) → Future<DescribeCustomRoutingAcceleratorAttributesResponse>
Describe the attributes of a custom routing accelerator.
describeCustomRoutingEndpointGroup({required String endpointGroupArn}) → Future<DescribeCustomRoutingEndpointGroupResponse>
Describe an endpoint group for a custom routing accelerator.
describeCustomRoutingListener({required String listenerArn}) → Future<DescribeCustomRoutingListenerResponse>
The description of a listener for a custom routing accelerator.
describeEndpointGroup({required String endpointGroupArn}) → Future<DescribeEndpointGroupResponse>
Describe an endpoint group.
describeListener({required String listenerArn}) → Future<DescribeListenerResponse>
Describe a listener.
listAccelerators({int? maxResults, String? nextToken}) → Future<ListAcceleratorsResponse>
List the accelerators for an AWS account.
listByoipCidrs({int? maxResults, String? nextToken}) → Future<ListByoipCidrsResponse>
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
listCustomRoutingAccelerators({int? maxResults, String? nextToken}) → Future<ListCustomRoutingAcceleratorsResponse>
List the custom routing accelerators for an AWS account.
listCustomRoutingEndpointGroups({required String listenerArn, int? maxResults, String? nextToken}) → Future<ListCustomRoutingEndpointGroupsResponse>
List the endpoint groups that are associated with a listener for a custom routing accelerator.
listCustomRoutingListeners({required String acceleratorArn, int? maxResults, String? nextToken}) → Future<ListCustomRoutingListenersResponse>
List the listeners for a custom routing accelerator.
listCustomRoutingPortMappings({required String acceleratorArn, String? endpointGroupArn, int? maxResults, String? nextToken}) → Future<ListCustomRoutingPortMappingsResponse>
Provides a complete mapping from the public accelerator IP address and port to destination EC2 instance IP addresses and ports in the virtual public cloud (VPC) subnet endpoint for a custom routing accelerator. For each subnet endpoint that you add, Global Accelerator creates a new static port mapping for the accelerator. The port mappings don't change after Global Accelerator generates them, so you can retrieve and cache the full mapping on your servers.
listCustomRoutingPortMappingsByDestination({required String destinationAddress, required String endpointId, int? maxResults, String? nextToken}) → Future<ListCustomRoutingPortMappingsByDestinationResponse>
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint. The response is the mappings for one destination IP address. This is useful when your subnet endpoint has mappings that span multiple custom routing accelerators in your account, or for scenarios where you only want to list the port mappings for a specific destination instance.
listEndpointGroups({required String listenerArn, int? maxResults, String? nextToken}) → Future<ListEndpointGroupsResponse>
List the endpoint groups that are associated with a listener.
listListeners({required String acceleratorArn, int? maxResults, String? nextToken}) → Future<ListListenersResponse>
List the listeners for an accelerator.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
List all tags for an accelerator.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
provisionByoipCidr({required String cidr, required CidrAuthorizationContext cidrAuthorizationContext}) → Future<ProvisionByoipCidrResponse>
Provisions an IP address range to use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
removeCustomRoutingEndpoints({required String endpointGroupArn, required List<String> endpointIds}) → Future<void>
Remove endpoints from a custom routing accelerator.
tagResource({required String resourceArn, required List<Tag> tags}) → Future<void>
Add tags to an accelerator resource.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
updateAccelerator({required String acceleratorArn, bool? enabled, IpAddressType? ipAddressType, String? name}) → Future<UpdateAcceleratorResponse>
Update an accelerator.
updateAcceleratorAttributes({required String acceleratorArn, bool? flowLogsEnabled, String? flowLogsS3Bucket, String? flowLogsS3Prefix}) → Future<UpdateAcceleratorAttributesResponse>
Update the attributes for an accelerator.
updateCustomRoutingAccelerator({required String acceleratorArn, bool? enabled, IpAddressType? ipAddressType, String? name}) → Future<UpdateCustomRoutingAcceleratorResponse>
Update a custom routing accelerator.
updateCustomRoutingAcceleratorAttributes({required String acceleratorArn, bool? flowLogsEnabled, String? flowLogsS3Bucket, String? flowLogsS3Prefix}) → Future<UpdateCustomRoutingAcceleratorAttributesResponse>
Update the attributes for a custom routing accelerator.
updateCustomRoutingListener({required String listenerArn, required List<PortRange> portRanges}) → Future<UpdateCustomRoutingListenerResponse>
Update a listener for a custom routing accelerator.
updateEndpointGroup({required String endpointGroupArn, List<EndpointConfiguration>? endpointConfigurations, int? healthCheckIntervalSeconds, String? healthCheckPath, int? healthCheckPort, HealthCheckProtocol? healthCheckProtocol, List<PortOverride>? portOverrides, int? thresholdCount, double? trafficDialPercentage}) → Future<UpdateEndpointGroupResponse>
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
updateListener({required String listenerArn, ClientAffinity? clientAffinity, List<PortRange>? portRanges, Protocol? protocol}) → Future<UpdateListenerResponse>
Update a listener.
withdrawByoipCidr({required String cidr}) → Future<WithdrawByoipCidrResponse>
Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

Operators

operator ==(Object other) → bool
The equality operator.
inherited