globalaccelerator

package module
v1.29.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 47 Imported by: 20

Documentation

Overview

Package globalaccelerator provides the API client, operations, and parameter types for AWS Global Accelerator.

Global Accelerator

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

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 Amazon Web Services 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 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.

By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. The static IP addresses are anycast from the Amazon Web Services edge network. For IPv4, Global Accelerator provides two static IPv4 addresses. For dual-stack, Global Accelerator provides a total of four addresses: two static IPv4 addresses and two static IPv6 addresses. With a standard accelerator for IPv4, instead of using the 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 (BYOIP).

For a standard accelerator, they distribute incoming application traffic across multiple endpoint resources in multiple Amazon Web Services 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 Amazon Web Services Region or multiple Amazon Web Services 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 Amazon Web Services 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 more information about understanding and using Global Accelerator, see the Global Accelerator Developer Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-08-08"
View Source 
const ServiceID = "Global Accelerator"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.17.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.19.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.19.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AddCustomRoutingEndpointsInput added in v0.31.0 

type AddCustomRoutingEndpointsInput struct {

	// The list of endpoint objects to add to a custom routing accelerator.
	//
	// This member is required.
	EndpointConfigurations []types.CustomRoutingEndpointConfiguration

	// The Amazon Resource Name (ARN) of the endpoint group for the custom routing
	// endpoint.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type AddCustomRoutingEndpointsOutput added in v0.31.0 

type AddCustomRoutingEndpointsOutput struct {

	// The endpoint objects added to the custom routing accelerator.
	EndpointDescriptions []types.CustomRoutingEndpointDescription

	// The Amazon Resource Name (ARN) of the endpoint group for the custom routing
	// endpoint.
	EndpointGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AddEndpointsInput added in v1.15.0 

type AddEndpointsInput struct {

	// The list of endpoint objects.
	//
	// This member is required.
	EndpointConfigurations []types.EndpointConfiguration

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type AddEndpointsOutput added in v1.15.0 

type AddEndpointsOutput struct {

	// The list of endpoint objects.
	EndpointDescriptions []types.EndpointDescription

	// The Amazon Resource Name (ARN) of the endpoint group.
	EndpointGroupArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AdvertiseByoipCidrInput 

type AdvertiseByoipCidrInput struct {

	// The address range, in CIDR notation. This must be the exact range that you
	// provisioned. You can't advertise only a portion of the provisioned range.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	//
	// This member is required.
	Cidr *string
	// contains filtered or unexported fields
}

type AdvertiseByoipCidrOutput 

type AdvertiseByoipCidrOutput struct {

	// Information about the address range.
	ByoipCidr *types.ByoipCidr

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AllowCustomRoutingTrafficInput added in v0.31.0 

type AllowCustomRoutingTrafficInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// This member is required.
	EndpointGroupArn *string

	// An ID for the endpoint. For custom routing accelerators, this is the virtual
	// private cloud (VPC) subnet ID.
	//
	// This member is required.
	EndpointId *string

	// Indicates whether all destination IP addresses and ports for a specified VPC
	// subnet endpoint can receive traffic from a custom routing accelerator. The value
	// is TRUE or FALSE.
	//
	// When set to TRUE, all destinations in the custom routing VPC subnet can receive
	// traffic. Note that you cannot specify destination IP addresses and ports when
	// the value is set to TRUE.
	//
	// When set to FALSE (or not specified), you must specify a list of destination IP
	// addresses that are allowed to receive traffic. A list of ports is optional. If
	// you don't specify a list of ports, the ports that can accept traffic is the same
	// as the ports configured for the endpoint group.
	//
	// The default value is FALSE.
	AllowAllTrafficToEndpoint *bool

	// A list of specific Amazon EC2 instance IP addresses (destination addresses) in
	// a subnet that you want to allow to receive traffic. The IP addresses must be a
	// subset of the IP addresses that you specified for the endpoint group.
	//
	// DestinationAddresses is required if AllowAllTrafficToEndpoint is FALSE or is
	// not specified.
	DestinationAddresses []string

	// A list of specific Amazon EC2 instance ports (destination ports) that you want
	// to allow to receive traffic.
	DestinationPorts []int32
	// contains filtered or unexported fields
}

type AllowCustomRoutingTrafficOutput added in v0.31.0 

type AllowCustomRoutingTrafficOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.19.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.19.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client provides the API client to make operations call for AWS Global Accelerator.

func New 

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AddCustomRoutingEndpoints added in v0.31.0 

func (c *Client) AddCustomRoutingEndpoints(ctx context.Context, params *AddCustomRoutingEndpointsInput, optFns ...func(*Options)) (*AddCustomRoutingEndpointsOutput, error)

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 AllowCustomRoutingTrafficoperation.

func (*Client) AddEndpoints added in v1.15.0 

func (c *Client) AddEndpoints(ctx context.Context, params *AddEndpointsInput, optFns ...func(*Options)) (*AddEndpointsOutput, error)

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 CreateEndpointGroupAPI) or when you update an endpoint group (with the UpdateEndpointGroupAPI).

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 acceleratorsin the Global Accelerator Developer Guide.

func (*Client) AdvertiseByoipCidr 

func (c *Client) AdvertiseByoipCidr(ctx context.Context, params *AdvertiseByoipCidrInput, optFns ...func(*Options)) (*AdvertiseByoipCidrOutput, error)

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.

func (*Client) AllowCustomRoutingTraffic added in v0.31.0 

func (c *Client) AllowCustomRoutingTraffic(ctx context.Context, params *AllowCustomRoutingTrafficInput, optFns ...func(*Options)) (*AllowCustomRoutingTrafficOutput, error)

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.

func (*Client) CreateAccelerator 

func (c *Client) CreateAccelerator(ctx context.Context, params *CreateAcceleratorInput, optFns ...func(*Options)) (*CreateAcceleratorOutput, error)

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.

func (*Client) CreateCrossAccountAttachment added in v1.19.0 

func (c *Client) CreateCrossAccountAttachment(ctx context.Context, params *CreateCrossAccountAttachmentInput, optFns ...func(*Options)) (*CreateCrossAccountAttachmentOutput, error)

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.

func (*Client) CreateCustomRoutingAccelerator added in v0.31.0 

func (c *Client) CreateCustomRoutingAccelerator(ctx context.Context, params *CreateCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*CreateCustomRoutingAcceleratorOutput, error)

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.

func (*Client) CreateCustomRoutingEndpointGroup added in v0.31.0 

func (c *Client) CreateCustomRoutingEndpointGroup(ctx context.Context, params *CreateCustomRoutingEndpointGroupInput, optFns ...func(*Options)) (*CreateCustomRoutingEndpointGroupOutput, error)

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.

func (*Client) CreateCustomRoutingListener added in v0.31.0 

func (c *Client) CreateCustomRoutingListener(ctx context.Context, params *CreateCustomRoutingListenerInput, optFns ...func(*Options)) (*CreateCustomRoutingListenerOutput, error)

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.

func (*Client) CreateEndpointGroup 

func (c *Client) CreateEndpointGroup(ctx context.Context, params *CreateEndpointGroupInput, optFns ...func(*Options)) (*CreateEndpointGroupOutput, error)

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 acceleratorsin the Global Accelerator Developer Guide.

func (*Client) CreateListener 

func (c *Client) CreateListener(ctx context.Context, params *CreateListenerInput, optFns ...func(*Options)) (*CreateListenerOutput, error)

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.

func (*Client) DeleteAccelerator 

func (c *Client) DeleteAccelerator(ctx context.Context, params *DeleteAcceleratorInput, optFns ...func(*Options)) (*DeleteAcceleratorOutput, error)

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 managementin the Global Accelerator Developer Guide.

func (*Client) DeleteCrossAccountAttachment added in v1.19.0 

func (c *Client) DeleteCrossAccountAttachment(ctx context.Context, params *DeleteCrossAccountAttachmentInput, optFns ...func(*Options)) (*DeleteCrossAccountAttachmentOutput, error)

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.

func (*Client) DeleteCustomRoutingAccelerator added in v0.31.0 

func (c *Client) DeleteCustomRoutingAccelerator(ctx context.Context, params *DeleteCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*DeleteCustomRoutingAcceleratorOutput, error)

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 managementin the Global Accelerator Developer Guide.

func (*Client) DeleteCustomRoutingEndpointGroup added in v0.31.0 

func (c *Client) DeleteCustomRoutingEndpointGroup(ctx context.Context, params *DeleteCustomRoutingEndpointGroupInput, optFns ...func(*Options)) (*DeleteCustomRoutingEndpointGroupOutput, error)

Delete an endpoint group from a listener for a custom routing accelerator.

func (*Client) DeleteCustomRoutingListener added in v0.31.0 

func (c *Client) DeleteCustomRoutingListener(ctx context.Context, params *DeleteCustomRoutingListenerInput, optFns ...func(*Options)) (*DeleteCustomRoutingListenerOutput, error)

Delete a listener for a custom routing accelerator.

func (*Client) DeleteEndpointGroup 

func (c *Client) DeleteEndpointGroup(ctx context.Context, params *DeleteEndpointGroupInput, optFns ...func(*Options)) (*DeleteEndpointGroupOutput, error)

Delete an endpoint group from a listener.

func (*Client) DeleteListener 

func (c *Client) DeleteListener(ctx context.Context, params *DeleteListenerInput, optFns ...func(*Options)) (*DeleteListenerOutput, error)

Delete a listener from an accelerator.

func (*Client) DenyCustomRoutingTraffic added in v0.31.0 

func (c *Client) DenyCustomRoutingTraffic(ctx context.Context, params *DenyCustomRoutingTrafficInput, optFns ...func(*Options)) (*DenyCustomRoutingTrafficOutput, error)

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.

func (*Client) DeprovisionByoipCidr 

func (c *Client) DeprovisionByoipCidr(ctx context.Context, params *DeprovisionByoipCidrInput, optFns ...func(*Options)) (*DeprovisionByoipCidrOutput, error)

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.

func (*Client) DescribeAccelerator 

func (c *Client) DescribeAccelerator(ctx context.Context, params *DescribeAcceleratorInput, optFns ...func(*Options)) (*DescribeAcceleratorOutput, error)

Describe an accelerator.

func (*Client) DescribeAcceleratorAttributes 

func (c *Client) DescribeAcceleratorAttributes(ctx context.Context, params *DescribeAcceleratorAttributesInput, optFns ...func(*Options)) (*DescribeAcceleratorAttributesOutput, error)

Describe the attributes of an accelerator.

func (*Client) DescribeCrossAccountAttachment added in v1.19.0 

func (c *Client) DescribeCrossAccountAttachment(ctx context.Context, params *DescribeCrossAccountAttachmentInput, optFns ...func(*Options)) (*DescribeCrossAccountAttachmentOutput, error)

Gets configuration information about a cross-account attachment.

func (*Client) DescribeCustomRoutingAccelerator added in v0.31.0 

func (c *Client) DescribeCustomRoutingAccelerator(ctx context.Context, params *DescribeCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*DescribeCustomRoutingAcceleratorOutput, error)

Describe a custom routing accelerator.

func (*Client) DescribeCustomRoutingAcceleratorAttributes added in v0.31.0 

func (c *Client) DescribeCustomRoutingAcceleratorAttributes(ctx context.Context, params *DescribeCustomRoutingAcceleratorAttributesInput, optFns ...func(*Options)) (*DescribeCustomRoutingAcceleratorAttributesOutput, error)

Describe the attributes of a custom routing accelerator.

func (*Client) DescribeCustomRoutingEndpointGroup added in v0.31.0 

func (c *Client) DescribeCustomRoutingEndpointGroup(ctx context.Context, params *DescribeCustomRoutingEndpointGroupInput, optFns ...func(*Options)) (*DescribeCustomRoutingEndpointGroupOutput, error)

Describe an endpoint group for a custom routing accelerator.

func (*Client) DescribeCustomRoutingListener added in v0.31.0 

func (c *Client) DescribeCustomRoutingListener(ctx context.Context, params *DescribeCustomRoutingListenerInput, optFns ...func(*Options)) (*DescribeCustomRoutingListenerOutput, error)

The description of a listener for a custom routing accelerator.

func (*Client) DescribeEndpointGroup 

func (c *Client) DescribeEndpointGroup(ctx context.Context, params *DescribeEndpointGroupInput, optFns ...func(*Options)) (*DescribeEndpointGroupOutput, error)

Describe an endpoint group.

func (*Client) DescribeListener 

func (c *Client) DescribeListener(ctx context.Context, params *DescribeListenerInput, optFns ...func(*Options)) (*DescribeListenerOutput, error)

Describe a listener.

func (*Client) ListAccelerators 

func (c *Client) ListAccelerators(ctx context.Context, params *ListAcceleratorsInput, optFns ...func(*Options)) (*ListAcceleratorsOutput, error)

List the accelerators for an Amazon Web Services account.

func (*Client) ListByoipCidrs 

func (c *Client) ListByoipCidrs(ctx context.Context, params *ListByoipCidrsInput, optFns ...func(*Options)) (*ListByoipCidrsOutput, error)

Lists the IP address ranges that were specified in calls to ProvisionByoipCidr, including the current state and a history of state changes.

func (*Client) ListCrossAccountAttachments added in v1.19.0 

func (c *Client) ListCrossAccountAttachments(ctx context.Context, params *ListCrossAccountAttachmentsInput, optFns ...func(*Options)) (*ListCrossAccountAttachmentsOutput, error)

List the cross-account attachments that have been created in Global Accelerator.

func (*Client) ListCrossAccountResourceAccounts added in v1.19.0 

func (c *Client) ListCrossAccountResourceAccounts(ctx context.Context, params *ListCrossAccountResourceAccountsInput, optFns ...func(*Options)) (*ListCrossAccountResourceAccountsOutput, error)

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.

func (*Client) ListCrossAccountResources added in v1.19.0 

func (c *Client) ListCrossAccountResources(ctx context.Context, params *ListCrossAccountResourcesInput, optFns ...func(*Options)) (*ListCrossAccountResourcesOutput, error)

List the cross-account resources available to work with.

func (*Client) ListCustomRoutingAccelerators added in v0.31.0 

func (c *Client) ListCustomRoutingAccelerators(ctx context.Context, params *ListCustomRoutingAcceleratorsInput, optFns ...func(*Options)) (*ListCustomRoutingAcceleratorsOutput, error)

List the custom routing accelerators for an Amazon Web Services account.

func (*Client) ListCustomRoutingEndpointGroups added in v0.31.0 

func (c *Client) ListCustomRoutingEndpointGroups(ctx context.Context, params *ListCustomRoutingEndpointGroupsInput, optFns ...func(*Options)) (*ListCustomRoutingEndpointGroupsOutput, error)

List the endpoint groups that are associated with a listener for a custom routing accelerator.

func (*Client) ListCustomRoutingListeners added in v0.31.0 

func (c *Client) ListCustomRoutingListeners(ctx context.Context, params *ListCustomRoutingListenersInput, optFns ...func(*Options)) (*ListCustomRoutingListenersOutput, error)

List the listeners for a custom routing accelerator.

func (*Client) ListCustomRoutingPortMappings added in v0.31.0 

func (c *Client) ListCustomRoutingPortMappings(ctx context.Context, params *ListCustomRoutingPortMappingsInput, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsOutput, error)

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.

func (*Client) ListCustomRoutingPortMappingsByDestination added in v0.31.0 

func (c *Client) ListCustomRoutingPortMappingsByDestination(ctx context.Context, params *ListCustomRoutingPortMappingsByDestinationInput, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsByDestinationOutput, error)

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.

func (*Client) ListEndpointGroups 

func (c *Client) ListEndpointGroups(ctx context.Context, params *ListEndpointGroupsInput, optFns ...func(*Options)) (*ListEndpointGroupsOutput, error)

List the endpoint groups that are associated with a listener.

func (*Client) ListListeners 

func (c *Client) ListListeners(ctx context.Context, params *ListListenersInput, optFns ...func(*Options)) (*ListListenersOutput, error)

List the listeners for an accelerator.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List all tags for an accelerator.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

func (*Client) Options added in v1.20.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) ProvisionByoipCidr 

func (c *Client) ProvisionByoipCidr(ctx context.Context, params *ProvisionByoipCidrInput, optFns ...func(*Options)) (*ProvisionByoipCidrOutput, error)

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.

func (*Client) RemoveCustomRoutingEndpoints added in v0.31.0 

func (c *Client) RemoveCustomRoutingEndpoints(ctx context.Context, params *RemoveCustomRoutingEndpointsInput, optFns ...func(*Options)) (*RemoveCustomRoutingEndpointsOutput, error)

Remove endpoints from a custom routing accelerator.

func (*Client) RemoveEndpoints added in v1.15.0 

func (c *Client) RemoveEndpoints(ctx context.Context, params *RemoveEndpointsInput, optFns ...func(*Options)) (*RemoveEndpointsOutput, error)

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 UpdateEndpointGroupAPI 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.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Add tags to an accelerator resource.

For more information, see Tagging in Global Accelerator in the Global Accelerator Developer Guide.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

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.

func (*Client) UpdateAccelerator 

func (c *Client) UpdateAccelerator(ctx context.Context, params *UpdateAcceleratorInput, optFns ...func(*Options)) (*UpdateAcceleratorOutput, error)

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.

func (*Client) UpdateAcceleratorAttributes 

func (c *Client) UpdateAcceleratorAttributes(ctx context.Context, params *UpdateAcceleratorAttributesInput, optFns ...func(*Options)) (*UpdateAcceleratorAttributesOutput, error)

Update the attributes for an accelerator.

func (*Client) UpdateCrossAccountAttachment added in v1.19.0 

func (c *Client) UpdateCrossAccountAttachment(ctx context.Context, params *UpdateCrossAccountAttachmentInput, optFns ...func(*Options)) (*UpdateCrossAccountAttachmentOutput, error)

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.

func (*Client) UpdateCustomRoutingAccelerator added in v0.31.0 

func (c *Client) UpdateCustomRoutingAccelerator(ctx context.Context, params *UpdateCustomRoutingAcceleratorInput, optFns ...func(*Options)) (*UpdateCustomRoutingAcceleratorOutput, error)

Update a custom routing accelerator.

func (*Client) UpdateCustomRoutingAcceleratorAttributes added in v0.31.0 

func (c *Client) UpdateCustomRoutingAcceleratorAttributes(ctx context.Context, params *UpdateCustomRoutingAcceleratorAttributesInput, optFns ...func(*Options)) (*UpdateCustomRoutingAcceleratorAttributesOutput, error)

Update the attributes for a custom routing accelerator.

func (*Client) UpdateCustomRoutingListener added in v0.31.0 

func (c *Client) UpdateCustomRoutingListener(ctx context.Context, params *UpdateCustomRoutingListenerInput, optFns ...func(*Options)) (*UpdateCustomRoutingListenerOutput, error)

Update a listener for a custom routing accelerator.

func (*Client) UpdateEndpointGroup 

func (c *Client) UpdateEndpointGroup(ctx context.Context, params *UpdateEndpointGroupInput, optFns ...func(*Options)) (*UpdateEndpointGroupOutput, error)

Update an endpoint group. A resource must be valid and active when you add it as an endpoint.

func (*Client) UpdateListener 

func (c *Client) UpdateListener(ctx context.Context, params *UpdateListenerInput, optFns ...func(*Options)) (*UpdateListenerOutput, error)

Update a listener.

func (*Client) WithdrawByoipCidr 

func (c *Client) WithdrawByoipCidr(ctx context.Context, params *WithdrawByoipCidrInput, optFns ...func(*Options)) (*WithdrawByoipCidrOutput, error)

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.

type CreateAcceleratorInput 

type CreateAcceleratorInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of an accelerator.
	//
	// This member is required.
	IdempotencyToken *string

	// The name of the accelerator. The name can have a maximum of 64 characters, must
	// contain only alphanumeric characters, periods (.), or hyphens (-), and must not
	// begin or end with a hyphen or period.
	//
	// This member is required.
	Name *string

	// Indicates whether an accelerator is enabled. The value is true or false. The
	// default value is true.
	//
	// If the value is set to true, an accelerator cannot be deleted. If set to false,
	// the accelerator can be deleted.
	Enabled *bool

	// The IP address type that an accelerator supports. For a standard accelerator,
	// the value can be IPV4 or DUAL_STACK.
	IpAddressType types.IpAddressType

	// Optionally, if you've added your own IP address pool to Global Accelerator
	// (BYOIP), you can choose an IPv4 address from your own pool to use for the
	// accelerator's static IPv4 address when you create an accelerator.
	//
	// After you bring an address range to Amazon Web Services, it appears in your
	// account as an address pool. When you create an accelerator, you can assign one
	// IPv4 address from your range to it. Global Accelerator assigns you a second
	// static IPv4 address from an Amazon IP address range. If you bring two IPv4
	// address ranges to Amazon Web Services, you can assign one IPv4 address from each
	// range to your accelerator. This restriction is because Global Accelerator
	// assigns each address range to a different network zone, for high availability.
	//
	// You can specify one or two addresses, separated by a space. Do not include the
	// /32 suffix.
	//
	// Note that you can't update IP addresses for an existing accelerator. To change
	// them, you must create a new accelerator with the new addresses.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	IpAddresses []string

	// Create tags for an accelerator.
	//
	// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide.
	//
	// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateAcceleratorOutput 

type CreateAcceleratorOutput struct {

	// The accelerator that is created by specifying a listener and the supported IP
	// address types.
	Accelerator *types.Accelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCrossAccountAttachmentInput added in v1.19.0 

type CreateCrossAccountAttachmentInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The name of the cross-account attachment.
	//
	// This member is required.
	Name *string

	// The principals to include in the cross-account attachment. A principal can be
	// an Amazon Web Services account number or the Amazon Resource Name (ARN) for an
	// accelerator.
	Principals []string

	// The Amazon Resource Names (ARNs) for the resources to include in the
	// cross-account attachment. A resource can be any supported Amazon Web Services
	// resource type for Global Accelerator or a CIDR range for a bring your own IP
	// address (BYOIP) address pool.
	Resources []types.Resource

	// Add tags for a cross-account attachment.
	//
	// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide.
	//
	// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCrossAccountAttachmentOutput added in v1.19.0 

type CreateCrossAccountAttachmentOutput struct {

	// Information about the cross-account attachment.
	CrossAccountAttachment *types.Attachment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomRoutingAcceleratorInput added in v0.31.0 

type CreateCustomRoutingAcceleratorInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The name of a custom routing accelerator. The name can have a maximum of 64
	// characters, must contain only alphanumeric characters or hyphens (-), and must
	// not begin or end with a hyphen.
	//
	// This member is required.
	Name *string

	// Indicates whether an accelerator is enabled. The value is true or false. The
	// default value is true.
	//
	// If the value is set to true, an accelerator cannot be deleted. If set to false,
	// the accelerator can be deleted.
	Enabled *bool

	// The IP address type that an accelerator supports. For a custom routing
	// accelerator, the value must be IPV4.
	IpAddressType types.IpAddressType

	// Optionally, if you've added your own IP address pool to Global Accelerator
	// (BYOIP), you can choose an IPv4 address from your own pool to use for the
	// accelerator's static IPv4 address when you create an accelerator.
	//
	// After you bring an address range to Amazon Web Services, it appears in your
	// account as an address pool. When you create an accelerator, you can assign one
	// IPv4 address from your range to it. Global Accelerator assigns you a second
	// static IPv4 address from an Amazon IP address range. If you bring two IPv4
	// address ranges to Amazon Web Services, you can assign one IPv4 address from each
	// range to your accelerator. This restriction is because Global Accelerator
	// assigns each address range to a different network zone, for high availability.
	//
	// You can specify one or two addresses, separated by a space. Do not include the
	// /32 suffix.
	//
	// Note that you can't update IP addresses for an existing accelerator. To change
	// them, you must create a new accelerator with the new addresses.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	IpAddresses []string

	// Create tags for an accelerator.
	//
	// For more information, see [Tagging in Global Accelerator] in the Global Accelerator Developer Guide.
	//
	// [Tagging in Global Accelerator]: https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateCustomRoutingAcceleratorOutput added in v0.31.0 

type CreateCustomRoutingAcceleratorOutput struct {

	// The accelerator that is created.
	Accelerator *types.CustomRoutingAccelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomRoutingEndpointGroupInput added in v0.31.0 

type CreateCustomRoutingEndpointGroupInput struct {

	// Sets the port range and protocol for all endpoints (virtual private cloud
	// subnets) in a custom routing endpoint group to accept client traffic on.
	//
	// This member is required.
	DestinationConfigurations []types.CustomRoutingDestinationConfiguration

	// The Amazon Web Services Region where the endpoint group is located. A listener
	// can have only one endpoint group in a specific Region.
	//
	// This member is required.
	EndpointGroupRegion *string

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
	//
	// This member is required.
	ListenerArn *string
	// contains filtered or unexported fields
}

type CreateCustomRoutingEndpointGroupOutput added in v0.31.0 

type CreateCustomRoutingEndpointGroupOutput struct {

	// The information about the endpoint group created for a custom routing
	// accelerator.
	EndpointGroup *types.CustomRoutingEndpointGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateCustomRoutingListenerInput added in v0.31.0 

type CreateCustomRoutingListenerInput struct {

	// The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
	//
	// This member is required.
	AcceleratorArn *string

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The port range to support for connections from clients to your accelerator.
	//
	// Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators].
	//
	// [About endpoints for custom routing accelerators]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html
	//
	// This member is required.
	PortRanges []types.PortRange
	// contains filtered or unexported fields
}

type CreateCustomRoutingListenerOutput added in v0.31.0 

type CreateCustomRoutingListenerOutput struct {

	// The listener that you've created for a custom routing accelerator.
	Listener *types.CustomRoutingListener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateEndpointGroupInput 

type CreateEndpointGroupInput struct {

	// The Amazon Web Services Region where the endpoint group is located. A listener
	// can have only one endpoint group in a specific Region.
	//
	// This member is required.
	EndpointGroupRegion *string

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The Amazon Resource Name (ARN) of the listener.
	//
	// This member is required.
	ListenerArn *string

	// The list of endpoint objects.
	EndpointConfigurations []types.EndpointConfiguration

	// The time—10 seconds or 30 seconds—between each health check for an endpoint.
	// The default value is 30.
	HealthCheckIntervalSeconds *int32

	// If the protocol is HTTP/S, then this specifies the path that is the destination
	// for health check targets. The default value is slash (/).
	HealthCheckPath *string

	// The port that Global Accelerator uses to check the health of endpoints that are
	// part of this endpoint group. The default port is the listener port that this
	// endpoint group is associated with. If listener port is a list of ports, Global
	// Accelerator uses the first port in the list.
	HealthCheckPort *int32

	// The protocol that Global Accelerator uses to check the health of endpoints that
	// are part of this endpoint group. The default value is TCP.
	HealthCheckProtocol types.HealthCheckProtocol

	// Override specific listener ports used to route traffic to endpoints that are
	// part of this endpoint group. For example, you can create a port override in
	// which the listener receives user traffic on ports 80 and 443, but your
	// accelerator routes that traffic to ports 1080 and 1443, respectively, on the
	// endpoints.
	//
	// For more information, see [Overriding listener ports] in the Global Accelerator Developer Guide.
	//
	// [Overriding listener ports]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html
	PortOverrides []types.PortOverride

	// The number of consecutive health checks required to set the state of a healthy
	// endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default
	// value is 3.
	ThresholdCount *int32

	// The percentage of traffic to send to an Amazon Web Services Region. Additional
	// traffic is distributed to other endpoint groups for this listener.
	//
	// Use this action to increase (dial up) or decrease (dial down) traffic to a
	// specific Region. The percentage is applied to the traffic that would otherwise
	// have been routed to the Region based on optimal routing.
	//
	// The default value is 100.
	TrafficDialPercentage *float32
	// contains filtered or unexported fields
}

type CreateEndpointGroupOutput 

type CreateEndpointGroupOutput struct {

	// The information about the endpoint group that was created.
	EndpointGroup *types.EndpointGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateListenerInput 

type CreateListenerInput struct {

	// The Amazon Resource Name (ARN) of your accelerator.
	//
	// This member is required.
	AcceleratorArn *string

	// A unique, case-sensitive identifier that you provide to ensure the
	// idempotency—that is, the uniqueness—of the request.
	//
	// This member is required.
	IdempotencyToken *string

	// The list of port ranges to support for connections from clients to your
	// accelerator.
	//
	// This member is required.
	PortRanges []types.PortRange

	// The protocol for connections from clients to your accelerator.
	//
	// This member is required.
	Protocol types.Protocol

	// Client affinity lets you direct all requests from a user to the same endpoint,
	// if you have stateful applications, regardless of the port and protocol of the
	// client request. Client affinity gives you control over whether to always route
	// each client to the same specific endpoint.
	//
	// Global Accelerator uses a consistent-flow hashing algorithm to choose the
	// optimal endpoint for a connection. If client affinity is NONE , Global
	// Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source
	// port, destination IP address, destination port, and protocol—to select the hash
	// value, and then chooses the best endpoint. However, with this setting, if
	// someone uses different ports to connect to Global Accelerator, their connections
	// might not be always routed to the same endpoint because the hash value changes.
	//
	// If you want a given client to always be routed to the same endpoint, set client
	// affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global
	// Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP
	// address and destination IP address—to select the hash value.
	//
	// The default value is NONE .
	ClientAffinity types.ClientAffinity
	// contains filtered or unexported fields
}

type CreateListenerOutput 

type CreateListenerOutput struct {

	// The listener that you've created.
	Listener *types.Listener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteAcceleratorInput 

type DeleteAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of an accelerator.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DeleteAcceleratorOutput 

type DeleteAcceleratorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCrossAccountAttachmentInput added in v1.19.0 

type DeleteCrossAccountAttachmentInput struct {

	// The Amazon Resource Name (ARN) for the cross-account attachment to delete.
	//
	// This member is required.
	AttachmentArn *string
	// contains filtered or unexported fields
}

type DeleteCrossAccountAttachmentOutput added in v1.19.0 

type DeleteCrossAccountAttachmentOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomRoutingAcceleratorInput added in v0.31.0 

type DeleteCustomRoutingAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the custom routing accelerator to delete.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DeleteCustomRoutingAcceleratorOutput added in v0.31.0 

type DeleteCustomRoutingAcceleratorOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomRoutingEndpointGroupInput added in v0.31.0 

type DeleteCustomRoutingEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to delete.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type DeleteCustomRoutingEndpointGroupOutput added in v0.31.0 

type DeleteCustomRoutingEndpointGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteCustomRoutingListenerInput added in v0.31.0 

type DeleteCustomRoutingListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to delete.
	//
	// This member is required.
	ListenerArn *string
	// contains filtered or unexported fields
}

type DeleteCustomRoutingListenerOutput added in v0.31.0 

type DeleteCustomRoutingListenerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteEndpointGroupInput 

type DeleteEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to delete.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type DeleteEndpointGroupOutput 

type DeleteEndpointGroupOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteListenerInput 

type DeleteListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	//
	// This member is required.
	ListenerArn *string
	// contains filtered or unexported fields
}

type DeleteListenerOutput 

type DeleteListenerOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DenyCustomRoutingTrafficInput added in v0.31.0 

type DenyCustomRoutingTrafficInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// This member is required.
	EndpointGroupArn *string

	// An ID for the endpoint. For custom routing accelerators, this is the virtual
	// private cloud (VPC) subnet ID.
	//
	// This member is required.
	EndpointId *string

	// Indicates whether all destination IP addresses and ports for a specified VPC
	// subnet endpoint cannot receive traffic from a custom routing accelerator. The
	// value is TRUE or FALSE.
	//
	// When set to TRUE, no destinations in the custom routing VPC subnet can receive
	// traffic. Note that you cannot specify destination IP addresses and ports when
	// the value is set to TRUE.
	//
	// When set to FALSE (or not specified), you must specify a list of destination IP
	// addresses that cannot receive traffic. A list of ports is optional. If you don't
	// specify a list of ports, the ports that can accept traffic is the same as the
	// ports configured for the endpoint group.
	//
	// The default value is FALSE.
	DenyAllTrafficToEndpoint *bool

	// A list of specific Amazon EC2 instance IP addresses (destination addresses) in
	// a subnet that you want to prevent from receiving traffic. The IP addresses must
	// be a subset of the IP addresses allowed for the VPC subnet associated with the
	// endpoint group.
	DestinationAddresses []string

	// A list of specific Amazon EC2 instance ports (destination ports) in a subnet
	// endpoint that you want to prevent from receiving traffic.
	DestinationPorts []int32
	// contains filtered or unexported fields
}

type DenyCustomRoutingTrafficOutput added in v0.31.0 

type DenyCustomRoutingTrafficOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeprovisionByoipCidrInput 

type DeprovisionByoipCidrInput struct {

	// The address range, in CIDR notation. The prefix must be the same prefix that
	// you specified when you provisioned the address range.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	//
	// This member is required.
	Cidr *string
	// contains filtered or unexported fields
}

type DeprovisionByoipCidrOutput 

type DeprovisionByoipCidrOutput struct {

	// Information about the address range.
	ByoipCidr *types.ByoipCidr

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAcceleratorAttributesInput 

type DescribeAcceleratorAttributesInput struct {

	// The Amazon Resource Name (ARN) of the accelerator with the attributes that you
	// want to describe.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DescribeAcceleratorAttributesOutput 

type DescribeAcceleratorAttributesOutput struct {

	// The attributes of the accelerator.
	AcceleratorAttributes *types.AcceleratorAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeAcceleratorInput 

type DescribeAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to describe.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DescribeAcceleratorOutput 

type DescribeAcceleratorOutput struct {

	// The description of the accelerator.
	Accelerator *types.Accelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCrossAccountAttachmentInput added in v1.19.0 

type DescribeCrossAccountAttachmentInput struct {

	// The Amazon Resource Name (ARN) for the cross-account attachment to describe.
	//
	// This member is required.
	AttachmentArn *string
	// contains filtered or unexported fields
}

type DescribeCrossAccountAttachmentOutput added in v1.19.0 

type DescribeCrossAccountAttachmentOutput struct {

	// Information about the cross-account attachment.
	CrossAccountAttachment *types.Attachment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomRoutingAcceleratorAttributesInput added in v0.31.0 

type DescribeCustomRoutingAcceleratorAttributesInput struct {

	// The Amazon Resource Name (ARN) of the custom routing accelerator to describe
	// the attributes for.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DescribeCustomRoutingAcceleratorAttributesOutput added in v0.31.0 

type DescribeCustomRoutingAcceleratorAttributesOutput struct {

	// The attributes of the custom routing accelerator.
	AcceleratorAttributes *types.CustomRoutingAcceleratorAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomRoutingAcceleratorInput added in v0.31.0 

type DescribeCustomRoutingAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to describe.
	//
	// This member is required.
	AcceleratorArn *string
	// contains filtered or unexported fields
}

type DescribeCustomRoutingAcceleratorOutput added in v0.31.0 

type DescribeCustomRoutingAcceleratorOutput struct {

	// The description of the custom routing accelerator.
	Accelerator *types.CustomRoutingAccelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomRoutingEndpointGroupInput added in v0.31.0 

type DescribeCustomRoutingEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to describe.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type DescribeCustomRoutingEndpointGroupOutput added in v0.31.0 

type DescribeCustomRoutingEndpointGroupOutput struct {

	// The description of an endpoint group for a custom routing accelerator.
	EndpointGroup *types.CustomRoutingEndpointGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeCustomRoutingListenerInput added in v0.31.0 

type DescribeCustomRoutingListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to describe.
	//
	// This member is required.
	ListenerArn *string
	// contains filtered or unexported fields
}

type DescribeCustomRoutingListenerOutput added in v0.31.0 

type DescribeCustomRoutingListenerOutput struct {

	// The description of a listener for a custom routing accelerator.
	Listener *types.CustomRoutingListener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeEndpointGroupInput 

type DescribeEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to describe.
	//
	// This member is required.
	EndpointGroupArn *string
	// contains filtered or unexported fields
}

type DescribeEndpointGroupOutput 

type DescribeEndpointGroupOutput struct {

	// The description of an endpoint group.
	EndpointGroup *types.EndpointGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DescribeListenerInput 

type DescribeListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to describe.
	//
	// This member is required.
	ListenerArn *string
	// contains filtered or unexported fields
}

type DescribeListenerOutput 

type DescribeListenerOutput struct {

	// The description of a listener.
	Listener *types.Listener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.17.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.17.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.17.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.17.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.17.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider 

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListAcceleratorsAPIClient added in v0.31.0 

type ListAcceleratorsAPIClient interface {
	ListAccelerators(context.Context, *ListAcceleratorsInput, ...func(*Options)) (*ListAcceleratorsOutput, error)
}

ListAcceleratorsAPIClient is a client that implements the ListAccelerators operation.

type ListAcceleratorsInput 

type ListAcceleratorsInput struct {

	// The number of Global Accelerator objects that you want to return with this
	// call. The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListAcceleratorsOutput 

type ListAcceleratorsOutput struct {

	// The list of accelerators for a customer account.
	Accelerators []types.Accelerator

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAcceleratorsPaginator added in v0.31.0 

type ListAcceleratorsPaginator struct {
	// contains filtered or unexported fields
}

ListAcceleratorsPaginator is a paginator for ListAccelerators

func NewListAcceleratorsPaginator added in v0.31.0 

func NewListAcceleratorsPaginator(client ListAcceleratorsAPIClient, params *ListAcceleratorsInput, optFns ...func(*ListAcceleratorsPaginatorOptions)) *ListAcceleratorsPaginator

NewListAcceleratorsPaginator returns a new ListAcceleratorsPaginator

func (*ListAcceleratorsPaginator) HasMorePages added in v0.31.0 

func (p *ListAcceleratorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAcceleratorsPaginator) NextPage added in v0.31.0 

func (p *ListAcceleratorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAcceleratorsOutput, error)

NextPage retrieves the next ListAccelerators page.

type ListAcceleratorsPaginatorOptions added in v0.31.0 

type ListAcceleratorsPaginatorOptions struct {
	// The number of Global Accelerator objects that you want to return with this
	// call. The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAcceleratorsPaginatorOptions is the paginator options for ListAccelerators

type ListByoipCidrsAPIClient added in v0.31.0 

type ListByoipCidrsAPIClient interface {
	ListByoipCidrs(context.Context, *ListByoipCidrsInput, ...func(*Options)) (*ListByoipCidrsOutput, error)
}

ListByoipCidrsAPIClient is a client that implements the ListByoipCidrs operation.

type ListByoipCidrsInput 

type ListByoipCidrsInput struct {

	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	MaxResults *int32

	// The token for the next page of results.
	NextToken *string
	// contains filtered or unexported fields
}

type ListByoipCidrsOutput 

type ListByoipCidrsOutput struct {

	// Information about your address ranges.
	ByoipCidrs []types.ByoipCidr

	// The token for the next page of results.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListByoipCidrsPaginator added in v0.31.0 

type ListByoipCidrsPaginator struct {
	// contains filtered or unexported fields
}

ListByoipCidrsPaginator is a paginator for ListByoipCidrs

func NewListByoipCidrsPaginator added in v0.31.0 

func NewListByoipCidrsPaginator(client ListByoipCidrsAPIClient, params *ListByoipCidrsInput, optFns ...func(*ListByoipCidrsPaginatorOptions)) *ListByoipCidrsPaginator

NewListByoipCidrsPaginator returns a new ListByoipCidrsPaginator

func (*ListByoipCidrsPaginator) HasMorePages added in v0.31.0 

func (p *ListByoipCidrsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListByoipCidrsPaginator) NextPage added in v0.31.0 

func (p *ListByoipCidrsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListByoipCidrsOutput, error)

NextPage retrieves the next ListByoipCidrs page.

type ListByoipCidrsPaginatorOptions added in v0.31.0 

type ListByoipCidrsPaginatorOptions struct {
	// The maximum number of results to return with a single call. To retrieve the
	// remaining results, make another call with the returned nextToken value.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListByoipCidrsPaginatorOptions is the paginator options for ListByoipCidrs

type ListCrossAccountAttachmentsAPIClient added in v1.19.0 

type ListCrossAccountAttachmentsAPIClient interface {
	ListCrossAccountAttachments(context.Context, *ListCrossAccountAttachmentsInput, ...func(*Options)) (*ListCrossAccountAttachmentsOutput, error)
}

ListCrossAccountAttachmentsAPIClient is a client that implements the ListCrossAccountAttachments operation.

type ListCrossAccountAttachmentsInput added in v1.19.0 

type ListCrossAccountAttachmentsInput struct {

	// The number of cross-account attachment objects that you want to return with
	// this call. The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCrossAccountAttachmentsOutput added in v1.19.0 

type ListCrossAccountAttachmentsOutput struct {

	// Information about the cross-account attachments.
	CrossAccountAttachments []types.Attachment

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCrossAccountAttachmentsPaginator added in v1.19.0 

type ListCrossAccountAttachmentsPaginator struct {
	// contains filtered or unexported fields
}

ListCrossAccountAttachmentsPaginator is a paginator for ListCrossAccountAttachments

func NewListCrossAccountAttachmentsPaginator added in v1.19.0 

func NewListCrossAccountAttachmentsPaginator(client ListCrossAccountAttachmentsAPIClient, params *ListCrossAccountAttachmentsInput, optFns ...func(*ListCrossAccountAttachmentsPaginatorOptions)) *ListCrossAccountAttachmentsPaginator

NewListCrossAccountAttachmentsPaginator returns a new ListCrossAccountAttachmentsPaginator

func (*ListCrossAccountAttachmentsPaginator) HasMorePages added in v1.19.0 

func (p *ListCrossAccountAttachmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCrossAccountAttachmentsPaginator) NextPage added in v1.19.0 

func (p *ListCrossAccountAttachmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCrossAccountAttachmentsOutput, error)

NextPage retrieves the next ListCrossAccountAttachments page.

type ListCrossAccountAttachmentsPaginatorOptions added in v1.19.0 

type ListCrossAccountAttachmentsPaginatorOptions struct {
	// The number of cross-account attachment objects that you want to return with
	// this call. The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCrossAccountAttachmentsPaginatorOptions is the paginator options for ListCrossAccountAttachments

type ListCrossAccountResourceAccountsInput added in v1.19.0 

type ListCrossAccountResourceAccountsInput struct {
	// contains filtered or unexported fields
}

type ListCrossAccountResourceAccountsOutput added in v1.19.0 

type ListCrossAccountResourceAccountsOutput struct {

	// The account IDs of principals (resource owners) in a cross-account attachment
	// who can work with resources listed in the same attachment.
	ResourceOwnerAwsAccountIds []string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCrossAccountResourcesAPIClient added in v1.19.0 

type ListCrossAccountResourcesAPIClient interface {
	ListCrossAccountResources(context.Context, *ListCrossAccountResourcesInput, ...func(*Options)) (*ListCrossAccountResourcesOutput, error)
}

ListCrossAccountResourcesAPIClient is a client that implements the ListCrossAccountResources operation.

type ListCrossAccountResourcesInput added in v1.19.0 

type ListCrossAccountResourcesInput struct {

	// The account ID of a resource owner in a cross-account attachment.
	//
	// This member is required.
	ResourceOwnerAwsAccountId *string

	// The Amazon Resource Name (ARN) of an accelerator in a cross-account attachment.
	AcceleratorArn *string

	// The number of cross-account resource objects that you want to return with this
	// call. The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCrossAccountResourcesOutput added in v1.19.0 

type ListCrossAccountResourcesOutput struct {

	// The cross-account resources used with an accelerator.
	CrossAccountResources []types.CrossAccountResource

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCrossAccountResourcesPaginator added in v1.19.0 

type ListCrossAccountResourcesPaginator struct {
	// contains filtered or unexported fields
}

ListCrossAccountResourcesPaginator is a paginator for ListCrossAccountResources

func NewListCrossAccountResourcesPaginator added in v1.19.0 

func NewListCrossAccountResourcesPaginator(client ListCrossAccountResourcesAPIClient, params *ListCrossAccountResourcesInput, optFns ...func(*ListCrossAccountResourcesPaginatorOptions)) *ListCrossAccountResourcesPaginator

NewListCrossAccountResourcesPaginator returns a new ListCrossAccountResourcesPaginator

func (*ListCrossAccountResourcesPaginator) HasMorePages added in v1.19.0 

func (p *ListCrossAccountResourcesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCrossAccountResourcesPaginator) NextPage added in v1.19.0 

func (p *ListCrossAccountResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCrossAccountResourcesOutput, error)

NextPage retrieves the next ListCrossAccountResources page.

type ListCrossAccountResourcesPaginatorOptions added in v1.19.0 

type ListCrossAccountResourcesPaginatorOptions struct {
	// The number of cross-account resource objects that you want to return with this
	// call. The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCrossAccountResourcesPaginatorOptions is the paginator options for ListCrossAccountResources

type ListCustomRoutingAcceleratorsAPIClient added in v0.31.0 

type ListCustomRoutingAcceleratorsAPIClient interface {
	ListCustomRoutingAccelerators(context.Context, *ListCustomRoutingAcceleratorsInput, ...func(*Options)) (*ListCustomRoutingAcceleratorsOutput, error)
}

ListCustomRoutingAcceleratorsAPIClient is a client that implements the ListCustomRoutingAccelerators operation.

type ListCustomRoutingAcceleratorsInput added in v0.31.0 

type ListCustomRoutingAcceleratorsInput struct {

	// The number of custom routing Global Accelerator objects that you want to return
	// with this call. The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomRoutingAcceleratorsOutput added in v0.31.0 

type ListCustomRoutingAcceleratorsOutput struct {

	// The list of custom routing accelerators for a customer account.
	Accelerators []types.CustomRoutingAccelerator

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomRoutingAcceleratorsPaginator added in v0.31.0 

type ListCustomRoutingAcceleratorsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomRoutingAcceleratorsPaginator is a paginator for ListCustomRoutingAccelerators

func NewListCustomRoutingAcceleratorsPaginator added in v0.31.0 

func NewListCustomRoutingAcceleratorsPaginator(client ListCustomRoutingAcceleratorsAPIClient, params *ListCustomRoutingAcceleratorsInput, optFns ...func(*ListCustomRoutingAcceleratorsPaginatorOptions)) *ListCustomRoutingAcceleratorsPaginator

NewListCustomRoutingAcceleratorsPaginator returns a new ListCustomRoutingAcceleratorsPaginator

func (*ListCustomRoutingAcceleratorsPaginator) HasMorePages added in v0.31.0 

func (p *ListCustomRoutingAcceleratorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomRoutingAcceleratorsPaginator) NextPage added in v0.31.0 

func (p *ListCustomRoutingAcceleratorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomRoutingAcceleratorsOutput, error)

NextPage retrieves the next ListCustomRoutingAccelerators page.

type ListCustomRoutingAcceleratorsPaginatorOptions added in v0.31.0 

type ListCustomRoutingAcceleratorsPaginatorOptions struct {
	// The number of custom routing Global Accelerator objects that you want to return
	// with this call. The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomRoutingAcceleratorsPaginatorOptions is the paginator options for ListCustomRoutingAccelerators

type ListCustomRoutingEndpointGroupsAPIClient added in v0.31.0 

type ListCustomRoutingEndpointGroupsAPIClient interface {
	ListCustomRoutingEndpointGroups(context.Context, *ListCustomRoutingEndpointGroupsInput, ...func(*Options)) (*ListCustomRoutingEndpointGroupsOutput, error)
}

ListCustomRoutingEndpointGroupsAPIClient is a client that implements the ListCustomRoutingEndpointGroups operation.

type ListCustomRoutingEndpointGroupsInput added in v0.31.0 

type ListCustomRoutingEndpointGroupsInput struct {

	// The Amazon Resource Name (ARN) of the listener to list endpoint groups for.
	//
	// This member is required.
	ListenerArn *string

	// The number of endpoint group objects that you want to return with this call.
	// The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomRoutingEndpointGroupsOutput added in v0.31.0 

type ListCustomRoutingEndpointGroupsOutput struct {

	// The list of the endpoint groups associated with a listener for a custom routing
	// accelerator.
	EndpointGroups []types.CustomRoutingEndpointGroup

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomRoutingEndpointGroupsPaginator added in v0.31.0 

type ListCustomRoutingEndpointGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomRoutingEndpointGroupsPaginator is a paginator for ListCustomRoutingEndpointGroups

func NewListCustomRoutingEndpointGroupsPaginator added in v0.31.0 

func NewListCustomRoutingEndpointGroupsPaginator(client ListCustomRoutingEndpointGroupsAPIClient, params *ListCustomRoutingEndpointGroupsInput, optFns ...func(*ListCustomRoutingEndpointGroupsPaginatorOptions)) *ListCustomRoutingEndpointGroupsPaginator

NewListCustomRoutingEndpointGroupsPaginator returns a new ListCustomRoutingEndpointGroupsPaginator

func (*ListCustomRoutingEndpointGroupsPaginator) HasMorePages added in v0.31.0 

func (p *ListCustomRoutingEndpointGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomRoutingEndpointGroupsPaginator) NextPage added in v0.31.0 

func (p *ListCustomRoutingEndpointGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomRoutingEndpointGroupsOutput, error)

NextPage retrieves the next ListCustomRoutingEndpointGroups page.

type ListCustomRoutingEndpointGroupsPaginatorOptions added in v0.31.0 

type ListCustomRoutingEndpointGroupsPaginatorOptions struct {
	// The number of endpoint group objects that you want to return with this call.
	// The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomRoutingEndpointGroupsPaginatorOptions is the paginator options for ListCustomRoutingEndpointGroups

type ListCustomRoutingListenersAPIClient added in v0.31.0 

type ListCustomRoutingListenersAPIClient interface {
	ListCustomRoutingListeners(context.Context, *ListCustomRoutingListenersInput, ...func(*Options)) (*ListCustomRoutingListenersOutput, error)
}

ListCustomRoutingListenersAPIClient is a client that implements the ListCustomRoutingListeners operation.

type ListCustomRoutingListenersInput added in v0.31.0 

type ListCustomRoutingListenersInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to list listeners for.
	//
	// This member is required.
	AcceleratorArn *string

	// The number of listener objects that you want to return with this call. The
	// default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomRoutingListenersOutput added in v0.31.0 

type ListCustomRoutingListenersOutput struct {

	// The list of listeners for a custom routing accelerator.
	Listeners []types.CustomRoutingListener

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomRoutingListenersPaginator added in v0.31.0 

type ListCustomRoutingListenersPaginator struct {
	// contains filtered or unexported fields
}

ListCustomRoutingListenersPaginator is a paginator for ListCustomRoutingListeners

func NewListCustomRoutingListenersPaginator added in v0.31.0 

func NewListCustomRoutingListenersPaginator(client ListCustomRoutingListenersAPIClient, params *ListCustomRoutingListenersInput, optFns ...func(*ListCustomRoutingListenersPaginatorOptions)) *ListCustomRoutingListenersPaginator

NewListCustomRoutingListenersPaginator returns a new ListCustomRoutingListenersPaginator

func (*ListCustomRoutingListenersPaginator) HasMorePages added in v0.31.0 

func (p *ListCustomRoutingListenersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomRoutingListenersPaginator) NextPage added in v0.31.0 

func (p *ListCustomRoutingListenersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomRoutingListenersOutput, error)

NextPage retrieves the next ListCustomRoutingListeners page.

type ListCustomRoutingListenersPaginatorOptions added in v0.31.0 

type ListCustomRoutingListenersPaginatorOptions struct {
	// The number of listener objects that you want to return with this call. The
	// default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomRoutingListenersPaginatorOptions is the paginator options for ListCustomRoutingListeners

type ListCustomRoutingPortMappingsAPIClient added in v0.31.0 

type ListCustomRoutingPortMappingsAPIClient interface {
	ListCustomRoutingPortMappings(context.Context, *ListCustomRoutingPortMappingsInput, ...func(*Options)) (*ListCustomRoutingPortMappingsOutput, error)
}

ListCustomRoutingPortMappingsAPIClient is a client that implements the ListCustomRoutingPortMappings operation.

type ListCustomRoutingPortMappingsByDestinationAPIClient added in v0.31.0 

type ListCustomRoutingPortMappingsByDestinationAPIClient interface {
	ListCustomRoutingPortMappingsByDestination(context.Context, *ListCustomRoutingPortMappingsByDestinationInput, ...func(*Options)) (*ListCustomRoutingPortMappingsByDestinationOutput, error)
}

ListCustomRoutingPortMappingsByDestinationAPIClient is a client that implements the ListCustomRoutingPortMappingsByDestination operation.

type ListCustomRoutingPortMappingsByDestinationInput added in v0.31.0 

type ListCustomRoutingPortMappingsByDestinationInput struct {

	// The endpoint IP address in a virtual private cloud (VPC) subnet for which you
	// want to receive back port mappings.
	//
	// This member is required.
	DestinationAddress *string

	// The ID for the virtual private cloud (VPC) subnet.
	//
	// This member is required.
	EndpointId *string

	// The number of destination port mappings that you want to return with this call.
	// The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomRoutingPortMappingsByDestinationOutput added in v0.31.0 

type ListCustomRoutingPortMappingsByDestinationOutput struct {

	// The port mappings for the endpoint IP address that you specified in the request.
	DestinationPortMappings []types.DestinationPortMapping

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomRoutingPortMappingsByDestinationPaginator added in v0.31.0 

type ListCustomRoutingPortMappingsByDestinationPaginator struct {
	// contains filtered or unexported fields
}

ListCustomRoutingPortMappingsByDestinationPaginator is a paginator for ListCustomRoutingPortMappingsByDestination

func NewListCustomRoutingPortMappingsByDestinationPaginator added in v0.31.0 

func NewListCustomRoutingPortMappingsByDestinationPaginator(client ListCustomRoutingPortMappingsByDestinationAPIClient, params *ListCustomRoutingPortMappingsByDestinationInput, optFns ...func(*ListCustomRoutingPortMappingsByDestinationPaginatorOptions)) *ListCustomRoutingPortMappingsByDestinationPaginator

NewListCustomRoutingPortMappingsByDestinationPaginator returns a new ListCustomRoutingPortMappingsByDestinationPaginator

func (*ListCustomRoutingPortMappingsByDestinationPaginator) HasMorePages added in v0.31.0 

func (p *ListCustomRoutingPortMappingsByDestinationPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomRoutingPortMappingsByDestinationPaginator) NextPage added in v0.31.0 

func (p *ListCustomRoutingPortMappingsByDestinationPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsByDestinationOutput, error)

NextPage retrieves the next ListCustomRoutingPortMappingsByDestination page.

type ListCustomRoutingPortMappingsByDestinationPaginatorOptions added in v0.31.0 

type ListCustomRoutingPortMappingsByDestinationPaginatorOptions struct {
	// The number of destination port mappings that you want to return with this call.
	// The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomRoutingPortMappingsByDestinationPaginatorOptions is the paginator options for ListCustomRoutingPortMappingsByDestination

type ListCustomRoutingPortMappingsInput added in v0.31.0 

type ListCustomRoutingPortMappingsInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to list the custom routing
	// port mappings for.
	//
	// This member is required.
	AcceleratorArn *string

	// The Amazon Resource Name (ARN) of the endpoint group to list the custom routing
	// port mappings for.
	EndpointGroupArn *string

	// The number of destination port mappings that you want to return with this call.
	// The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCustomRoutingPortMappingsOutput added in v0.31.0 

type ListCustomRoutingPortMappingsOutput struct {

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// The port mappings for a custom routing accelerator.
	PortMappings []types.PortMapping

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCustomRoutingPortMappingsPaginator added in v0.31.0 

type ListCustomRoutingPortMappingsPaginator struct {
	// contains filtered or unexported fields
}

ListCustomRoutingPortMappingsPaginator is a paginator for ListCustomRoutingPortMappings

func NewListCustomRoutingPortMappingsPaginator added in v0.31.0 

func NewListCustomRoutingPortMappingsPaginator(client ListCustomRoutingPortMappingsAPIClient, params *ListCustomRoutingPortMappingsInput, optFns ...func(*ListCustomRoutingPortMappingsPaginatorOptions)) *ListCustomRoutingPortMappingsPaginator

NewListCustomRoutingPortMappingsPaginator returns a new ListCustomRoutingPortMappingsPaginator

func (*ListCustomRoutingPortMappingsPaginator) HasMorePages added in v0.31.0 

func (p *ListCustomRoutingPortMappingsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCustomRoutingPortMappingsPaginator) NextPage added in v0.31.0 

func (p *ListCustomRoutingPortMappingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomRoutingPortMappingsOutput, error)

NextPage retrieves the next ListCustomRoutingPortMappings page.

type ListCustomRoutingPortMappingsPaginatorOptions added in v0.31.0 

type ListCustomRoutingPortMappingsPaginatorOptions struct {
	// The number of destination port mappings that you want to return with this call.
	// The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCustomRoutingPortMappingsPaginatorOptions is the paginator options for ListCustomRoutingPortMappings

type ListEndpointGroupsAPIClient added in v0.31.0 

type ListEndpointGroupsAPIClient interface {
	ListEndpointGroups(context.Context, *ListEndpointGroupsInput, ...func(*Options)) (*ListEndpointGroupsOutput, error)
}

ListEndpointGroupsAPIClient is a client that implements the ListEndpointGroups operation.

type ListEndpointGroupsInput 

type ListEndpointGroupsInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	//
	// This member is required.
	ListenerArn *string

	// The number of endpoint group objects that you want to return with this call.
	// The default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListEndpointGroupsOutput 

type ListEndpointGroupsOutput struct {

	// The list of the endpoint groups associated with a listener.
	EndpointGroups []types.EndpointGroup

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListEndpointGroupsPaginator added in v0.31.0 

type ListEndpointGroupsPaginator struct {
	// contains filtered or unexported fields
}

ListEndpointGroupsPaginator is a paginator for ListEndpointGroups

func NewListEndpointGroupsPaginator added in v0.31.0 

func NewListEndpointGroupsPaginator(client ListEndpointGroupsAPIClient, params *ListEndpointGroupsInput, optFns ...func(*ListEndpointGroupsPaginatorOptions)) *ListEndpointGroupsPaginator

NewListEndpointGroupsPaginator returns a new ListEndpointGroupsPaginator

func (*ListEndpointGroupsPaginator) HasMorePages added in v0.31.0 

func (p *ListEndpointGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListEndpointGroupsPaginator) NextPage added in v0.31.0 

func (p *ListEndpointGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEndpointGroupsOutput, error)

NextPage retrieves the next ListEndpointGroups page.

type ListEndpointGroupsPaginatorOptions added in v0.31.0 

type ListEndpointGroupsPaginatorOptions struct {
	// The number of endpoint group objects that you want to return with this call.
	// The default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListEndpointGroupsPaginatorOptions is the paginator options for ListEndpointGroups

type ListListenersAPIClient added in v0.31.0 

type ListListenersAPIClient interface {
	ListListeners(context.Context, *ListListenersInput, ...func(*Options)) (*ListListenersOutput, error)
}

ListListenersAPIClient is a client that implements the ListListeners operation.

type ListListenersInput 

type ListListenersInput struct {

	// The Amazon Resource Name (ARN) of the accelerator for which you want to list
	// listener objects.
	//
	// This member is required.
	AcceleratorArn *string

	// The number of listener objects that you want to return with this call. The
	// default value is 10.
	MaxResults *int32

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string
	// contains filtered or unexported fields
}

type ListListenersOutput 

type ListListenersOutput struct {

	// The list of listeners for an accelerator.
	Listeners []types.Listener

	// The token for the next set of results. You receive this token from a previous
	// call.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListListenersPaginator added in v0.31.0 

type ListListenersPaginator struct {
	// contains filtered or unexported fields
}

ListListenersPaginator is a paginator for ListListeners

func NewListListenersPaginator added in v0.31.0 

func NewListListenersPaginator(client ListListenersAPIClient, params *ListListenersInput, optFns ...func(*ListListenersPaginatorOptions)) *ListListenersPaginator

NewListListenersPaginator returns a new ListListenersPaginator

func (*ListListenersPaginator) HasMorePages added in v0.31.0 

func (p *ListListenersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListListenersPaginator) NextPage added in v0.31.0 

func (p *ListListenersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListListenersOutput, error)

NextPage retrieves the next ListListeners page.

type ListListenersPaginatorOptions added in v0.31.0 

type ListListenersPaginatorOptions struct {
	// The number of listener objects that you want to return with this call. The
	// default value is 10.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListListenersPaginatorOptions is the paginator options for ListListeners

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN
	// uniquely identifies an accelerator.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// Root level tag for the Tags parameters.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.19.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ProvisionByoipCidrInput 

type ProvisionByoipCidrInput struct {

	// The public IPv4 address range, in CIDR notation. The most specific IP prefix
	// that you can specify is /24. The address range cannot overlap with another
	// address range that you've brought to this Amazon Web Services Region or another
	// Region.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	//
	// This member is required.
	Cidr *string

	// A signed document that proves that you are authorized to bring the specified IP
	// address range to Amazon using BYOIP.
	//
	// This member is required.
	CidrAuthorizationContext *types.CidrAuthorizationContext
	// contains filtered or unexported fields
}

type ProvisionByoipCidrOutput 

type ProvisionByoipCidrOutput struct {

	// Information about the address range.
	ByoipCidr *types.ByoipCidr

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveCustomRoutingEndpointsInput added in v0.31.0 

type RemoveCustomRoutingEndpointsInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to remove endpoints from.
	//
	// This member is required.
	EndpointGroupArn *string

	// The IDs for the endpoints. For custom routing accelerators, endpoint IDs are
	// the virtual private cloud (VPC) subnet IDs.
	//
	// This member is required.
	EndpointIds []string
	// contains filtered or unexported fields
}

type RemoveCustomRoutingEndpointsOutput added in v0.31.0 

type RemoveCustomRoutingEndpointsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type RemoveEndpointsInput added in v1.15.0 

type RemoveEndpointsInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// This member is required.
	EndpointGroupArn *string

	// The identifiers of the endpoints that you want to remove.
	//
	// This member is required.
	EndpointIdentifiers []types.EndpointIdentifier
	// contains filtered or unexported fields
}

type RemoveEndpointsOutput added in v1.15.0 

type RemoveEndpointsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Global Accelerator resource to add tags
	// to. An ARN uniquely identifies a resource.
	//
	// This member is required.
	ResourceArn *string

	// The tags to add to a resource. A tag consists of a key and a value that you
	// define.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Global Accelerator resource to remove
	// tags from. An ARN uniquely identifies a resource.
	//
	// This member is required.
	ResourceArn *string

	// The tag key pairs that you want to remove from the specified resources.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAcceleratorAttributesInput 

type UpdateAcceleratorAttributesInput struct {

	// The Amazon Resource Name (ARN) of the accelerator that you want to update.
	//
	// This member is required.
	AcceleratorArn *string

	// Update whether flow logs are enabled. The default value is false. If the value
	// is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
	//
	// For more information, see [Flow Logs] in the Global Accelerator Developer Guide.
	//
	// [Flow Logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html
	FlowLogsEnabled *bool

	// The name of the Amazon S3 bucket for the flow logs. Attribute is required if
	// FlowLogsEnabled is true . The bucket must exist and have a bucket policy that
	// grants Global Accelerator permission to write to the bucket.
	FlowLogsS3Bucket *string

	// Update the prefix for the location in the Amazon S3 bucket for the flow logs.
	// Attribute is required if FlowLogsEnabled is true .
	//
	// If you specify slash (/) for the S3 bucket prefix, the log file bucket folder
	// structure will include a double slash (//), like the following:
	//
	// s3-bucket_name//AWSLogs/aws_account_id
	FlowLogsS3Prefix *string
	// contains filtered or unexported fields
}

type UpdateAcceleratorAttributesOutput 

type UpdateAcceleratorAttributesOutput struct {

	// Updated attributes for the accelerator.
	AcceleratorAttributes *types.AcceleratorAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAcceleratorInput 

type UpdateAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to update.
	//
	// This member is required.
	AcceleratorArn *string

	// Indicates whether an accelerator is enabled. The value is true or false. The
	// default value is true.
	//
	// If the value is set to true, the accelerator cannot be deleted. If set to
	// false, the accelerator can be deleted.
	Enabled *bool

	// The IP address type that an accelerator supports. For a standard accelerator,
	// the value can be IPV4 or DUAL_STACK.
	IpAddressType types.IpAddressType

	// The IP addresses for an accelerator.
	IpAddresses []string

	// The name of the accelerator. The name can have a maximum of 64 characters, must
	// contain only alphanumeric characters, periods (.), or hyphens (-), and must not
	// begin or end with a hyphen or period.
	Name *string
	// contains filtered or unexported fields
}

type UpdateAcceleratorOutput 

type UpdateAcceleratorOutput struct {

	// Information about the updated accelerator.
	Accelerator *types.Accelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCrossAccountAttachmentInput added in v1.19.0 

type UpdateCrossAccountAttachmentInput struct {

	// The Amazon Resource Name (ARN) of the cross-account attachment to update.
	//
	// This member is required.
	AttachmentArn *string

	// The principals to add to the cross-account attachment. A principal is an
	// account or the Amazon Resource Name (ARN) of an accelerator that the attachment
	// gives permission to work with resources from another account. The resources are
	// also listed in the attachment.
	//
	// To add more than one principal, separate the account numbers or accelerator
	// ARNs, or both, with commas.
	AddPrincipals []string

	// The resources to add to the cross-account attachment. A resource listed in a
	// cross-account attachment can be used with an accelerator by the principals that
	// are listed in the attachment.
	//
	// To add more than one resource, separate the resource ARNs with commas.
	AddResources []types.Resource

	// The name of the cross-account attachment.
	Name *string

	// The principals to remove from the cross-account attachment. A principal is an
	// account or the Amazon Resource Name (ARN) of an accelerator that the attachment
	// gives permission to work with resources from another account. The resources are
	// also listed in the attachment.
	//
	// To remove more than one principal, separate the account numbers or accelerator
	// ARNs, or both, with commas.
	RemovePrincipals []string

	// The resources to remove from the cross-account attachment. A resource listed in
	// a cross-account attachment can be used with an accelerator by the principals
	// that are listed in the attachment.
	//
	// To remove more than one resource, separate the resource ARNs with commas.
	RemoveResources []types.Resource
	// contains filtered or unexported fields
}

type UpdateCrossAccountAttachmentOutput added in v1.19.0 

type UpdateCrossAccountAttachmentOutput struct {

	// Information about the updated cross-account attachment.
	CrossAccountAttachment *types.Attachment

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomRoutingAcceleratorAttributesInput added in v0.31.0 

type UpdateCustomRoutingAcceleratorAttributesInput struct {

	// The Amazon Resource Name (ARN) of the custom routing accelerator to update
	// attributes for.
	//
	// This member is required.
	AcceleratorArn *string

	// Update whether flow logs are enabled. The default value is false. If the value
	// is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
	//
	// For more information, see [Flow logs] in the Global Accelerator Developer Guide.
	//
	// [Flow logs]: https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html
	FlowLogsEnabled *bool

	// The name of the Amazon S3 bucket for the flow logs. Attribute is required if
	// FlowLogsEnabled is true . The bucket must exist and have a bucket policy that
	// grants Global Accelerator permission to write to the bucket.
	FlowLogsS3Bucket *string

	// Update the prefix for the location in the Amazon S3 bucket for the flow logs.
	// Attribute is required if FlowLogsEnabled is true .
	//
	// If you don’t specify a prefix, the flow logs are stored in the root of the
	// bucket. If you specify slash (/) for the S3 bucket prefix, the log file bucket
	// folder structure will include a double slash (//), like the following:
	//
	// DOC-EXAMPLE-BUCKET//AWSLogs/aws_account_id
	FlowLogsS3Prefix *string
	// contains filtered or unexported fields
}

type UpdateCustomRoutingAcceleratorAttributesOutput added in v0.31.0 

type UpdateCustomRoutingAcceleratorAttributesOutput struct {

	// Updated custom routing accelerator.
	AcceleratorAttributes *types.CustomRoutingAcceleratorAttributes

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomRoutingAcceleratorInput added in v0.31.0 

type UpdateCustomRoutingAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to update.
	//
	// This member is required.
	AcceleratorArn *string

	// Indicates whether an accelerator is enabled. The value is true or false. The
	// default value is true.
	//
	// If the value is set to true, the accelerator cannot be deleted. If set to
	// false, the accelerator can be deleted.
	Enabled *bool

	// The IP address type that an accelerator supports. For a custom routing
	// accelerator, the value must be IPV4.
	IpAddressType types.IpAddressType

	// The IP addresses for an accelerator.
	IpAddresses []string

	// The name of the accelerator. The name can have a maximum of 64 characters, must
	// contain only alphanumeric characters, periods (.), or hyphens (-), and must not
	// begin or end with a hyphen or period.
	Name *string
	// contains filtered or unexported fields
}

type UpdateCustomRoutingAcceleratorOutput added in v0.31.0 

type UpdateCustomRoutingAcceleratorOutput struct {

	// Information about the updated custom routing accelerator.
	Accelerator *types.CustomRoutingAccelerator

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateCustomRoutingListenerInput added in v0.31.0 

type UpdateCustomRoutingListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to update.
	//
	// This member is required.
	ListenerArn *string

	// The updated port range to support for connections from clients to your
	// accelerator. If you remove ports that are currently being used by a subnet
	// endpoint, the call fails.
	//
	// Separately, you set port ranges for endpoints. For more information, see [About endpoints for custom routing accelerators].
	//
	// [About endpoints for custom routing accelerators]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html
	//
	// This member is required.
	PortRanges []types.PortRange
	// contains filtered or unexported fields
}

type UpdateCustomRoutingListenerOutput added in v0.31.0 

type UpdateCustomRoutingListenerOutput struct {

	// Information for the updated listener for a custom routing accelerator.
	Listener *types.CustomRoutingListener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateEndpointGroupInput 

type UpdateEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// This member is required.
	EndpointGroupArn *string

	// The list of endpoint objects. A resource must be valid and active when you add
	// it as an endpoint.
	EndpointConfigurations []types.EndpointConfiguration

	// The time—10 seconds or 30 seconds—between each health check for an endpoint.
	// The default value is 30.
	HealthCheckIntervalSeconds *int32

	// If the protocol is HTTP/S, then this specifies the path that is the destination
	// for health check targets. The default value is slash (/).
	HealthCheckPath *string

	// The port that Global Accelerator uses to check the health of endpoints that are
	// part of this endpoint group. The default port is the listener port that this
	// endpoint group is associated with. If the listener port is a list of ports,
	// Global Accelerator uses the first port in the list.
	HealthCheckPort *int32

	// The protocol that Global Accelerator uses to check the health of endpoints that
	// are part of this endpoint group. The default value is TCP.
	HealthCheckProtocol types.HealthCheckProtocol

	// Override specific listener ports used to route traffic to endpoints that are
	// part of this endpoint group. For example, you can create a port override in
	// which the listener receives user traffic on ports 80 and 443, but your
	// accelerator routes that traffic to ports 1080 and 1443, respectively, on the
	// endpoints.
	//
	// For more information, see [Overriding listener ports] in the Global Accelerator Developer Guide.
	//
	// [Overriding listener ports]: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html
	PortOverrides []types.PortOverride

	// The number of consecutive health checks required to set the state of a healthy
	// endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default
	// value is 3.
	ThresholdCount *int32

	// The percentage of traffic to send to an Amazon Web Services Region. Additional
	// traffic is distributed to other endpoint groups for this listener.
	//
	// Use this action to increase (dial up) or decrease (dial down) traffic to a
	// specific Region. The percentage is applied to the traffic that would otherwise
	// have been routed to the Region based on optimal routing.
	//
	// The default value is 100.
	TrafficDialPercentage *float32
	// contains filtered or unexported fields
}

type UpdateEndpointGroupOutput 

type UpdateEndpointGroupOutput struct {

	// The information about the endpoint group that was updated.
	EndpointGroup *types.EndpointGroup

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateListenerInput 

type UpdateListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to update.
	//
	// This member is required.
	ListenerArn *string

	// Client affinity lets you direct all requests from a user to the same endpoint,
	// if you have stateful applications, regardless of the port and protocol of the
	// client request. Client affinity gives you control over whether to always route
	// each client to the same specific endpoint.
	//
	// Global Accelerator uses a consistent-flow hashing algorithm to choose the
	// optimal endpoint for a connection. If client affinity is NONE , Global
	// Accelerator uses the "five-tuple" (5-tuple) properties—source IP address, source
	// port, destination IP address, destination port, and protocol—to select the hash
	// value, and then chooses the best endpoint. However, with this setting, if
	// someone uses different ports to connect to Global Accelerator, their connections
	// might not be always routed to the same endpoint because the hash value changes.
	//
	// If you want a given client to always be routed to the same endpoint, set client
	// affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global
	// Accelerator uses the "two-tuple" (2-tuple) properties— source (client) IP
	// address and destination IP address—to select the hash value.
	//
	// The default value is NONE .
	ClientAffinity types.ClientAffinity

	// The updated list of port ranges for the connections from clients to the
	// accelerator.
	PortRanges []types.PortRange

	// The updated protocol for the connections from clients to the accelerator.
	Protocol types.Protocol
	// contains filtered or unexported fields
}

type UpdateListenerOutput 

type UpdateListenerOutput struct {

	// Information for the updated listener.
	Listener *types.Listener

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type WithdrawByoipCidrInput 

type WithdrawByoipCidrInput struct {

	// The address range, in CIDR notation.
	//
	// For more information, see [Bring your own IP addresses (BYOIP)] in the Global Accelerator Developer Guide.
	//
	// [Bring your own IP addresses (BYOIP)]: https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html
	//
	// This member is required.
	Cidr *string
	// contains filtered or unexported fields
}

type WithdrawByoipCidrOutput 

type WithdrawByoipCidrOutput struct {

	// Information about the BYOIP address pool.
	ByoipCidr *types.ByoipCidr

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.