❤
npm
Sign UpSign In

@datafire/amazonaws_globalaccelerator

5.0.0 • Public • Published

@datafire/amazonaws_globalaccelerator

Client library for AWS Global Accelerator

Installation and Usage

npm install --save @datafire/amazonaws_globalaccelerator
let amazonaws_globalaccelerator = require('@datafire/amazonaws_globalaccelerator').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS Global Accelerator

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.

AWS Global Accelerator is a service in which you create accelerators to improve the performance of your applications for local and global users. Depending on the type of accelerator you choose, you can gain additional benefits.

  • By using a standard accelerator, you can improve availability of your internet applications that are used by a global audience. With a standard accelerator, Global Accelerator directs traffic to optimal endpoints over the AWS global network.

  • For other scenarios, you might choose a custom routing accelerator. With a custom routing accelerator, you can use application logic to directly map one or more users to a specific endpoint among many endpoints.

Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.

By default, Global Accelerator provides you with two static IP addresses that you associate with your accelerator. With a standard accelerator, instead of using the IP addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator. The static IP addresses are anycast from the AWS edge network. For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses that are located in one AWS Region or multiple Regions. For custom routing accelerators, you map traffic that arrives to the static IP addresses to specific Amazon EC2 servers in endpoints that are virtual private cloud (VPC) subnets.

The 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 an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Tag-based policies.

For standard accelerators, Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is always directed to healthy endpoints.

For a list of the AWS Regions where Global Accelerator and other services are currently supported, see the AWS Region Table.

AWS Global Accelerator includes the following components:

Static IP addresses

Global Accelerator provides you with a set of two static IP addresses that are anycast from the AWS edge network. If you bring your own IP address range to AWS (BYOIP) to use with a standard accelerator, you can instead assign IP addresses from your own pool to use with your accelerator. For more information, see Bring your own IP addresses (BYOIP) in AWS Global Accelerator.

The IP addresses serve as single fixed entry points for your clients. If you already have Elastic Load Balancing load balancers, Amazon EC2 instances, or Elastic IP address resources set up for your applications, you can easily add those to a standard accelerator in Global Accelerator. This allows Global Accelerator to use static IP addresses to access the resources.

The 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 an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies like tag-based permissions with Global Accelerator to delete an accelerator. For more information, see Tag-based policies.

Accelerator

An accelerator directs traffic to endpoints over the AWS global network to improve the performance of your internet applications. Each accelerator includes one or more listeners.

There are two types of accelerators:

  • A standard accelerator directs traffic to the optimal AWS endpoint based on several factors, including the user’s location, the health of the endpoint, and the endpoint weights that you configure. This improves the availability and performance of your applications. Endpoints can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses.

  • A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instances running in a single or multiple virtual private clouds (VPCs). With custom routing, listener ports are mapped to statically associate port ranges with VPC subnets, which allows Global Accelerator to determine an EC2 instance IP address at the time of connection. By default, all port mapping destinations in a VPC subnet can't receive traffic. You can choose to configure all destinations in the subnet to receive traffic, or to specify individual port mappings that can receive traffic.

For more information, see Types of accelerators.

DNS name

Global Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to a1234567890abcdef.awsglobalaccelerator.com, that points to the static IP addresses that Global Accelerator assigns to you or that you choose from your own IP address range. Depending on the use case, you can use your accelerator's static IP addresses or DNS name to route traffic to your accelerator, or set up DNS records to route traffic using your own custom domain name.

Network zone

A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, by default, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the port (or port range) and protocol (or protocols) that you configure. A listener can be configured for TCP, UDP, or both TCP and UDP protocols. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. With a standard accelerator, traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. With a standard accelerator, you can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing, for example, for new releases across different AWS Regions.

Endpoint

An endpoint is a resource that Global Accelerator directs traffic to.

Endpoints for standard accelerators can be Network Load Balancers, Application Load Balancers, Amazon EC2 instances, or Elastic IP addresses. An Application Load Balancer endpoint can be internet-facing or internal. Traffic for standard accelerators is routed to endpoints based on the health of the endpoint along with configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.

Endpoints for custom routing accelerators are virtual private cloud (VPC) subnets with one or many EC2 instances.

Actions

