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_cross_account_attachment(params = {}) ⇒ Types::CreateCrossAccountAttachmentResponse
Create a cross-account attachment in Global 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_cross_account_attachment(params = {}) ⇒ Struct
Delete a cross-account attachment.
-
#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_cross_account_attachment(params = {}) ⇒ Types::DescribeCrossAccountAttachmentResponse
Gets configuration information about a cross-account attachment.
-
#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_cross_account_attachments(params = {}) ⇒ Types::ListCrossAccountAttachmentsResponse
List the cross-account attachments that have been created in Global Accelerator.
-
#list_cross_account_resource_accounts(params = {}) ⇒ Types::ListCrossAccountResourceAccountsResponse
List the accounts that have cross-account resources.
-
#list_cross_account_resources(params = {}) ⇒ Types::ListCrossAccountResourcesResponse
List the cross-account resources available to work with.
-
#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 to make changes, such as the following:.
-
#update_accelerator_attributes(params = {}) ⇒ Types::UpdateAcceleratorAttributesResponse
Update the attributes for an accelerator.
-
#update_cross_account_attachment(params = {}) ⇒ Types::UpdateCrossAccountAttachmentResponse
Update a cross-account attachment to add or remove principals or resources.
-
#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.
447 448 449 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 447 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.
509 510 511 512 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 509 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 in
Global Accelerator:
It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints.
It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add.
For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
580 581 582 583 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 580 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.
636 637 638 639 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 636 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.
706 707 708 709 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 706 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
Amazon Web Services CLI commands.
828 829 830 831 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 828 def create_accelerator(params = {}, = {}) req = build_request(:create_accelerator, params) req.send_request() end |
#create_cross_account_attachment(params = {}) ⇒ Types::CreateCrossAccountAttachmentResponse
Create a cross-account attachment in Global Accelerator. You create a cross-account attachment to specify the principals who have permission to work with resources in accelerators in their own account. You specify, in the same attachment, the resources that are shared.
A principal can be an Amazon Web Services account number or the Amazon Resource Name (ARN) for an accelerator. For account numbers that are listed as principals, to work with a resource listed in the attachment, you must sign in to an account specified as a principal. Then, you can work with resources that are listed, with any of your accelerators. If an accelerator ARN is listed in the cross-account attachment as a principal, anyone with permission to make updates to the accelerator can work with resources that are listed in the attachment.
Specify each principal and resource separately. To specify two CIDR
address pools, list them individually under Resources
, and so on.
For a command line operation, for example, you might use a statement
like the following:
"Resources": [\{"Cidr": "169.254.60.0/24"\},\{"Cidr":
"169.254.59.0/24"\}]
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
938 939 940 941 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 938 def (params = {}, = {}) req = build_request(:create_cross_account_attachment, 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
Amazon Web Services CLI commands.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1065 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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1129 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.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1188 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.
For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1328 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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1410 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.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1455 def delete_accelerator(params = {}, = {}) req = build_request(:delete_accelerator, params) req.send_request() end |
#delete_cross_account_attachment(params = {}) ⇒ Struct
Delete a cross-account attachment. When you delete an attachment, Global Accelerator revokes the permission to use the resources in the attachment from all principals in the list of principals. Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
1489 1490 1491 1492 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1489 def (params = {}, = {}) req = build_request(:delete_cross_account_attachment, 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.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1533 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.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1556 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.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1578 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.
1600 1601 1602 1603 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1600 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.
1622 1623 1624 1625 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1622 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.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1688 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.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1742 def deprovision_byoip_cidr(params = {}, = {}) req = build_request(:deprovision_byoip_cidr, params) req.send_request() end |
#describe_accelerator(params = {}) ⇒ Types::DescribeAcceleratorResponse
Describe an accelerator.
1786 1787 1788 1789 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1786 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.
1817 1818 1819 1820 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1817 def describe_accelerator_attributes(params = {}, = {}) req = build_request(:describe_accelerator_attributes, params) req.send_request() end |
#describe_cross_account_attachment(params = {}) ⇒ Types::DescribeCrossAccountAttachmentResponse
Gets configuration information about a cross-account attachment.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1855 def (params = {}, = {}) req = build_request(:describe_cross_account_attachment, params) req.send_request() end |
#describe_custom_routing_accelerator(params = {}) ⇒ Types::DescribeCustomRoutingAcceleratorResponse
Describe a custom routing accelerator.
1895 1896 1897 1898 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1895 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.
1926 1927 1928 1929 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1926 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1962 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.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 1993 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.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2037 def describe_endpoint_group(params = {}, = {}) req = build_request(:describe_endpoint_group, params) req.send_request() end |
#describe_listener(params = {}) ⇒ Types::DescribeListenerResponse
Describe a listener.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2070 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.
2125 2126 2127 2128 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2125 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.
2174 2175 2176 2177 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2174 def list_byoip_cidrs(params = {}, = {}) req = build_request(:list_byoip_cidrs, params) req.send_request() end |
#list_cross_account_attachments(params = {}) ⇒ Types::ListCrossAccountAttachmentsResponse
List the cross-account attachments that have been created in Global Accelerator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2223 2224 2225 2226 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2223 def (params = {}, = {}) req = build_request(:list_cross_account_attachments, params) req.send_request() end |
#list_cross_account_resource_accounts(params = {}) ⇒ Types::ListCrossAccountResourceAccountsResponse
List the accounts that have cross-account resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2251 def list_cross_account_resource_accounts(params = {}, = {}) req = build_request(:list_cross_account_resource_accounts, params) req.send_request() end |
#list_cross_account_resources(params = {}) ⇒ Types::ListCrossAccountResourcesResponse
List the cross-account resources available to work with.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2301 2302 2303 2304 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2301 def list_cross_account_resources(params = {}, = {}) req = build_request(:list_cross_account_resources, 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.
2353 2354 2355 2356 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2353 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.
2406 2407 2408 2409 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2406 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.
2453 2454 2455 2456 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2453 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.
2525 2526 2527 2528 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2525 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.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2588 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.
2647 2648 2649 2650 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2647 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.
2696 2697 2698 2699 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2696 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.
2734 2735 2736 2737 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2734 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.
2795 2796 2797 2798 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2795 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.
2823 2824 2825 2826 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2823 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.
2874 2875 2876 2877 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2874 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.
2914 2915 2916 2917 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2914 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.
2952 2953 2954 2955 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 2952 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_accelerator(params = {}) ⇒ Types::UpdateAcceleratorResponse
Update an accelerator to make changes, such as the following:
Change the name of the accelerator.
Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.
Enable the accelerator, if it is disabled.
Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.
Be aware that static IP addresses remain 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 the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.
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
Amazon Web Services CLI commands.
3041 3042 3043 3044 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3041 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.
3102 3103 3104 3105 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3102 def update_accelerator_attributes(params = {}, = {}) req = build_request(:update_accelerator_attributes, params) req.send_request() end |
#update_cross_account_attachment(params = {}) ⇒ Types::UpdateCrossAccountAttachmentResponse
Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.
For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.
3205 3206 3207 3208 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3205 def (params = {}, = {}) req = build_request(:update_cross_account_attachment, params) req.send_request() end |
#update_custom_routing_accelerator(params = {}) ⇒ Types::UpdateCustomRoutingAcceleratorResponse
Update a custom routing accelerator.
3268 3269 3270 3271 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3268 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.
3331 3332 3333 3334 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3331 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.
3380 3381 3382 3383 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3380 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.
3500 3501 3502 3503 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3500 def update_endpoint_group(params = {}, = {}) req = build_request(:update_endpoint_group, params) req.send_request() end |
#update_listener(params = {}) ⇒ Types::UpdateListenerResponse
Update a listener.
3573 3574 3575 3576 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3573 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.
3624 3625 3626 3627 |
# File 'gems/aws-sdk-globalaccelerator/lib/aws-sdk-globalaccelerator/client.rb', line 3624 def withdraw_byoip_cidr(params = {}, = {}) req = build_request(:withdraw_byoip_cidr, params) req.send_request() end |