Class: Aws::GlobalAccelerator::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::GlobalAccelerator::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb
Overview
An API client for GlobalAccelerator. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::GlobalAccelerator::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#add_custom_routing_endpoints(params = {}) ⇒ Types::AddCustomRoutingEndpointsResponse
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
-
#add_endpoints(params = {}) ⇒ Types::AddEndpointsResponse
Add endpoints to an endpoint group.
-
#advertise_byoip_cidr(params = {}) ⇒ Types::AdvertiseByoipCidrResponse
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
-
#allow_custom_routing_traffic(params = {}) ⇒ Struct
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator.
-
#create_accelerator(params = {}) ⇒ Types::CreateAcceleratorResponse
Create an accelerator.
-
#create_custom_routing_accelerator(params = {}) ⇒ Types::CreateCustomRoutingAcceleratorResponse
Create a custom routing accelerator.
-
#create_custom_routing_endpoint_group(params = {}) ⇒ Types::CreateCustomRoutingEndpointGroupResponse
Create an endpoint group for the specified listener for a custom routing accelerator.
-
#create_custom_routing_listener(params = {}) ⇒ Types::CreateCustomRoutingListenerResponse
Create a listener to process inbound connections from clients to a custom routing accelerator.
-
#create_endpoint_group(params = {}) ⇒ Types::CreateEndpointGroupResponse
Create an endpoint group for the specified listener.
-
#create_listener(params = {}) ⇒ Types::CreateListenerResponse
Create a listener to process inbound connections from clients to an accelerator.
-
#delete_accelerator(params = {}) ⇒ Struct
Delete an accelerator.
-
#delete_custom_routing_accelerator(params = {}) ⇒ Struct
Delete a custom routing accelerator.
-
#delete_custom_routing_endpoint_group(params = {}) ⇒ Struct
Delete an endpoint group from a listener for a custom routing accelerator.
-
#delete_custom_routing_listener(params = {}) ⇒ Struct
Delete a listener for a custom routing accelerator.
-
#delete_endpoint_group(params = {}) ⇒ Struct
Delete an endpoint group from a listener.
-
#delete_listener(params = {}) ⇒ Struct
Delete a listener from an accelerator.
-
#deny_custom_routing_traffic(params = {}) ⇒ Struct
Specify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator.
-
#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResponse
Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
-
#describe_accelerator(params = {}) ⇒ Types::DescribeAcceleratorResponse
Describe an accelerator.
-
#describe_accelerator_attributes(params = {}) ⇒ Types::DescribeAcceleratorAttributesResponse
Describe the attributes of an accelerator.
-
#describe_custom_routing_accelerator(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorResponse
Describe a custom routing accelerator.
-
#describe_custom_routing_accelerator_attributes(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorAttributesResponse
Describe the attributes of a custom routing accelerator.
-
#describe_custom_routing_endpoint_group(params = {}) ⇒ Types::DescribeCustomRoutingEndpointGroupResponse
Describe an endpoint group for a custom routing accelerator.
-
#describe_custom_routing_listener(params = {}) ⇒ Types::DescribeCustomRoutingListenerResponse
The description of a listener for a custom routing accelerator.
-
#describe_endpoint_group(params = {}) ⇒ Types::DescribeEndpointGroupResponse
Describe an endpoint group.
-
#describe_listener(params = {}) ⇒ Types::DescribeListenerResponse
Describe a listener.
-
#list_accelerators(params = {}) ⇒ Types::ListAcceleratorsResponse
List the accelerators for an Amazon Web Services account.
-
#list_byoip_cidrs(params = {}) ⇒ Types::ListByoipCidrsResponse
Lists the IP address ranges that were specified in calls to [ProvisionByoipCidr][1], including the current state and a history of state changes.
-
#list_custom_routing_accelerators(params = {}) ⇒ Types::ListCustomRoutingAcceleratorsResponse
List the custom routing accelerators for an Amazon Web Services account.
-
#list_custom_routing_endpoint_groups(params = {}) ⇒ Types::ListCustomRoutingEndpointGroupsResponse
List the endpoint groups that are associated with a listener for a custom routing accelerator.
-
#list_custom_routing_listeners(params = {}) ⇒ Types::ListCustomRoutingListenersResponse
List the listeners for a custom routing accelerator.
-
#list_custom_routing_port_mappings(params = {}) ⇒ Types::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.
-
#list_custom_routing_port_mappings_by_destination(params = {}) ⇒ Types::ListCustomRoutingPortMappingsByDestinationResponse
List the port mappings for a specific EC2 instance (destination) in a VPC subnet endpoint.
-
#list_endpoint_groups(params = {}) ⇒ Types::ListEndpointGroupsResponse
List the endpoint groups that are associated with a listener.
-
#list_listeners(params = {}) ⇒ Types::ListListenersResponse
List the listeners for an accelerator.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags for an accelerator.
-
#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResponse
Provisions an IP address range to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool.
-
#remove_custom_routing_endpoints(params = {}) ⇒ Struct
Remove endpoints from a custom routing accelerator.
-
#remove_endpoints(params = {}) ⇒ Struct
Remove endpoints from an endpoint group.
-
#tag_resource(params = {}) ⇒ Struct
Add tags to an accelerator resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from a Global Accelerator resource.
-
#update_accelerator(params = {}) ⇒ Types::UpdateAcceleratorResponse
Update an accelerator.
-
#update_accelerator_attributes(params = {}) ⇒ Types::UpdateAcceleratorAttributesResponse
Update the attributes for an accelerator.
-
#update_custom_routing_accelerator(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorResponse
Update a custom routing accelerator.
-
#update_custom_routing_accelerator_attributes(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorAttributesResponse
Update the attributes for a custom routing accelerator.
-
#update_custom_routing_listener(params = {}) ⇒ Types::UpdateCustomRoutingListenerResponse
Update a listener for a custom routing accelerator.
-
#update_endpoint_group(params = {}) ⇒ Types::UpdateEndpointGroupResponse
Update an endpoint group.
-
#update_listener(params = {}) ⇒ Types::UpdateListenerResponse
Update a listener.
-
#withdraw_byoip_cidr(params = {}) ⇒ Types::WithdrawByoipCidrResponse
Stops advertising an address range that is provisioned as an address pool.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
375 376 377 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#add_custom_routing_endpoints(params = {}) ⇒ Types::AddCustomRoutingEndpointsResponse
Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.
The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.
Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.
By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
436 437 438 439 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 436 def add_custom_routing_endpoints(params = {}, = {}) req = build_request(:add_custom_routing_endpoints, params) req.send_request() end |
#add_endpoints(params = {}) ⇒ Types::AddEndpointsResponse
Add endpoints to an endpoint group. The AddEndpoints
API operation
is the recommended option for adding endpoints. The alternative
options are to add endpoints when you create an endpoint group (with
the CreateEndpointGroup API) or when you update an endpoint group
(with the UpdateEndpointGroup API).
There are two advantages to using AddEndpoints
to add endpoints:
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding.
It's more convenient, because you don't need to specify all of the current endpoints that are already in the endpoint group in addition to the new endpoints that you want to add.
499 500 501 502 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 499 def add_endpoints(params = {}, = {}) req = build_request(:add_endpoints, params) req.send_request() end |
#advertise_byoip_cidr(params = {}) ⇒ Types::AdvertiseByoipCidrResponse
Advertises an IPv4 address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to Amazon Web Services because of propagation delays.
To stop advertising the BYOIP address range, use WithdrawByoipCidr.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
548 549 550 551 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 548 def advertise_byoip_cidr(params = {}, = {}) req = build_request(:advertise_byoip_cidr, params) req.send_request() end |
#allow_custom_routing_traffic(params = {}) ⇒ Struct
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.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
618 619 620 621 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 618 def allow_custom_routing_traffic(params = {}, = {}) req = build_request(:allow_custom_routing_traffic, params) req.send_request() end |
#create_accelerator(params = {}) ⇒ Types::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.
Global Accelerator is a global service that supports endpoints in
multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with
accelerators. That is, for example, specify --region us-west-2
on
AWS CLI commands.
740 741 742 743 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 740 def create_accelerator(params = {}, = {}) req = build_request(:create_accelerator, params) req.send_request() end |
#create_custom_routing_accelerator(params = {}) ⇒ Types::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.
Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.
Global Accelerator is a global service that supports endpoints in
multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with
accelerators. That is, for example, specify --region us-west-2
on
AWS CLI commands.
867 868 869 870 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 867 def create_custom_routing_accelerator(params = {}, = {}) req = build_request(:create_custom_routing_accelerator, params) req.send_request() end |
#create_custom_routing_endpoint_group(params = {}) ⇒ Types::CreateCustomRoutingEndpointGroupResponse
Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.
931 932 933 934 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 931 def create_custom_routing_endpoint_group(params = {}, = {}) req = build_request(:create_custom_routing_endpoint_group, params) req.send_request() end |
#create_custom_routing_listener(params = {}) ⇒ Types::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.
990 991 992 993 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 990 def create_custom_routing_listener(params = {}, = {}) req = build_request(:create_custom_routing_listener, params) req.send_request() end |
#create_endpoint_group(params = {}) ⇒ Types::CreateEndpointGroupResponse
Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1121 def create_endpoint_group(params = {}, = {}) req = build_request(:create_endpoint_group, params) req.send_request() end |
#create_listener(params = {}) ⇒ Types::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.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1203 def create_listener(params = {}, = {}) req = build_request(:create_listener, params) req.send_request() end |
#delete_accelerator(params = {}) ⇒ Struct
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.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1248 def delete_accelerator(params = {}, = {}) req = build_request(:delete_accelerator, params) req.send_request() end |
#delete_custom_routing_accelerator(params = {}) ⇒ Struct
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.
When you create a custom routing accelerator, by default, Global Accelerator provides you with a set of two static IP addresses.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Identity and access management in the Global Accelerator Developer Guide.
1292 1293 1294 1295 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1292 def delete_custom_routing_accelerator(params = {}, = {}) req = build_request(:delete_custom_routing_accelerator, params) req.send_request() end |
#delete_custom_routing_endpoint_group(params = {}) ⇒ Struct
Delete an endpoint group from a listener for a custom routing accelerator.
1315 1316 1317 1318 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1315 def delete_custom_routing_endpoint_group(params = {}, = {}) req = build_request(:delete_custom_routing_endpoint_group, params) req.send_request() end |
#delete_custom_routing_listener(params = {}) ⇒ Struct
Delete a listener for a custom routing accelerator.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1337 def delete_custom_routing_listener(params = {}, = {}) req = build_request(:delete_custom_routing_listener, params) req.send_request() end |
#delete_endpoint_group(params = {}) ⇒ Struct
Delete an endpoint group from a listener.
1359 1360 1361 1362 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1359 def delete_endpoint_group(params = {}, = {}) req = build_request(:delete_endpoint_group, params) req.send_request() end |
#delete_listener(params = {}) ⇒ Struct
Delete a listener from an accelerator.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1381 def delete_listener(params = {}, = {}) req = build_request(:delete_listener, params) req.send_request() end |
#deny_custom_routing_traffic(params = {}) ⇒ Struct
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.
After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1447 def deny_custom_routing_traffic(params = {}, = {}) req = build_request(:deny_custom_routing_traffic, params) req.send_request() end |
#deprovision_byoip_cidr(params = {}) ⇒ Types::DeprovisionByoipCidrResponse
Releases the specified address range that you provisioned to use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1494 def deprovision_byoip_cidr(params = {}, = {}) req = build_request(:deprovision_byoip_cidr, params) req.send_request() end |
#describe_accelerator(params = {}) ⇒ Types::DescribeAcceleratorResponse
Describe an accelerator.
1538 1539 1540 1541 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1538 def describe_accelerator(params = {}, = {}) req = build_request(:describe_accelerator, params) req.send_request() end |
#describe_accelerator_attributes(params = {}) ⇒ Types::DescribeAcceleratorAttributesResponse
Describe the attributes of an accelerator.
1569 1570 1571 1572 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1569 def describe_accelerator_attributes(params = {}, = {}) req = build_request(:describe_accelerator_attributes, params) req.send_request() end |
#describe_custom_routing_accelerator(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorResponse
Describe a custom routing accelerator.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1609 def describe_custom_routing_accelerator(params = {}, = {}) req = build_request(:describe_custom_routing_accelerator, params) req.send_request() end |
#describe_custom_routing_accelerator_attributes(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorAttributesResponse
Describe the attributes of a custom routing accelerator.
1640 1641 1642 1643 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1640 def describe_custom_routing_accelerator_attributes(params = {}, = {}) req = build_request(:describe_custom_routing_accelerator_attributes, params) req.send_request() end |
#describe_custom_routing_endpoint_group(params = {}) ⇒ Types::DescribeCustomRoutingEndpointGroupResponse
Describe an endpoint group for a custom routing accelerator.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1676 def describe_custom_routing_endpoint_group(params = {}, = {}) req = build_request(:describe_custom_routing_endpoint_group, params) req.send_request() end |
#describe_custom_routing_listener(params = {}) ⇒ Types::DescribeCustomRoutingListenerResponse
The description of a listener for a custom routing accelerator.
1707 1708 1709 1710 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1707 def describe_custom_routing_listener(params = {}, = {}) req = build_request(:describe_custom_routing_listener, params) req.send_request() end |
#describe_endpoint_group(params = {}) ⇒ Types::DescribeEndpointGroupResponse
Describe an endpoint group.
1751 1752 1753 1754 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1751 def describe_endpoint_group(params = {}, = {}) req = build_request(:describe_endpoint_group, params) req.send_request() end |
#describe_listener(params = {}) ⇒ Types::DescribeListenerResponse
Describe a listener.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1784 def describe_listener(params = {}, = {}) req = build_request(:describe_listener, params) req.send_request() end |
#list_accelerators(params = {}) ⇒ Types::ListAcceleratorsResponse
List the accelerators for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1839 1840 1841 1842 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1839 def list_accelerators(params = {}, = {}) req = build_request(:list_accelerators, params) req.send_request() end |
#list_byoip_cidrs(params = {}) ⇒ Types::ListByoipCidrsResponse
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1888 1889 1890 1891 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1888 def list_byoip_cidrs(params = {}, = {}) req = build_request(:list_byoip_cidrs, params) req.send_request() end |
#list_custom_routing_accelerators(params = {}) ⇒ Types::ListCustomRoutingAcceleratorsResponse
List the custom routing accelerators for an Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1940 1941 1942 1943 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1940 def list_custom_routing_accelerators(params = {}, = {}) req = build_request(:list_custom_routing_accelerators, params) req.send_request() end |
#list_custom_routing_endpoint_groups(params = {}) ⇒ Types::ListCustomRoutingEndpointGroupsResponse
List the endpoint groups that are associated with a listener for a custom routing accelerator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1993 def list_custom_routing_endpoint_groups(params = {}, = {}) req = build_request(:list_custom_routing_endpoint_groups, params) req.send_request() end |
#list_custom_routing_listeners(params = {}) ⇒ Types::ListCustomRoutingListenersResponse
List the listeners for a custom routing accelerator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2040 2041 2042 2043 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2040 def list_custom_routing_listeners(params = {}, = {}) req = build_request(:list_custom_routing_listeners, params) req.send_request() end |
#list_custom_routing_port_mappings(params = {}) ⇒ Types::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.
If you remove a subnet from your accelerator, Global Accelerator removes (reclaims) the port mappings. If you add a subnet to your accelerator, Global Accelerator creates new port mappings (the existing ones don't change). If you add or remove EC2 instances in your subnet, the port mappings don't change, because the mappings are created when you add the subnet to Global Accelerator.
The mappings also include a flag for each destination denoting which destination IP addresses and ports are allowed or denied traffic.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2112 2113 2114 2115 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2112 def list_custom_routing_port_mappings(params = {}, = {}) req = build_request(:list_custom_routing_port_mappings, params) req.send_request() end |
#list_custom_routing_port_mappings_by_destination(params = {}) ⇒ Types::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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2175 2176 2177 2178 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2175 def list_custom_routing_port_mappings_by_destination(params = {}, = {}) req = build_request(:list_custom_routing_port_mappings_by_destination, params) req.send_request() end |
#list_endpoint_groups(params = {}) ⇒ Types::ListEndpointGroupsResponse
List the endpoint groups that are associated with a listener.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2234 2235 2236 2237 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2234 def list_endpoint_groups(params = {}, = {}) req = build_request(:list_endpoint_groups, params) req.send_request() end |
#list_listeners(params = {}) ⇒ Types::ListListenersResponse
List the listeners for an accelerator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2283 2284 2285 2286 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2283 def list_listeners(params = {}, = {}) req = build_request(:list_listeners, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all tags for an accelerator.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
2321 2322 2323 2324 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2321 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#provision_byoip_cidr(params = {}) ⇒ Types::ProvisionByoipCidrResponse
Provisions an IP address range to use with your Amazon Web Services 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.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
2375 2376 2377 2378 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2375 def provision_byoip_cidr(params = {}, = {}) req = build_request(:provision_byoip_cidr, params) req.send_request() end |
#remove_custom_routing_endpoints(params = {}) ⇒ Struct
Remove endpoints from a custom routing accelerator.
2403 2404 2405 2406 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2403 def remove_custom_routing_endpoints(params = {}, = {}) req = build_request(:remove_custom_routing_endpoints, params) req.send_request() end |
#remove_endpoints(params = {}) ⇒ Struct
Remove endpoints from an endpoint group.
The RemoveEndpoints
API operation is the recommended option for
removing endpoints. The alternative is to remove endpoints by updating
an endpoint group by using the UpdateEndpointGroup API operation.
There are two advantages to using AddEndpoints
to remove endpoints
instead:
It's more convenient, because you only need to specify the endpoints that you want to remove. With the
UpdateEndpointGroup
API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group.It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the
UpdateEndpointGroup
API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
2454 2455 2456 2457 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2454 def remove_endpoints(params = {}, = {}) req = build_request(:remove_endpoints, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add tags to an accelerator resource.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
2494 2495 2496 2497 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2494 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.
2532 2533 2534 2535 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2532 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_accelerator(params = {}) ⇒ Types::UpdateAcceleratorResponse
Update an accelerator.
Global Accelerator is a global service that supports endpoints in
multiple Amazon Web Services Regions but you must specify the US West
(Oregon) Region to create, update, or otherwise work with
accelerators. That is, for example, specify --region us-west-2
on
AWS CLI commands.
2601 2602 2603 2604 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2601 def update_accelerator(params = {}, = {}) req = build_request(:update_accelerator, params) req.send_request() end |
#update_accelerator_attributes(params = {}) ⇒ Types::UpdateAcceleratorAttributesResponse
Update the attributes for an accelerator.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2662 def update_accelerator_attributes(params = {}, = {}) req = build_request(:update_accelerator_attributes, params) req.send_request() end |
#update_custom_routing_accelerator(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorResponse
Update a custom routing accelerator.
2721 2722 2723 2724 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2721 def update_custom_routing_accelerator(params = {}, = {}) req = build_request(:update_custom_routing_accelerator, params) req.send_request() end |
#update_custom_routing_accelerator_attributes(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorAttributesResponse
Update the attributes for a custom routing accelerator.
2784 2785 2786 2787 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2784 def update_custom_routing_accelerator_attributes(params = {}, = {}) req = build_request(:update_custom_routing_accelerator_attributes, params) req.send_request() end |
#update_custom_routing_listener(params = {}) ⇒ Types::UpdateCustomRoutingListenerResponse
Update a listener for a custom routing accelerator.
2833 2834 2835 2836 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2833 def update_custom_routing_listener(params = {}, = {}) req = build_request(:update_custom_routing_listener, params) req.send_request() end |
#update_endpoint_group(params = {}) ⇒ Types::UpdateEndpointGroupResponse
Update an endpoint group. A resource must be valid and active when you add it as an endpoint.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2952 def update_endpoint_group(params = {}, = {}) req = build_request(:update_endpoint_group, params) req.send_request() end |
#update_listener(params = {}) ⇒ Types::UpdateListenerResponse
Update a listener.
3025 3026 3027 3028 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3025 def update_listener(params = {}, = {}) req = build_request(:update_listener, params) req.send_request() end |
#withdraw_byoip_cidr(params = {}) ⇒ Types::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.
It can take a few minutes before traffic to the specified addresses stops routing to Amazon Web Services because of propagation delays.
For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
3069 3070 3071 3072 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3069 def withdraw_byoip_cidr(params = {}, = {}) req = build_request(:withdraw_byoip_cidr, params) req.send_request() end |