AddCustomRoutingEndpoints

amazonaws_globalaccelerator.AddCustomRoutingEndpoints({
  "EndpointConfigurations": null,
  "EndpointGroupArn": null
}, context)

Input

Output

AdvertiseByoipCidr

amazonaws_globalaccelerator.AdvertiseByoipCidr({
  "Cidr": null
}, context)

Input

  • input object
    • Cidr required

Output

AllowCustomRoutingTraffic

amazonaws_globalaccelerator.AllowCustomRoutingTraffic({
  "EndpointGroupArn": null,
  "EndpointId": null
}, context)

Input

  • input object
    • AllowAllTrafficToEndpoint
    • DestinationAddresses
    • DestinationPorts
    • EndpointGroupArn required
    • EndpointId required

Output

Output schema unknown

CreateAccelerator

amazonaws_globalaccelerator.CreateAccelerator({
  "Name": null,
  "IdempotencyToken": null
}, context)

Input

  • input object
    • Enabled
    • IdempotencyToken required
    • IpAddressType
    • IpAddresses
    • Name required
    • Tags

Output

CreateCustomRoutingAccelerator

amazonaws_globalaccelerator.CreateCustomRoutingAccelerator({
  "Name": null,
  "IdempotencyToken": null
}, context)

Input

  • input object
    • Enabled
    • IdempotencyToken required
    • IpAddressType
    • Name required
    • Tags

Output

CreateCustomRoutingEndpointGroup

amazonaws_globalaccelerator.CreateCustomRoutingEndpointGroup({
  "ListenerArn": null,
  "EndpointGroupRegion": null,
  "DestinationConfigurations": null,
  "IdempotencyToken": null
}, context)

Input

Output

CreateCustomRoutingListener

amazonaws_globalaccelerator.CreateCustomRoutingListener({
  "AcceleratorArn": null,
  "PortRanges": null,
  "IdempotencyToken": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • IdempotencyToken required
    • PortRanges required

Output

CreateEndpointGroup

amazonaws_globalaccelerator.CreateEndpointGroup({
  "ListenerArn": null,
  "EndpointGroupRegion": null,
  "IdempotencyToken": null
}, context)

Input

  • input object
    • EndpointConfigurations
    • EndpointGroupRegion required
    • HealthCheckIntervalSeconds
    • HealthCheckPath
    • HealthCheckPort
    • HealthCheckProtocol
    • IdempotencyToken required
    • ListenerArn required
    • PortOverrides
    • ThresholdCount
    • TrafficDialPercentage

Output

CreateListener

amazonaws_globalaccelerator.CreateListener({
  "AcceleratorArn": null,
  "PortRanges": null,
  "Protocol": null,
  "IdempotencyToken": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • ClientAffinity
    • IdempotencyToken required
    • PortRanges required
    • Protocol required

Output

DeleteAccelerator

amazonaws_globalaccelerator.DeleteAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

Output schema unknown

DeleteCustomRoutingAccelerator

amazonaws_globalaccelerator.DeleteCustomRoutingAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

Output schema unknown

DeleteCustomRoutingEndpointGroup

amazonaws_globalaccelerator.DeleteCustomRoutingEndpointGroup({
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointGroupArn required

Output

Output schema unknown

DeleteCustomRoutingListener

amazonaws_globalaccelerator.DeleteCustomRoutingListener({
  "ListenerArn": null
}, context)

Input

  • input object
    • ListenerArn required

Output

Output schema unknown

DeleteEndpointGroup

amazonaws_globalaccelerator.DeleteEndpointGroup({
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointGroupArn required

Output

Output schema unknown

DeleteListener

amazonaws_globalaccelerator.DeleteListener({
  "ListenerArn": null
}, context)

Input

  • input object
    • ListenerArn required

Output

Output schema unknown

DenyCustomRoutingTraffic

amazonaws_globalaccelerator.DenyCustomRoutingTraffic({
  "EndpointGroupArn": null,
  "EndpointId": null
}, context)

Input

  • input object
    • DenyAllTrafficToEndpoint
    • DestinationAddresses
    • DestinationPorts
    • EndpointGroupArn required
    • EndpointId required

Output

Output schema unknown

DeprovisionByoipCidr

amazonaws_globalaccelerator.DeprovisionByoipCidr({
  "Cidr": null
}, context)

Input

  • input object
    • Cidr required

Output

DescribeAccelerator

amazonaws_globalaccelerator.DescribeAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

DescribeAcceleratorAttributes

amazonaws_globalaccelerator.DescribeAcceleratorAttributes({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

DescribeCustomRoutingAccelerator

amazonaws_globalaccelerator.DescribeCustomRoutingAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

DescribeCustomRoutingAcceleratorAttributes

amazonaws_globalaccelerator.DescribeCustomRoutingAcceleratorAttributes({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required

Output

DescribeCustomRoutingEndpointGroup

amazonaws_globalaccelerator.DescribeCustomRoutingEndpointGroup({
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointGroupArn required

Output

DescribeCustomRoutingListener

amazonaws_globalaccelerator.DescribeCustomRoutingListener({
  "ListenerArn": null
}, context)

Input

  • input object
    • ListenerArn required

Output

DescribeEndpointGroup

amazonaws_globalaccelerator.DescribeEndpointGroup({
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointGroupArn required

Output

DescribeListener

amazonaws_globalaccelerator.DescribeListener({
  "ListenerArn": null
}, context)

Input

  • input object
    • ListenerArn required

Output

ListAccelerators

amazonaws_globalaccelerator.ListAccelerators({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListByoipCidrs

amazonaws_globalaccelerator.ListByoipCidrs({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListCustomRoutingAccelerators

amazonaws_globalaccelerator.ListCustomRoutingAccelerators({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListCustomRoutingEndpointGroups

amazonaws_globalaccelerator.ListCustomRoutingEndpointGroups({
  "ListenerArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ListenerArn required
    • MaxResults
    • NextToken

Output

ListCustomRoutingListeners

amazonaws_globalaccelerator.ListCustomRoutingListeners({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • AcceleratorArn required
    • MaxResults
    • NextToken

Output

ListCustomRoutingPortMappings

amazonaws_globalaccelerator.ListCustomRoutingPortMappings({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • AcceleratorArn required
    • EndpointGroupArn
    • MaxResults
    • NextToken

Output

ListCustomRoutingPortMappingsByDestination

amazonaws_globalaccelerator.ListCustomRoutingPortMappingsByDestination({
  "EndpointId": null,
  "DestinationAddress": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • DestinationAddress required
    • EndpointId required
    • MaxResults
    • NextToken

Output

ListEndpointGroups

amazonaws_globalaccelerator.ListEndpointGroups({
  "ListenerArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • ListenerArn required
    • MaxResults
    • NextToken

Output

ListListeners

amazonaws_globalaccelerator.ListListeners({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • AcceleratorArn required
    • MaxResults
    • NextToken

Output

ListTagsForResource

amazonaws_globalaccelerator.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

ProvisionByoipCidr

amazonaws_globalaccelerator.ProvisionByoipCidr({
  "Cidr": null,
  "CidrAuthorizationContext": null
}, context)

Input

  • input object
    • Cidr required
    • CidrAuthorizationContext required
      • Message required
      • Signature required

Output

RemoveCustomRoutingEndpoints

amazonaws_globalaccelerator.RemoveCustomRoutingEndpoints({
  "EndpointIds": null,
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointGroupArn required
    • EndpointIds required

Output

Output schema unknown

TagResource

amazonaws_globalaccelerator.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_globalaccelerator.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateAccelerator

amazonaws_globalaccelerator.UpdateAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • Enabled
    • IpAddressType
    • Name

Output

UpdateAcceleratorAttributes

amazonaws_globalaccelerator.UpdateAcceleratorAttributes({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

Output

UpdateCustomRoutingAccelerator

amazonaws_globalaccelerator.UpdateCustomRoutingAccelerator({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • Enabled
    • IpAddressType
    • Name

Output

UpdateCustomRoutingAcceleratorAttributes

amazonaws_globalaccelerator.UpdateCustomRoutingAcceleratorAttributes({
  "AcceleratorArn": null
}, context)

Input

  • input object
    • AcceleratorArn required
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

Output

UpdateCustomRoutingListener

amazonaws_globalaccelerator.UpdateCustomRoutingListener({
  "ListenerArn": null,
  "PortRanges": null
}, context)

Input

  • input object
    • ListenerArn required
    • PortRanges required

Output

UpdateEndpointGroup

amazonaws_globalaccelerator.UpdateEndpointGroup({
  "EndpointGroupArn": null
}, context)

Input

  • input object
    • EndpointConfigurations
    • EndpointGroupArn required
    • HealthCheckIntervalSeconds
    • HealthCheckPath
    • HealthCheckPort
    • HealthCheckProtocol
    • PortOverrides
    • ThresholdCount
    • TrafficDialPercentage

Output

UpdateListener

amazonaws_globalaccelerator.UpdateListener({
  "ListenerArn": null
}, context)

Input

  • input object
    • ClientAffinity
    • ListenerArn required
    • PortRanges
    • Protocol

Output

WithdrawByoipCidr

amazonaws_globalaccelerator.WithdrawByoipCidr({
  "Cidr": null
}, context)

Input

  • input object
    • Cidr required

Output

Definitions

Accelerator

  • Accelerator object: An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.
    • AcceleratorArn
    • CreatedTime
    • DnsName
    • Enabled
    • IpAddressType
    • IpSets
    • LastModifiedTime
    • Name
    • Status

AcceleratorAttributes

  • AcceleratorAttributes object: Attributes of an accelerator.
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

AcceleratorNotDisabledException

AcceleratorNotFoundException

AcceleratorStatus

  • AcceleratorStatus string (values: DEPLOYED, IN_PROGRESS)

Accelerators

AccessDeniedException

AddCustomRoutingEndpointsRequest

AddCustomRoutingEndpointsResponse

AdvertiseByoipCidrRequest

  • AdvertiseByoipCidrRequest object
    • Cidr required

AdvertiseByoipCidrResponse

  • AdvertiseByoipCidrResponse object

AllowCustomRoutingTrafficRequest

  • AllowCustomRoutingTrafficRequest object
    • AllowAllTrafficToEndpoint
    • DestinationAddresses
    • DestinationPorts
    • EndpointGroupArn required
    • EndpointId required

AssociatedEndpointGroupFoundException

AssociatedListenerFoundException

ByoipCidr

  • ByoipCidr object:

    Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).

    The following describes each BYOIP State that your IP address range can be in.

    • PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.

    • READY — The address range is provisioned with AWS Global Accelerator and can be advertised.

    • PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.

    • ADVERTISING — The address range is being advertised by AWS Global Accelerator.

    • PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.

    • PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.

    • DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.

    • FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.

    • FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.

    • FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.

    • FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.

ByoipCidrEvent

  • ByoipCidrEvent object: A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
    • Message
    • Timestamp

ByoipCidrEvents

ByoipCidrNotFoundException

ByoipCidrState

  • ByoipCidrState string (values: PENDING_PROVISIONING, READY, PENDING_ADVERTISING, ADVERTISING, PENDING_WITHDRAWING, PENDING_DEPROVISIONING, DEPROVISIONED, FAILED_PROVISION, FAILED_ADVERTISING, FAILED_WITHDRAW, FAILED_DEPROVISION)

ByoipCidrs

CidrAuthorizationContext

  • CidrAuthorizationContext object:

    Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP).

    For more information, see Bring Your Own IP Addresses (BYOIP) in the AWS Global Accelerator Developer Guide.

    • Message required
    • Signature required

ClientAffinity

  • ClientAffinity string (values: NONE, SOURCE_IP)

ConflictException

CreateAcceleratorRequest

  • CreateAcceleratorRequest object
    • Enabled
    • IdempotencyToken required
    • IpAddressType
    • IpAddresses
    • Name required
    • Tags

CreateAcceleratorResponse

  • CreateAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

CreateCustomRoutingAcceleratorRequest

  • CreateCustomRoutingAcceleratorRequest object
    • Enabled
    • IdempotencyToken required
    • IpAddressType
    • Name required
    • Tags

CreateCustomRoutingAcceleratorResponse

  • CreateCustomRoutingAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

CreateCustomRoutingEndpointGroupRequest

  • CreateCustomRoutingEndpointGroupRequest object

CreateCustomRoutingEndpointGroupResponse

CreateCustomRoutingListenerRequest

  • CreateCustomRoutingListenerRequest object
    • AcceleratorArn required
    • IdempotencyToken required
    • PortRanges required

CreateCustomRoutingListenerResponse

  • CreateCustomRoutingListenerResponse object
    • Listener

CreateEndpointGroupRequest

  • CreateEndpointGroupRequest object
    • EndpointConfigurations
    • EndpointGroupRegion required
    • HealthCheckIntervalSeconds
    • HealthCheckPath
    • HealthCheckPort
    • HealthCheckProtocol
    • IdempotencyToken required
    • ListenerArn required
    • PortOverrides
    • ThresholdCount
    • TrafficDialPercentage

CreateEndpointGroupResponse

  • CreateEndpointGroupResponse object
    • EndpointGroup
      • EndpointDescriptions
      • EndpointGroupArn
      • EndpointGroupRegion
      • HealthCheckIntervalSeconds
      • HealthCheckPath
      • HealthCheckPort
      • HealthCheckProtocol
      • PortOverrides
      • ThresholdCount
      • TrafficDialPercentage

CreateListenerRequest

  • CreateListenerRequest object
    • AcceleratorArn required
    • ClientAffinity
    • IdempotencyToken required
    • PortRanges required
    • Protocol required

CreateListenerResponse

  • CreateListenerResponse object
    • Listener
      • ClientAffinity
      • ListenerArn
      • PortRanges
      • Protocol

CustomRoutingAccelerator

  • CustomRoutingAccelerator object: Attributes of a custom routing accelerator.
    • AcceleratorArn
    • CreatedTime
    • DnsName
    • Enabled
    • IpAddressType
    • IpSets
    • LastModifiedTime
    • Name
    • Status

CustomRoutingAcceleratorAttributes

  • CustomRoutingAcceleratorAttributes object: Attributes of a custom routing accelerator.
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

CustomRoutingAcceleratorStatus

  • CustomRoutingAcceleratorStatus string (values: DEPLOYED, IN_PROGRESS)

CustomRoutingAccelerators

CustomRoutingDestinationConfiguration

  • CustomRoutingDestinationConfiguration object: For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

CustomRoutingDestinationConfigurations

CustomRoutingDestinationDescription

  • CustomRoutingDestinationDescription object: For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
    • FromPort
    • Protocols
    • ToPort

CustomRoutingDestinationDescriptions

CustomRoutingDestinationTrafficState

  • CustomRoutingDestinationTrafficState string (values: ALLOW, DENY)

CustomRoutingEndpointConfiguration

  • CustomRoutingEndpointConfiguration object: The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
    • EndpointId

CustomRoutingEndpointConfigurations

CustomRoutingEndpointDescription

  • CustomRoutingEndpointDescription object: A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
    • EndpointId

CustomRoutingEndpointDescriptions

CustomRoutingEndpointGroup

  • CustomRoutingEndpointGroup object: A complex type for the endpoint group for a custom routing accelerator. An AWS Region can have only one endpoint group for a specific listener.

CustomRoutingEndpointGroups

CustomRoutingListener

  • CustomRoutingListener object: A complex type for a listener for a custom routing accelerator.

CustomRoutingListeners

CustomRoutingProtocol

  • CustomRoutingProtocol string (values: TCP, UDP)

CustomRoutingProtocols

DeleteAcceleratorRequest

  • DeleteAcceleratorRequest object
    • AcceleratorArn required

DeleteCustomRoutingAcceleratorRequest

  • DeleteCustomRoutingAcceleratorRequest object
    • AcceleratorArn required

DeleteCustomRoutingEndpointGroupRequest

  • DeleteCustomRoutingEndpointGroupRequest object
    • EndpointGroupArn required

DeleteCustomRoutingListenerRequest

  • DeleteCustomRoutingListenerRequest object
    • ListenerArn required

DeleteEndpointGroupRequest

  • DeleteEndpointGroupRequest object
    • EndpointGroupArn required

DeleteListenerRequest

  • DeleteListenerRequest object
    • ListenerArn required

DenyCustomRoutingTrafficRequest

  • DenyCustomRoutingTrafficRequest object
    • DenyAllTrafficToEndpoint
    • DestinationAddresses
    • DestinationPorts
    • EndpointGroupArn required
    • EndpointId required

DeprovisionByoipCidrRequest

  • DeprovisionByoipCidrRequest object
    • Cidr required

DeprovisionByoipCidrResponse

  • DeprovisionByoipCidrResponse object

DescribeAcceleratorAttributesRequest

  • DescribeAcceleratorAttributesRequest object
    • AcceleratorArn required

DescribeAcceleratorAttributesResponse

  • DescribeAcceleratorAttributesResponse object
    • AcceleratorAttributes
      • FlowLogsEnabled
      • FlowLogsS3Bucket
      • FlowLogsS3Prefix

DescribeAcceleratorRequest

  • DescribeAcceleratorRequest object
    • AcceleratorArn required

DescribeAcceleratorResponse

  • DescribeAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

DescribeCustomRoutingAcceleratorAttributesRequest

  • DescribeCustomRoutingAcceleratorAttributesRequest object
    • AcceleratorArn required

DescribeCustomRoutingAcceleratorAttributesResponse

  • DescribeCustomRoutingAcceleratorAttributesResponse object
    • AcceleratorAttributes
      • FlowLogsEnabled
      • FlowLogsS3Bucket
      • FlowLogsS3Prefix

DescribeCustomRoutingAcceleratorRequest

  • DescribeCustomRoutingAcceleratorRequest object
    • AcceleratorArn required

DescribeCustomRoutingAcceleratorResponse

  • DescribeCustomRoutingAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

DescribeCustomRoutingEndpointGroupRequest

  • DescribeCustomRoutingEndpointGroupRequest object
    • EndpointGroupArn required

DescribeCustomRoutingEndpointGroupResponse

DescribeCustomRoutingListenerRequest

  • DescribeCustomRoutingListenerRequest object
    • ListenerArn required

DescribeCustomRoutingListenerResponse

  • DescribeCustomRoutingListenerResponse object
    • Listener

DescribeEndpointGroupRequest

  • DescribeEndpointGroupRequest object
    • EndpointGroupArn required

DescribeEndpointGroupResponse

  • DescribeEndpointGroupResponse object
    • EndpointGroup
      • EndpointDescriptions
      • EndpointGroupArn
      • EndpointGroupRegion
      • HealthCheckIntervalSeconds
      • HealthCheckPath
      • HealthCheckPort
      • HealthCheckProtocol
      • PortOverrides
      • ThresholdCount
      • TrafficDialPercentage

DescribeListenerRequest

  • DescribeListenerRequest object
    • ListenerArn required

DescribeListenerResponse

  • DescribeListenerResponse object
    • Listener
      • ClientAffinity
      • ListenerArn
      • PortRanges
      • Protocol

DestinationAddresses

DestinationPortMapping

  • DestinationPortMapping object: The port mappings for a specified endpoint IP address (destination).
    • AcceleratorArn
    • AcceleratorSocketAddresses
    • DestinationSocketAddress
      • IpAddress
      • Port
    • DestinationTrafficState
    • EndpointGroupArn
    • EndpointGroupRegion
    • EndpointId
    • IpAddressType

DestinationPortMappings

DestinationPorts

EndpointAlreadyExistsException

EndpointConfiguration

  • EndpointConfiguration object: A complex type for endpoints. A resource must be valid and active when you add it as an endpoint.
    • ClientIPPreservationEnabled
    • EndpointId
    • Weight

EndpointConfigurations

EndpointDescription

  • EndpointDescription object: A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.
    • ClientIPPreservationEnabled
    • EndpointId
    • HealthReason
    • HealthState
    • Weight

EndpointDescriptions

EndpointGroup

  • EndpointGroup object: A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
    • EndpointDescriptions
    • EndpointGroupArn
    • EndpointGroupRegion
    • HealthCheckIntervalSeconds
    • HealthCheckPath
    • HealthCheckPort
    • HealthCheckProtocol
    • PortOverrides
    • ThresholdCount
    • TrafficDialPercentage

EndpointGroupAlreadyExistsException

EndpointGroupNotFoundException

EndpointGroups

EndpointIds

EndpointNotFoundException

EndpointWeight

  • EndpointWeight integer

GenericBoolean

  • GenericBoolean boolean

GenericString

  • GenericString string

HealthCheckIntervalSeconds

  • HealthCheckIntervalSeconds integer

HealthCheckPath

  • HealthCheckPath string

HealthCheckPort

  • HealthCheckPort integer

HealthCheckProtocol

  • HealthCheckProtocol string (values: TCP, HTTP, HTTPS)

HealthState

  • HealthState string (values: INITIAL, HEALTHY, UNHEALTHY)

IdempotencyToken

  • IdempotencyToken string

IncorrectCidrStateException

InternalServiceErrorException

InvalidArgumentException

InvalidNextTokenException

InvalidPortRangeException

IpAddress

  • IpAddress string

IpAddressType

  • IpAddressType string (values: IPV4)

IpAddresses

IpSet

  • IpSet object: A complex type for the set of IP addresses for an accelerator.

IpSets

  • IpSets array

LimitExceededException

ListAcceleratorsRequest

  • ListAcceleratorsRequest object
    • MaxResults
    • NextToken

ListAcceleratorsResponse

  • ListAcceleratorsResponse object

ListByoipCidrsRequest

  • ListByoipCidrsRequest object
    • MaxResults
    • NextToken

ListByoipCidrsResponse

  • ListByoipCidrsResponse object

ListCustomRoutingAcceleratorsRequest

  • ListCustomRoutingAcceleratorsRequest object
    • MaxResults
    • NextToken

ListCustomRoutingAcceleratorsResponse

ListCustomRoutingEndpointGroupsRequest

  • ListCustomRoutingEndpointGroupsRequest object
    • ListenerArn required
    • MaxResults
    • NextToken

ListCustomRoutingEndpointGroupsResponse

ListCustomRoutingListenersRequest

  • ListCustomRoutingListenersRequest object
    • AcceleratorArn required
    • MaxResults
    • NextToken

ListCustomRoutingListenersResponse

ListCustomRoutingPortMappingsByDestinationRequest

  • ListCustomRoutingPortMappingsByDestinationRequest object
    • DestinationAddress required
    • EndpointId required
    • MaxResults
    • NextToken

ListCustomRoutingPortMappingsByDestinationResponse

  • ListCustomRoutingPortMappingsByDestinationResponse object

ListCustomRoutingPortMappingsRequest

  • ListCustomRoutingPortMappingsRequest object
    • AcceleratorArn required
    • EndpointGroupArn
    • MaxResults
    • NextToken

ListCustomRoutingPortMappingsResponse

  • ListCustomRoutingPortMappingsResponse object

ListEndpointGroupsRequest

  • ListEndpointGroupsRequest object
    • ListenerArn required
    • MaxResults
    • NextToken

ListEndpointGroupsResponse

  • ListEndpointGroupsResponse object

ListListenersRequest

  • ListListenersRequest object
    • AcceleratorArn required
    • MaxResults
    • NextToken

ListListenersResponse

  • ListListenersResponse object

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • Tags

Listener

  • Listener object: A complex type for a listener.
    • ClientAffinity
    • ListenerArn
    • PortRanges
    • Protocol

ListenerNotFoundException

Listeners

MaxResults

  • MaxResults integer

PortMapping

  • PortMapping object: Returns the ports and associated IP addresses and ports of Amazon EC2 instances in your virtual private cloud (VPC) subnets. Custom routing is a port mapping protocol in AWS Global Accelerator that statically associates port ranges with VPC subnets, which allows Global Accelerator to route to specific instances and ports within one or more subnets.
    • AcceleratorPort
    • DestinationSocketAddress
      • IpAddress
      • Port
    • DestinationTrafficState
    • EndpointGroupArn
    • EndpointId
    • Protocols

PortMappings

PortMappingsMaxResults

  • PortMappingsMaxResults integer

PortNumber

  • PortNumber integer

PortOverride

  • PortOverride object:

    Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.

    For more information, see Port overrides in the AWS Global Accelerator Developer Guide.

    • EndpointPort
    • ListenerPort

PortOverrides

PortRange

  • PortRange object: A complex type for a range of ports for a listener.
    • FromPort
    • ToPort

PortRanges

Protocol

  • Protocol string (values: TCP, UDP)

Protocols

ProvisionByoipCidrRequest

  • ProvisionByoipCidrRequest object
    • Cidr required
    • CidrAuthorizationContext required
      • Message required
      • Signature required

ProvisionByoipCidrResponse

  • ProvisionByoipCidrResponse object

RemoveCustomRoutingEndpointsRequest

  • RemoveCustomRoutingEndpointsRequest object
    • EndpointGroupArn required
    • EndpointIds required

ResourceArn

  • ResourceArn string

SocketAddress

  • SocketAddress object: An IP address/port combination.
    • IpAddress
    • Port

SocketAddresses

Tag

  • Tag object: A complex type that contains a Tag key and Tag value.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeys

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

Tags

  • Tags array

ThresholdCount

  • ThresholdCount integer

Timestamp

  • Timestamp string

TrafficDialPercentage

  • TrafficDialPercentage number

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateAcceleratorAttributesRequest

  • UpdateAcceleratorAttributesRequest object
    • AcceleratorArn required
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

UpdateAcceleratorAttributesResponse

  • UpdateAcceleratorAttributesResponse object
    • AcceleratorAttributes
      • FlowLogsEnabled
      • FlowLogsS3Bucket
      • FlowLogsS3Prefix

UpdateAcceleratorRequest

  • UpdateAcceleratorRequest object
    • AcceleratorArn required
    • Enabled
    • IpAddressType
    • Name

UpdateAcceleratorResponse

  • UpdateAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

UpdateCustomRoutingAcceleratorAttributesRequest

  • UpdateCustomRoutingAcceleratorAttributesRequest object
    • AcceleratorArn required
    • FlowLogsEnabled
    • FlowLogsS3Bucket
    • FlowLogsS3Prefix

UpdateCustomRoutingAcceleratorAttributesResponse

  • UpdateCustomRoutingAcceleratorAttributesResponse object
    • AcceleratorAttributes
      • FlowLogsEnabled
      • FlowLogsS3Bucket
      • FlowLogsS3Prefix

UpdateCustomRoutingAcceleratorRequest

  • UpdateCustomRoutingAcceleratorRequest object
    • AcceleratorArn required
    • Enabled
    • IpAddressType
    • Name

UpdateCustomRoutingAcceleratorResponse

  • UpdateCustomRoutingAcceleratorResponse object
    • Accelerator
      • AcceleratorArn
      • CreatedTime
      • DnsName
      • Enabled
      • IpAddressType
      • IpSets
      • LastModifiedTime
      • Name
      • Status

UpdateCustomRoutingListenerRequest

  • UpdateCustomRoutingListenerRequest object
    • ListenerArn required
    • PortRanges required

UpdateCustomRoutingListenerResponse

  • UpdateCustomRoutingListenerResponse object
    • Listener

UpdateEndpointGroupRequest

  • UpdateEndpointGroupRequest object
    • EndpointConfigurations
    • EndpointGroupArn required
    • HealthCheckIntervalSeconds
    • HealthCheckPath
    • HealthCheckPort
    • HealthCheckProtocol
    • PortOverrides
    • ThresholdCount
    • TrafficDialPercentage

UpdateEndpointGroupResponse

  • UpdateEndpointGroupResponse object
    • EndpointGroup
      • EndpointDescriptions
      • EndpointGroupArn
      • EndpointGroupRegion
      • HealthCheckIntervalSeconds
      • HealthCheckPath
      • HealthCheckPort
      • HealthCheckProtocol
      • PortOverrides
      • ThresholdCount
      • TrafficDialPercentage

UpdateListenerRequest

  • UpdateListenerRequest object
    • ClientAffinity
    • ListenerArn required
    • PortRanges
    • Protocol

UpdateListenerResponse

  • UpdateListenerResponse object
    • Listener
      • ClientAffinity
      • ListenerArn
      • PortRanges
      • Protocol

WithdrawByoipCidrRequest

  • WithdrawByoipCidrRequest object
    • Cidr required

WithdrawByoipCidrResponse

  • WithdrawByoipCidrResponse object

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_globalaccelerator

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

2

Version

5.0.0

License

MIT

Unpacked Size

349 kB

Total Files

4

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware