globalaccelerator

package
v1.99.1 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2020 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package globalaccelerator provides the client and types for making API requests to AWS Global Accelerator.

This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide (https://docs.aws.amazon.com/global-accelerator/latest/dg/Welcome.html).

AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.

Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.

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

Global Accelerator includes components that work together to help you improve performance and availability for your applications:

Static IP address

AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.

Accelerator

An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.

Network zone

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

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

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

Endpoint

An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.

See https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08 for more information on this service.

See globalaccelerator package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/globalaccelerator/

Using the Client

To contact AWS Global Accelerator with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Global Accelerator client GlobalAccelerator for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/globalaccelerator/#New

Index

Constants

View Source
const (
	// AcceleratorStatusDeployed is a AcceleratorStatus enum value
	AcceleratorStatusDeployed = "DEPLOYED"

	// AcceleratorStatusInProgress is a AcceleratorStatus enum value
	AcceleratorStatusInProgress = "IN_PROGRESS"
)
View Source
const (
	// ClientAffinityNone is a ClientAffinity enum value
	ClientAffinityNone = "NONE"

	// ClientAffinitySourceIp is a ClientAffinity enum value
	ClientAffinitySourceIp = "SOURCE_IP"
)
View Source
const (
	// HealthCheckProtocolTcp is a HealthCheckProtocol enum value
	HealthCheckProtocolTcp = "TCP"

	// HealthCheckProtocolHttp is a HealthCheckProtocol enum value
	HealthCheckProtocolHttp = "HTTP"

	// HealthCheckProtocolHttps is a HealthCheckProtocol enum value
	HealthCheckProtocolHttps = "HTTPS"
)
View Source
const (
	// HealthStateInitial is a HealthState enum value
	HealthStateInitial = "INITIAL"

	// HealthStateHealthy is a HealthState enum value
	HealthStateHealthy = "HEALTHY"

	// HealthStateUnhealthy is a HealthState enum value
	HealthStateUnhealthy = "UNHEALTHY"
)
View Source
const (
	// ProtocolTcp is a Protocol enum value
	ProtocolTcp = "TCP"

	// ProtocolUdp is a Protocol enum value
	ProtocolUdp = "UDP"
)
View Source
const (

	// ErrCodeAcceleratorNotDisabledException for service response error code
	// "AcceleratorNotDisabledException".
	//
	// The accelerator that you specified could not be disabled.
	ErrCodeAcceleratorNotDisabledException = "AcceleratorNotDisabledException"

	// ErrCodeAcceleratorNotFoundException for service response error code
	// "AcceleratorNotFoundException".
	//
	// The accelerator that you specified doesn't exist.
	ErrCodeAcceleratorNotFoundException = "AcceleratorNotFoundException"

	// ErrCodeAssociatedEndpointGroupFoundException for service response error code
	// "AssociatedEndpointGroupFoundException".
	//
	// The listener that you specified has an endpoint group associated with it.
	// You must remove all dependent resources from a listener before you can delete
	// it.
	ErrCodeAssociatedEndpointGroupFoundException = "AssociatedEndpointGroupFoundException"

	// ErrCodeAssociatedListenerFoundException for service response error code
	// "AssociatedListenerFoundException".
	//
	// The accelerator that you specified has a listener associated with it. You
	// must remove all dependent resources from an accelerator before you can delete
	// it.
	ErrCodeAssociatedListenerFoundException = "AssociatedListenerFoundException"

	// ErrCodeEndpointGroupAlreadyExistsException for service response error code
	// "EndpointGroupAlreadyExistsException".
	//
	// The endpoint group that you specified already exists.
	ErrCodeEndpointGroupAlreadyExistsException = "EndpointGroupAlreadyExistsException"

	// ErrCodeEndpointGroupNotFoundException for service response error code
	// "EndpointGroupNotFoundException".
	//
	// The endpoint group that you specified doesn't exist.
	ErrCodeEndpointGroupNotFoundException = "EndpointGroupNotFoundException"

	// ErrCodeInternalServiceErrorException for service response error code
	// "InternalServiceErrorException".
	//
	// There was an internal error for AWS Global Accelerator.
	ErrCodeInternalServiceErrorException = "InternalServiceErrorException"

	// ErrCodeInvalidArgumentException for service response error code
	// "InvalidArgumentException".
	//
	// An argument that you specified is invalid.
	ErrCodeInvalidArgumentException = "InvalidArgumentException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// There isn't another item to return.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidPortRangeException for service response error code
	// "InvalidPortRangeException".
	//
	// The port numbers that you specified are not valid numbers or are not unique
	// for this accelerator.
	ErrCodeInvalidPortRangeException = "InvalidPortRangeException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Processing your request would cause you to exceed an AWS Global Accelerator
	// limit.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeListenerNotFoundException for service response error code
	// "ListenerNotFoundException".
	//
	// The listener that you specified doesn't exist.
	ErrCodeListenerNotFoundException = "ListenerNotFoundException"
)
View Source
const (
	ServiceName = "Global Accelerator" // Name of service.
	EndpointsID = "globalaccelerator"  // ID to lookup a service endpoint with.
	ServiceID   = "Global Accelerator" // ServiceID is a unique identifer of a specific service.
)

Service information constants

View Source
const (
	// IpAddressTypeIpv4 is a IpAddressType enum value
	IpAddressTypeIpv4 = "IPV4"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Accelerator

type Accelerator struct {

	// The Amazon Resource Name (ARN) of the accelerator.
	AcceleratorArn *string `type:"string"`

	// The date and time that the accelerator was created.
	CreatedTime *time.Time `type:"timestamp"`

	// Indicates whether theaccelerator 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, accelerator can be deleted.
	Enabled *bool `type:"boolean"`

	// The value for the address type must be IPv4.
	IpAddressType *string `type:"string" enum:"IpAddressType"`

	// IP address set associated with the accelerator.
	IpSets []*IpSet `type:"list"`

	// The date and time that the accelerator was last modified.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The name of the accelerator. The name can have a maximum of 32 characters,
	// must contain only alphanumeric characters or hyphens (-), and must not begin
	// or end with a hyphen.
	Name *string `type:"string"`

	// Describes the deployment status of the accelerator.
	Status *string `type:"string" enum:"AcceleratorStatus"`
	// contains filtered or unexported fields
}

An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

func (Accelerator) GoString

func (s Accelerator) GoString() string

GoString returns the string representation

func (*Accelerator) SetAcceleratorArn

func (s *Accelerator) SetAcceleratorArn(v string) *Accelerator

SetAcceleratorArn sets the AcceleratorArn field's value.

func (*Accelerator) SetCreatedTime

func (s *Accelerator) SetCreatedTime(v time.Time) *Accelerator

SetCreatedTime sets the CreatedTime field's value.

func (*Accelerator) SetEnabled

func (s *Accelerator) SetEnabled(v bool) *Accelerator

SetEnabled sets the Enabled field's value.

func (*Accelerator) SetIpAddressType

func (s *Accelerator) SetIpAddressType(v string) *Accelerator

SetIpAddressType sets the IpAddressType field's value.

func (*Accelerator) SetIpSets

func (s *Accelerator) SetIpSets(v []*IpSet) *Accelerator

SetIpSets sets the IpSets field's value.

func (*Accelerator) SetLastModifiedTime

func (s *Accelerator) SetLastModifiedTime(v time.Time) *Accelerator

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*Accelerator) SetName

func (s *Accelerator) SetName(v string) *Accelerator

SetName sets the Name field's value.

func (*Accelerator) SetStatus

func (s *Accelerator) SetStatus(v string) *Accelerator

SetStatus sets the Status field's value.

func (Accelerator) String

func (s Accelerator) String() string

String returns the string representation

type AcceleratorAttributes

type AcceleratorAttributes struct {

	// Indicates 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 (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html)
	// in the AWS Global Accelerator Developer Guide.
	FlowLogsEnabled *bool `type:"boolean"`

	// 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 AWS Global Accelerator permission to write to the bucket.
	FlowLogsS3Bucket *string `type:"string"`

	// 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.
	FlowLogsS3Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

Attributes of an accelerator.

func (AcceleratorAttributes) GoString

func (s AcceleratorAttributes) GoString() string

GoString returns the string representation

func (*AcceleratorAttributes) SetFlowLogsEnabled

func (s *AcceleratorAttributes) SetFlowLogsEnabled(v bool) *AcceleratorAttributes

SetFlowLogsEnabled sets the FlowLogsEnabled field's value.

func (*AcceleratorAttributes) SetFlowLogsS3Bucket

func (s *AcceleratorAttributes) SetFlowLogsS3Bucket(v string) *AcceleratorAttributes

SetFlowLogsS3Bucket sets the FlowLogsS3Bucket field's value.

func (*AcceleratorAttributes) SetFlowLogsS3Prefix

func (s *AcceleratorAttributes) SetFlowLogsS3Prefix(v string) *AcceleratorAttributes

SetFlowLogsS3Prefix sets the FlowLogsS3Prefix field's value.

func (AcceleratorAttributes) String

func (s AcceleratorAttributes) String() string

String returns the string representation

type CreateAcceleratorInput

type CreateAcceleratorInput struct {

	// 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 `type:"boolean"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency—that
	// is, the uniqueness—of an accelerator.
	//
	// IdempotencyToken is a required field
	IdempotencyToken *string `type:"string" required:"true"`

	// The value for the address type must be IPv4.
	IpAddressType *string `type:"string" enum:"IpAddressType"`

	// The name of an accelerator. The name can have a maximum of 32 characters,
	// must contain only alphanumeric characters or hyphens (-), and must not begin
	// or end with a hyphen.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAcceleratorInput) GoString

func (s CreateAcceleratorInput) GoString() string

GoString returns the string representation

func (*CreateAcceleratorInput) SetEnabled

SetEnabled sets the Enabled field's value.

func (*CreateAcceleratorInput) SetIdempotencyToken

func (s *CreateAcceleratorInput) SetIdempotencyToken(v string) *CreateAcceleratorInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateAcceleratorInput) SetIpAddressType

func (s *CreateAcceleratorInput) SetIpAddressType(v string) *CreateAcceleratorInput

SetIpAddressType sets the IpAddressType field's value.

func (*CreateAcceleratorInput) SetName

SetName sets the Name field's value.

func (CreateAcceleratorInput) String

func (s CreateAcceleratorInput) String() string

String returns the string representation

func (*CreateAcceleratorInput) Validate

func (s *CreateAcceleratorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAcceleratorOutput

type CreateAcceleratorOutput struct {

	// The accelerator that is created by specifying a listener and the supported
	// IP address types.
	Accelerator *Accelerator `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateAcceleratorOutput) GoString

func (s CreateAcceleratorOutput) GoString() string

GoString returns the string representation

func (*CreateAcceleratorOutput) SetAccelerator

SetAccelerator sets the Accelerator field's value.

func (CreateAcceleratorOutput) String

func (s CreateAcceleratorOutput) String() string

String returns the string representation

type CreateEndpointGroupInput

type CreateEndpointGroupInput struct {

	// The list of endpoint objects.
	EndpointConfigurations []*EndpointConfiguration `type:"list"`

	// The name of the AWS Region where the endpoint group is located. A listener
	// can have only one endpoint group in a specific Region.
	//
	// EndpointGroupRegion is a required field
	EndpointGroupRegion *string `type:"string" required:"true"`

	// The time—10 seconds or 30 seconds—between each health check for an endpoint.
	// The default value is 30.
	HealthCheckIntervalSeconds *int64 `min:"10" type:"integer"`

	// 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 `type:"string"`

	// The port that AWS 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 *int64 `min:"1" type:"integer"`

	// The protocol that AWS Global Accelerator uses to check the health of endpoints
	// that are part of this endpoint group. The default value is TCP.
	HealthCheckProtocol *string `type:"string" enum:"HealthCheckProtocol"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency—that
	// is, the uniqueness—of the request.
	//
	// IdempotencyToken is a required field
	IdempotencyToken *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// 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 *int64 `min:"1" type:"integer"`

	// The percentage of traffic to send to an AWS 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 *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (CreateEndpointGroupInput) GoString

func (s CreateEndpointGroupInput) GoString() string

GoString returns the string representation

func (*CreateEndpointGroupInput) SetEndpointConfigurations

func (s *CreateEndpointGroupInput) SetEndpointConfigurations(v []*EndpointConfiguration) *CreateEndpointGroupInput

SetEndpointConfigurations sets the EndpointConfigurations field's value.

func (*CreateEndpointGroupInput) SetEndpointGroupRegion

func (s *CreateEndpointGroupInput) SetEndpointGroupRegion(v string) *CreateEndpointGroupInput

SetEndpointGroupRegion sets the EndpointGroupRegion field's value.

func (*CreateEndpointGroupInput) SetHealthCheckIntervalSeconds

func (s *CreateEndpointGroupInput) SetHealthCheckIntervalSeconds(v int64) *CreateEndpointGroupInput

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*CreateEndpointGroupInput) SetHealthCheckPath

func (s *CreateEndpointGroupInput) SetHealthCheckPath(v string) *CreateEndpointGroupInput

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*CreateEndpointGroupInput) SetHealthCheckPort

func (s *CreateEndpointGroupInput) SetHealthCheckPort(v int64) *CreateEndpointGroupInput

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*CreateEndpointGroupInput) SetHealthCheckProtocol

func (s *CreateEndpointGroupInput) SetHealthCheckProtocol(v string) *CreateEndpointGroupInput

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*CreateEndpointGroupInput) SetIdempotencyToken

func (s *CreateEndpointGroupInput) SetIdempotencyToken(v string) *CreateEndpointGroupInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateEndpointGroupInput) SetListenerArn

SetListenerArn sets the ListenerArn field's value.

func (*CreateEndpointGroupInput) SetThresholdCount

func (s *CreateEndpointGroupInput) SetThresholdCount(v int64) *CreateEndpointGroupInput

SetThresholdCount sets the ThresholdCount field's value.

func (*CreateEndpointGroupInput) SetTrafficDialPercentage

func (s *CreateEndpointGroupInput) SetTrafficDialPercentage(v float64) *CreateEndpointGroupInput

SetTrafficDialPercentage sets the TrafficDialPercentage field's value.

func (CreateEndpointGroupInput) String

func (s CreateEndpointGroupInput) String() string

String returns the string representation

func (*CreateEndpointGroupInput) Validate

func (s *CreateEndpointGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateEndpointGroupOutput

type CreateEndpointGroupOutput struct {

	// The information about the endpoint group that was created.
	EndpointGroup *EndpointGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEndpointGroupOutput) GoString

func (s CreateEndpointGroupOutput) GoString() string

GoString returns the string representation

func (*CreateEndpointGroupOutput) SetEndpointGroup

SetEndpointGroup sets the EndpointGroup field's value.

func (CreateEndpointGroupOutput) String

func (s CreateEndpointGroupOutput) String() string

String returns the string representation

type CreateListenerInput

type CreateListenerInput struct {

	// The Amazon Resource Name (ARN) of your accelerator.
	//
	// AcceleratorArn is a required field
	AcceleratorArn *string `type:"string" required:"true"`

	// 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. Clienty affinity gives you control over whether to always
	// route each client to the same specific endpoint.
	//
	// AWS 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 *string `type:"string" enum:"ClientAffinity"`

	// A unique, case-sensitive identifier that you provide to ensure the idempotency—that
	// is, the uniqueness—of the request.
	//
	// IdempotencyToken is a required field
	IdempotencyToken *string `type:"string" required:"true"`

	// The list of port ranges to support for connections from clients to your accelerator.
	//
	// PortRanges is a required field
	PortRanges []*PortRange `min:"1" type:"list" required:"true"`

	// The protocol for connections from clients to your accelerator.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"Protocol"`
	// contains filtered or unexported fields
}

func (CreateListenerInput) GoString

func (s CreateListenerInput) GoString() string

GoString returns the string representation

func (*CreateListenerInput) SetAcceleratorArn

func (s *CreateListenerInput) SetAcceleratorArn(v string) *CreateListenerInput

SetAcceleratorArn sets the AcceleratorArn field's value.

func (*CreateListenerInput) SetClientAffinity

func (s *CreateListenerInput) SetClientAffinity(v string) *CreateListenerInput

SetClientAffinity sets the ClientAffinity field's value.

func (*CreateListenerInput) SetIdempotencyToken

func (s *CreateListenerInput) SetIdempotencyToken(v string) *CreateListenerInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateListenerInput) SetPortRanges

func (s *CreateListenerInput) SetPortRanges(v []*PortRange) *CreateListenerInput

SetPortRanges sets the PortRanges field's value.

func (*CreateListenerInput) SetProtocol

func (s *CreateListenerInput) SetProtocol(v string) *CreateListenerInput

SetProtocol sets the Protocol field's value.

func (CreateListenerInput) String

func (s CreateListenerInput) String() string

String returns the string representation

func (*CreateListenerInput) Validate

func (s *CreateListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateListenerOutput

type CreateListenerOutput struct {

	// The listener that you've created.
	Listener *Listener `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateListenerOutput) GoString

func (s CreateListenerOutput) GoString() string

GoString returns the string representation

func (*CreateListenerOutput) SetListener

SetListener sets the Listener field's value.

func (CreateListenerOutput) String

func (s CreateListenerOutput) String() string

String returns the string representation

type DeleteAcceleratorInput

type DeleteAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of an accelerator.
	//
	// AcceleratorArn is a required field
	AcceleratorArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAcceleratorInput) GoString

func (s DeleteAcceleratorInput) GoString() string

GoString returns the string representation

func (*DeleteAcceleratorInput) SetAcceleratorArn

func (s *DeleteAcceleratorInput) SetAcceleratorArn(v string) *DeleteAcceleratorInput

SetAcceleratorArn sets the AcceleratorArn field's value.

func (DeleteAcceleratorInput) String

func (s DeleteAcceleratorInput) String() string

String returns the string representation

func (*DeleteAcceleratorInput) Validate

func (s *DeleteAcceleratorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAcceleratorOutput

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

func (DeleteAcceleratorOutput) GoString

func (s DeleteAcceleratorOutput) GoString() string

GoString returns the string representation

func (DeleteAcceleratorOutput) String

func (s DeleteAcceleratorOutput) String() string

String returns the string representation

type DeleteEndpointGroupInput

type DeleteEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to delete.
	//
	// EndpointGroupArn is a required field
	EndpointGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteEndpointGroupInput) GoString

func (s DeleteEndpointGroupInput) GoString() string

GoString returns the string representation

func (*DeleteEndpointGroupInput) SetEndpointGroupArn

func (s *DeleteEndpointGroupInput) SetEndpointGroupArn(v string) *DeleteEndpointGroupInput

SetEndpointGroupArn sets the EndpointGroupArn field's value.

func (DeleteEndpointGroupInput) String

func (s DeleteEndpointGroupInput) String() string

String returns the string representation

func (*DeleteEndpointGroupInput) Validate

func (s *DeleteEndpointGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteEndpointGroupOutput

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

func (DeleteEndpointGroupOutput) GoString

func (s DeleteEndpointGroupOutput) GoString() string

GoString returns the string representation

func (DeleteEndpointGroupOutput) String

func (s DeleteEndpointGroupOutput) String() string

String returns the string representation

type DeleteListenerInput

type DeleteListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteListenerInput) GoString

func (s DeleteListenerInput) GoString() string

GoString returns the string representation

func (*DeleteListenerInput) SetListenerArn

func (s *DeleteListenerInput) SetListenerArn(v string) *DeleteListenerInput

SetListenerArn sets the ListenerArn field's value.

func (DeleteListenerInput) String

func (s DeleteListenerInput) String() string

String returns the string representation

func (*DeleteListenerInput) Validate

func (s *DeleteListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteListenerOutput

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

func (DeleteListenerOutput) GoString

func (s DeleteListenerOutput) GoString() string

GoString returns the string representation

func (DeleteListenerOutput) String

func (s DeleteListenerOutput) String() string

String returns the string representation

type DescribeAcceleratorAttributesInput

type DescribeAcceleratorAttributesInput struct {

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

func (DescribeAcceleratorAttributesInput) GoString

GoString returns the string representation

func (*DescribeAcceleratorAttributesInput) SetAcceleratorArn

SetAcceleratorArn sets the AcceleratorArn field's value.

func (DescribeAcceleratorAttributesInput) String

String returns the string representation

type DescribeAcceleratorAttributesOutput

type DescribeAcceleratorAttributesOutput struct {

	// The attributes of the accelerator.
	AcceleratorAttributes *AcceleratorAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorAttributesOutput) GoString

GoString returns the string representation

func (*DescribeAcceleratorAttributesOutput) SetAcceleratorAttributes

SetAcceleratorAttributes sets the AcceleratorAttributes field's value.

func (DescribeAcceleratorAttributesOutput) String

String returns the string representation

type DescribeAcceleratorInput

type DescribeAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to describe.
	//
	// AcceleratorArn is a required field
	AcceleratorArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorInput) GoString

func (s DescribeAcceleratorInput) GoString() string

GoString returns the string representation

func (*DescribeAcceleratorInput) SetAcceleratorArn

func (s *DescribeAcceleratorInput) SetAcceleratorArn(v string) *DescribeAcceleratorInput

SetAcceleratorArn sets the AcceleratorArn field's value.

func (DescribeAcceleratorInput) String

func (s DescribeAcceleratorInput) String() string

String returns the string representation

func (*DescribeAcceleratorInput) Validate

func (s *DescribeAcceleratorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeAcceleratorOutput

type DescribeAcceleratorOutput struct {

	// The description of the accelerator.
	Accelerator *Accelerator `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAcceleratorOutput) GoString

func (s DescribeAcceleratorOutput) GoString() string

GoString returns the string representation

func (*DescribeAcceleratorOutput) SetAccelerator

SetAccelerator sets the Accelerator field's value.

func (DescribeAcceleratorOutput) String

func (s DescribeAcceleratorOutput) String() string

String returns the string representation

type DescribeEndpointGroupInput

type DescribeEndpointGroupInput struct {

	// The Amazon Resource Name (ARN) of the endpoint group to describe.
	//
	// EndpointGroupArn is a required field
	EndpointGroupArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEndpointGroupInput) GoString

func (s DescribeEndpointGroupInput) GoString() string

GoString returns the string representation

func (*DescribeEndpointGroupInput) SetEndpointGroupArn

SetEndpointGroupArn sets the EndpointGroupArn field's value.

func (DescribeEndpointGroupInput) String

String returns the string representation

func (*DescribeEndpointGroupInput) Validate

func (s *DescribeEndpointGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeEndpointGroupOutput

type DescribeEndpointGroupOutput struct {

	// The description of an endpoint group.
	EndpointGroup *EndpointGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEndpointGroupOutput) GoString

func (s DescribeEndpointGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeEndpointGroupOutput) SetEndpointGroup

SetEndpointGroup sets the EndpointGroup field's value.

func (DescribeEndpointGroupOutput) String

String returns the string representation

type DescribeListenerInput

type DescribeListenerInput struct {

	// The Amazon Resource Name (ARN) of the listener to describe.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeListenerInput) GoString

func (s DescribeListenerInput) GoString() string

GoString returns the string representation

func (*DescribeListenerInput) SetListenerArn

func (s *DescribeListenerInput) SetListenerArn(v string) *DescribeListenerInput

SetListenerArn sets the ListenerArn field's value.

func (DescribeListenerInput) String

func (s DescribeListenerInput) String() string

String returns the string representation

func (*DescribeListenerInput) Validate

func (s *DescribeListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeListenerOutput

type DescribeListenerOutput struct {

	// The description of a listener.
	Listener *Listener `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeListenerOutput) GoString

func (s DescribeListenerOutput) GoString() string

GoString returns the string representation

func (*DescribeListenerOutput) SetListener

SetListener sets the Listener field's value.

func (DescribeListenerOutput) String

func (s DescribeListenerOutput) String() string

String returns the string representation

type EndpointConfiguration

type EndpointConfiguration struct {

	// An ID for the endpoint. If the endpoint is a Network Load Balancer or Application
	// Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If
	// the endpoint is an Elastic IP address, this is the Elastic IP address allocation
	// ID.
	EndpointId *string `type:"string"`

	// The weight associated with the endpoint. When you add weights to endpoints,
	// you configure AWS Global Accelerator to route traffic based on proportions
	// that you specify. For example, you might specify endpoint weights of 4, 5,
	// 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is
	// routed to the first endpoint, 5/20 is routed both to the second and third
	// endpoints, and 6/20 is routed to the last endpoint. For more information,
	// see Endpoint Weights (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html)
	// in the AWS Global Accelerator Developer Guide.
	Weight *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A complex type for endpoints.

func (EndpointConfiguration) GoString

func (s EndpointConfiguration) GoString() string

GoString returns the string representation

func (*EndpointConfiguration) SetEndpointId

func (s *EndpointConfiguration) SetEndpointId(v string) *EndpointConfiguration

SetEndpointId sets the EndpointId field's value.

func (*EndpointConfiguration) SetWeight

SetWeight sets the Weight field's value.

func (EndpointConfiguration) String

func (s EndpointConfiguration) String() string

String returns the string representation

type EndpointDescription

type EndpointDescription struct {

	// An ID for the endpoint. If the endpoint is a Network Load Balancer or Application
	// Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If
	// the endpoint is an Elastic IP address, this is the Elastic IP address allocation
	// ID.
	EndpointId *string `type:"string"`

	// The reason code associated with why the endpoint is not healthy. If the endpoint
	// state is healthy, a reason code is not provided.
	//
	// If the endpoint state is unhealthy, the reason code can be one of the following
	// values:
	//
	//    * Timeout: The health check requests to the endpoint are timing out before
	//    returning a status.
	//
	//    * Failed: The health check failed, for example because the endpoint response
	//    was invalid (malformed).
	//
	// If the endpoint state is initial, the reason code can be one of the following
	// values:
	//
	//    * ProvisioningInProgress: The endpoint is in the process of being provisioned.
	//
	//    * InitialHealthChecking: Global Accelerator is still setting up the minimum
	//    number of health checks for the endpoint that are required to determine
	//    its health status.
	HealthReason *string `type:"string"`

	// The health status of the endpoint.
	HealthState *string `type:"string" enum:"HealthState"`

	// The weight associated with the endpoint. When you add weights to endpoints,
	// you configure AWS Global Accelerator to route traffic based on proportions
	// that you specify. For example, you might specify endpoint weights of 4, 5,
	// 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is
	// routed to the first endpoint, 5/20 is routed both to the second and third
	// endpoints, and 6/20 is routed to the last endpoint. For more information,
	// see Endpoint Weights (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html)
	// in the AWS Global Accelerator Developer Guide.
	Weight *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

func (EndpointDescription) GoString

func (s EndpointDescription) GoString() string

GoString returns the string representation

func (*EndpointDescription) SetEndpointId

func (s *EndpointDescription) SetEndpointId(v string) *EndpointDescription

SetEndpointId sets the EndpointId field's value.

func (*EndpointDescription) SetHealthReason

func (s *EndpointDescription) SetHealthReason(v string) *EndpointDescription

SetHealthReason sets the HealthReason field's value.

func (*EndpointDescription) SetHealthState

func (s *EndpointDescription) SetHealthState(v string) *EndpointDescription

SetHealthState sets the HealthState field's value.

func (*EndpointDescription) SetWeight

SetWeight sets the Weight field's value.

func (EndpointDescription) String

func (s EndpointDescription) String() string

String returns the string representation

type EndpointGroup

type EndpointGroup struct {

	// The list of endpoint objects.
	EndpointDescriptions []*EndpointDescription `type:"list"`

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

	// The AWS Region that this endpoint group belongs.
	EndpointGroupRegion *string `type:"string"`

	// The time—10 seconds or 30 seconds—between health checks for each endpoint.
	// The default value is 30.
	HealthCheckIntervalSeconds *int64 `min:"10" type:"integer"`

	// If the protocol is HTTP/S, then this value provides the ping path that Global
	// Accelerator uses for the destination on the endpoints for health checks.
	// The default is slash (/).
	HealthCheckPath *string `type:"string"`

	// The port that Global Accelerator uses to perform health checks on endpoints
	// that are part of this endpoint group.
	//
	// The default port is the port for the listener that this endpoint group is
	// associated with. If the listener port is a list, Global Accelerator uses
	// the first specified port in the list of ports.
	HealthCheckPort *int64 `min:"1" type:"integer"`

	// The protocol that Global Accelerator uses to perform health checks on endpoints
	// that are part of this endpoint group. The default value is TCP.
	HealthCheckProtocol *string `type:"string" enum:"HealthCheckProtocol"`

	// 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 *int64 `min:"1" type:"integer"`

	// The percentage of traffic to send to an AWS 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 *float64 `type:"float"`
	// contains filtered or unexported fields
}

A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.

func (EndpointGroup) GoString

func (s EndpointGroup) GoString() string

GoString returns the string representation

func (*EndpointGroup) SetEndpointDescriptions

func (s *EndpointGroup) SetEndpointDescriptions(v []*EndpointDescription) *EndpointGroup

SetEndpointDescriptions sets the EndpointDescriptions field's value.

func (*EndpointGroup) SetEndpointGroupArn

func (s *EndpointGroup) SetEndpointGroupArn(v string) *EndpointGroup

SetEndpointGroupArn sets the EndpointGroupArn field's value.

func (*EndpointGroup) SetEndpointGroupRegion

func (s *EndpointGroup) SetEndpointGroupRegion(v string) *EndpointGroup

SetEndpointGroupRegion sets the EndpointGroupRegion field's value.

func (*EndpointGroup) SetHealthCheckIntervalSeconds

func (s *EndpointGroup) SetHealthCheckIntervalSeconds(v int64) *EndpointGroup

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*EndpointGroup) SetHealthCheckPath

func (s *EndpointGroup) SetHealthCheckPath(v string) *EndpointGroup

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*EndpointGroup) SetHealthCheckPort

func (s *EndpointGroup) SetHealthCheckPort(v int64) *EndpointGroup

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*EndpointGroup) SetHealthCheckProtocol

func (s *EndpointGroup) SetHealthCheckProtocol(v string) *EndpointGroup

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*EndpointGroup) SetThresholdCount

func (s *EndpointGroup) SetThresholdCount(v int64) *EndpointGroup

SetThresholdCount sets the ThresholdCount field's value.

func (*EndpointGroup) SetTrafficDialPercentage

func (s *EndpointGroup) SetTrafficDialPercentage(v float64) *EndpointGroup

SetTrafficDialPercentage sets the TrafficDialPercentage field's value.

func (EndpointGroup) String

func (s EndpointGroup) String() string

String returns the string representation

type GlobalAccelerator

type GlobalAccelerator struct {
	*client.Client
}

GlobalAccelerator provides the API operation methods for making requests to AWS Global Accelerator. See this package's package overview docs for details on the service.

GlobalAccelerator methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the GlobalAccelerator client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a GlobalAccelerator client from just a session.
svc := globalaccelerator.New(mySession)

// Create a GlobalAccelerator client with additional configuration
svc := globalaccelerator.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*GlobalAccelerator) CreateAccelerator

func (c *GlobalAccelerator) CreateAccelerator(input *CreateAcceleratorInput) (*CreateAcceleratorOutput, error)

CreateAccelerator API operation for AWS Global Accelerator.

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. To see an AWS CLI example of creating an accelerator, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator

func (*GlobalAccelerator) CreateAcceleratorRequest

func (c *GlobalAccelerator) CreateAcceleratorRequest(input *CreateAcceleratorInput) (req *request.Request, output *CreateAcceleratorOutput)

CreateAcceleratorRequest generates a "aws/request.Request" representing the client's request for the CreateAccelerator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAccelerator for more information on using the CreateAccelerator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAcceleratorRequest method.
req, resp := client.CreateAcceleratorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator

func (*GlobalAccelerator) CreateAcceleratorWithContext

func (c *GlobalAccelerator) CreateAcceleratorWithContext(ctx aws.Context, input *CreateAcceleratorInput, opts ...request.Option) (*CreateAcceleratorOutput, error)

CreateAcceleratorWithContext is the same as CreateAccelerator with the addition of the ability to pass a context and additional request options.

See CreateAccelerator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) CreateEndpointGroup

CreateEndpointGroup API operation for AWS Global Accelerator.

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeEndpointGroupAlreadyExistsException "EndpointGroupAlreadyExistsException" The endpoint group that you specified already exists.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateEndpointGroup

func (*GlobalAccelerator) CreateEndpointGroupRequest

func (c *GlobalAccelerator) CreateEndpointGroupRequest(input *CreateEndpointGroupInput) (req *request.Request, output *CreateEndpointGroupOutput)

CreateEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the CreateEndpointGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateEndpointGroup for more information on using the CreateEndpointGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateEndpointGroupRequest method.
req, resp := client.CreateEndpointGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateEndpointGroup

func (*GlobalAccelerator) CreateEndpointGroupWithContext

func (c *GlobalAccelerator) CreateEndpointGroupWithContext(ctx aws.Context, input *CreateEndpointGroupInput, opts ...request.Option) (*CreateEndpointGroupOutput, error)

CreateEndpointGroupWithContext is the same as CreateEndpointGroup with the addition of the ability to pass a context and additional request options.

See CreateEndpointGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) CreateListener

func (c *GlobalAccelerator) CreateListener(input *CreateListenerInput) (*CreateListenerOutput, error)

CreateListener API operation for AWS Global Accelerator.

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. To see an AWS CLI example of creating a listener, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation CreateListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInvalidPortRangeException "InvalidPortRangeException" The port numbers that you specified are not valid numbers or are not unique for this accelerator.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateListener

func (*GlobalAccelerator) CreateListenerRequest

func (c *GlobalAccelerator) CreateListenerRequest(input *CreateListenerInput) (req *request.Request, output *CreateListenerOutput)

CreateListenerRequest generates a "aws/request.Request" representing the client's request for the CreateListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateListener for more information on using the CreateListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateListenerRequest method.
req, resp := client.CreateListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateListener

func (*GlobalAccelerator) CreateListenerWithContext

func (c *GlobalAccelerator) CreateListenerWithContext(ctx aws.Context, input *CreateListenerInput, opts ...request.Option) (*CreateListenerOutput, error)

CreateListenerWithContext is the same as CreateListener with the addition of the ability to pass a context and additional request options.

See CreateListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DeleteAccelerator

func (c *GlobalAccelerator) DeleteAccelerator(input *DeleteAcceleratorInput) (*DeleteAcceleratorOutput, error)

DeleteAccelerator API operation for AWS Global Accelerator.

Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DeleteAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeAcceleratorNotDisabledException "AcceleratorNotDisabledException" The accelerator that you specified could not be disabled.

  • ErrCodeAssociatedListenerFoundException "AssociatedListenerFoundException" The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteAccelerator

func (*GlobalAccelerator) DeleteAcceleratorRequest

func (c *GlobalAccelerator) DeleteAcceleratorRequest(input *DeleteAcceleratorInput) (req *request.Request, output *DeleteAcceleratorOutput)

DeleteAcceleratorRequest generates a "aws/request.Request" representing the client's request for the DeleteAccelerator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccelerator for more information on using the DeleteAccelerator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAcceleratorRequest method.
req, resp := client.DeleteAcceleratorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteAccelerator

func (*GlobalAccelerator) DeleteAcceleratorWithContext

func (c *GlobalAccelerator) DeleteAcceleratorWithContext(ctx aws.Context, input *DeleteAcceleratorInput, opts ...request.Option) (*DeleteAcceleratorOutput, error)

DeleteAcceleratorWithContext is the same as DeleteAccelerator with the addition of the ability to pass a context and additional request options.

See DeleteAccelerator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DeleteEndpointGroup

DeleteEndpointGroup API operation for AWS Global Accelerator.

Delete an endpoint group from a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DeleteEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteEndpointGroup

func (*GlobalAccelerator) DeleteEndpointGroupRequest

func (c *GlobalAccelerator) DeleteEndpointGroupRequest(input *DeleteEndpointGroupInput) (req *request.Request, output *DeleteEndpointGroupOutput)

DeleteEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteEndpointGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteEndpointGroup for more information on using the DeleteEndpointGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteEndpointGroupRequest method.
req, resp := client.DeleteEndpointGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteEndpointGroup

func (*GlobalAccelerator) DeleteEndpointGroupWithContext

func (c *GlobalAccelerator) DeleteEndpointGroupWithContext(ctx aws.Context, input *DeleteEndpointGroupInput, opts ...request.Option) (*DeleteEndpointGroupOutput, error)

DeleteEndpointGroupWithContext is the same as DeleteEndpointGroup with the addition of the ability to pass a context and additional request options.

See DeleteEndpointGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DeleteListener

func (c *GlobalAccelerator) DeleteListener(input *DeleteListenerInput) (*DeleteListenerOutput, error)

DeleteListener API operation for AWS Global Accelerator.

Delete a listener from an accelerator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DeleteListener for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeAssociatedEndpointGroupFoundException "AssociatedEndpointGroupFoundException" The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteListener

func (*GlobalAccelerator) DeleteListenerRequest

func (c *GlobalAccelerator) DeleteListenerRequest(input *DeleteListenerInput) (req *request.Request, output *DeleteListenerOutput)

DeleteListenerRequest generates a "aws/request.Request" representing the client's request for the DeleteListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteListener for more information on using the DeleteListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteListenerRequest method.
req, resp := client.DeleteListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteListener

func (*GlobalAccelerator) DeleteListenerWithContext

func (c *GlobalAccelerator) DeleteListenerWithContext(ctx aws.Context, input *DeleteListenerInput, opts ...request.Option) (*DeleteListenerOutput, error)

DeleteListenerWithContext is the same as DeleteListener with the addition of the ability to pass a context and additional request options.

See DeleteListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DescribeAccelerator

DescribeAccelerator API operation for AWS Global Accelerator.

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator

func (*GlobalAccelerator) DescribeAcceleratorAttributes

DescribeAcceleratorAttributes API operation for AWS Global Accelerator.

Describe the attributes of an accelerator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeAcceleratorAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAcceleratorAttributes

func (*GlobalAccelerator) DescribeAcceleratorAttributesRequest

func (c *GlobalAccelerator) DescribeAcceleratorAttributesRequest(input *DescribeAcceleratorAttributesInput) (req *request.Request, output *DescribeAcceleratorAttributesOutput)

DescribeAcceleratorAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeAcceleratorAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAcceleratorAttributes for more information on using the DescribeAcceleratorAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAcceleratorAttributesRequest method.
req, resp := client.DescribeAcceleratorAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAcceleratorAttributes

func (*GlobalAccelerator) DescribeAcceleratorAttributesWithContext

func (c *GlobalAccelerator) DescribeAcceleratorAttributesWithContext(ctx aws.Context, input *DescribeAcceleratorAttributesInput, opts ...request.Option) (*DescribeAcceleratorAttributesOutput, error)

DescribeAcceleratorAttributesWithContext is the same as DescribeAcceleratorAttributes with the addition of the ability to pass a context and additional request options.

See DescribeAcceleratorAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DescribeAcceleratorRequest

func (c *GlobalAccelerator) DescribeAcceleratorRequest(input *DescribeAcceleratorInput) (req *request.Request, output *DescribeAcceleratorOutput)

DescribeAcceleratorRequest generates a "aws/request.Request" representing the client's request for the DescribeAccelerator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccelerator for more information on using the DescribeAccelerator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeAcceleratorRequest method.
req, resp := client.DescribeAcceleratorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator

func (*GlobalAccelerator) DescribeAcceleratorWithContext

func (c *GlobalAccelerator) DescribeAcceleratorWithContext(ctx aws.Context, input *DescribeAcceleratorInput, opts ...request.Option) (*DescribeAcceleratorOutput, error)

DescribeAcceleratorWithContext is the same as DescribeAccelerator with the addition of the ability to pass a context and additional request options.

See DescribeAccelerator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DescribeEndpointGroup

DescribeEndpointGroup API operation for AWS Global Accelerator.

Describe an endpoint group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeEndpointGroup

func (*GlobalAccelerator) DescribeEndpointGroupRequest

func (c *GlobalAccelerator) DescribeEndpointGroupRequest(input *DescribeEndpointGroupInput) (req *request.Request, output *DescribeEndpointGroupOutput)

DescribeEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpointGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeEndpointGroup for more information on using the DescribeEndpointGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeEndpointGroupRequest method.
req, resp := client.DescribeEndpointGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeEndpointGroup

func (*GlobalAccelerator) DescribeEndpointGroupWithContext

func (c *GlobalAccelerator) DescribeEndpointGroupWithContext(ctx aws.Context, input *DescribeEndpointGroupInput, opts ...request.Option) (*DescribeEndpointGroupOutput, error)

DescribeEndpointGroupWithContext is the same as DescribeEndpointGroup with the addition of the ability to pass a context and additional request options.

See DescribeEndpointGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) DescribeListener

func (c *GlobalAccelerator) DescribeListener(input *DescribeListenerInput) (*DescribeListenerOutput, error)

DescribeListener API operation for AWS Global Accelerator.

Describe a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation DescribeListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeListener

func (*GlobalAccelerator) DescribeListenerRequest

func (c *GlobalAccelerator) DescribeListenerRequest(input *DescribeListenerInput) (req *request.Request, output *DescribeListenerOutput)

DescribeListenerRequest generates a "aws/request.Request" representing the client's request for the DescribeListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeListener for more information on using the DescribeListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeListenerRequest method.
req, resp := client.DescribeListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeListener

func (*GlobalAccelerator) DescribeListenerWithContext

func (c *GlobalAccelerator) DescribeListenerWithContext(ctx aws.Context, input *DescribeListenerInput, opts ...request.Option) (*DescribeListenerOutput, error)

DescribeListenerWithContext is the same as DescribeListener with the addition of the ability to pass a context and additional request options.

See DescribeListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) ListAccelerators

func (c *GlobalAccelerator) ListAccelerators(input *ListAcceleratorsInput) (*ListAcceleratorsOutput, error)

ListAccelerators API operation for AWS Global Accelerator.

List the accelerators for an AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation ListAccelerators for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators

func (*GlobalAccelerator) ListAcceleratorsRequest

func (c *GlobalAccelerator) ListAcceleratorsRequest(input *ListAcceleratorsInput) (req *request.Request, output *ListAcceleratorsOutput)

ListAcceleratorsRequest generates a "aws/request.Request" representing the client's request for the ListAccelerators operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAccelerators for more information on using the ListAccelerators API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAcceleratorsRequest method.
req, resp := client.ListAcceleratorsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators

func (*GlobalAccelerator) ListAcceleratorsWithContext

func (c *GlobalAccelerator) ListAcceleratorsWithContext(ctx aws.Context, input *ListAcceleratorsInput, opts ...request.Option) (*ListAcceleratorsOutput, error)

ListAcceleratorsWithContext is the same as ListAccelerators with the addition of the ability to pass a context and additional request options.

See ListAccelerators for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) ListEndpointGroups

func (c *GlobalAccelerator) ListEndpointGroups(input *ListEndpointGroupsInput) (*ListEndpointGroupsOutput, error)

ListEndpointGroups API operation for AWS Global Accelerator.

List the endpoint groups that are associated with a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation ListEndpointGroups for usage and error information.

Returned Error Codes:

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListEndpointGroups

func (*GlobalAccelerator) ListEndpointGroupsRequest

func (c *GlobalAccelerator) ListEndpointGroupsRequest(input *ListEndpointGroupsInput) (req *request.Request, output *ListEndpointGroupsOutput)

ListEndpointGroupsRequest generates a "aws/request.Request" representing the client's request for the ListEndpointGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListEndpointGroups for more information on using the ListEndpointGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListEndpointGroupsRequest method.
req, resp := client.ListEndpointGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListEndpointGroups

func (*GlobalAccelerator) ListEndpointGroupsWithContext

func (c *GlobalAccelerator) ListEndpointGroupsWithContext(ctx aws.Context, input *ListEndpointGroupsInput, opts ...request.Option) (*ListEndpointGroupsOutput, error)

ListEndpointGroupsWithContext is the same as ListEndpointGroups with the addition of the ability to pass a context and additional request options.

See ListEndpointGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) ListListeners

func (c *GlobalAccelerator) ListListeners(input *ListListenersInput) (*ListListenersOutput, error)

ListListeners API operation for AWS Global Accelerator.

List the listeners for an accelerator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation ListListeners for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" There isn't another item to return.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListListeners

func (*GlobalAccelerator) ListListenersRequest

func (c *GlobalAccelerator) ListListenersRequest(input *ListListenersInput) (req *request.Request, output *ListListenersOutput)

ListListenersRequest generates a "aws/request.Request" representing the client's request for the ListListeners operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListListeners for more information on using the ListListeners API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListListenersRequest method.
req, resp := client.ListListenersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListListeners

func (*GlobalAccelerator) ListListenersWithContext

func (c *GlobalAccelerator) ListListenersWithContext(ctx aws.Context, input *ListListenersInput, opts ...request.Option) (*ListListenersOutput, error)

ListListenersWithContext is the same as ListListeners with the addition of the ability to pass a context and additional request options.

See ListListeners for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) UpdateAccelerator

func (c *GlobalAccelerator) UpdateAccelerator(input *UpdateAcceleratorInput) (*UpdateAcceleratorOutput, error)

UpdateAccelerator API operation for AWS Global Accelerator.

Update an accelerator.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateAccelerator for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator

func (*GlobalAccelerator) UpdateAcceleratorAttributes

UpdateAcceleratorAttributes API operation for AWS Global Accelerator.

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateAcceleratorAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeAcceleratorNotFoundException "AcceleratorNotFoundException" The accelerator that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAcceleratorAttributes

func (*GlobalAccelerator) UpdateAcceleratorAttributesRequest

func (c *GlobalAccelerator) UpdateAcceleratorAttributesRequest(input *UpdateAcceleratorAttributesInput) (req *request.Request, output *UpdateAcceleratorAttributesOutput)

UpdateAcceleratorAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateAcceleratorAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAcceleratorAttributes for more information on using the UpdateAcceleratorAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAcceleratorAttributesRequest method.
req, resp := client.UpdateAcceleratorAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAcceleratorAttributes

func (*GlobalAccelerator) UpdateAcceleratorAttributesWithContext

func (c *GlobalAccelerator) UpdateAcceleratorAttributesWithContext(ctx aws.Context, input *UpdateAcceleratorAttributesInput, opts ...request.Option) (*UpdateAcceleratorAttributesOutput, error)

UpdateAcceleratorAttributesWithContext is the same as UpdateAcceleratorAttributes with the addition of the ability to pass a context and additional request options.

See UpdateAcceleratorAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) UpdateAcceleratorRequest

func (c *GlobalAccelerator) UpdateAcceleratorRequest(input *UpdateAcceleratorInput) (req *request.Request, output *UpdateAcceleratorOutput)

UpdateAcceleratorRequest generates a "aws/request.Request" representing the client's request for the UpdateAccelerator operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAccelerator for more information on using the UpdateAccelerator API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAcceleratorRequest method.
req, resp := client.UpdateAcceleratorRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator

func (*GlobalAccelerator) UpdateAcceleratorWithContext

func (c *GlobalAccelerator) UpdateAcceleratorWithContext(ctx aws.Context, input *UpdateAcceleratorInput, opts ...request.Option) (*UpdateAcceleratorOutput, error)

UpdateAcceleratorWithContext is the same as UpdateAccelerator with the addition of the ability to pass a context and additional request options.

See UpdateAccelerator for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) UpdateEndpointGroup

UpdateEndpointGroup API operation for AWS Global Accelerator.

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateEndpointGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeEndpointGroupNotFoundException "EndpointGroupNotFoundException" The endpoint group that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateEndpointGroup

func (*GlobalAccelerator) UpdateEndpointGroupRequest

func (c *GlobalAccelerator) UpdateEndpointGroupRequest(input *UpdateEndpointGroupInput) (req *request.Request, output *UpdateEndpointGroupOutput)

UpdateEndpointGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateEndpointGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateEndpointGroup for more information on using the UpdateEndpointGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateEndpointGroupRequest method.
req, resp := client.UpdateEndpointGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateEndpointGroup

func (*GlobalAccelerator) UpdateEndpointGroupWithContext

func (c *GlobalAccelerator) UpdateEndpointGroupWithContext(ctx aws.Context, input *UpdateEndpointGroupInput, opts ...request.Option) (*UpdateEndpointGroupOutput, error)

UpdateEndpointGroupWithContext is the same as UpdateEndpointGroup with the addition of the ability to pass a context and additional request options.

See UpdateEndpointGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*GlobalAccelerator) UpdateListener

func (c *GlobalAccelerator) UpdateListener(input *UpdateListenerInput) (*UpdateListenerOutput, error)

UpdateListener API operation for AWS Global Accelerator.

Update a listener.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Global Accelerator's API operation UpdateListener for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidArgumentException "InvalidArgumentException" An argument that you specified is invalid.

  • ErrCodeInvalidPortRangeException "InvalidPortRangeException" The port numbers that you specified are not valid numbers or are not unique for this accelerator.

  • ErrCodeListenerNotFoundException "ListenerNotFoundException" The listener that you specified doesn't exist.

  • ErrCodeInternalServiceErrorException "InternalServiceErrorException" There was an internal error for AWS Global Accelerator.

  • ErrCodeLimitExceededException "LimitExceededException" Processing your request would cause you to exceed an AWS Global Accelerator limit.

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListener

func (*GlobalAccelerator) UpdateListenerRequest

func (c *GlobalAccelerator) UpdateListenerRequest(input *UpdateListenerInput) (req *request.Request, output *UpdateListenerOutput)

UpdateListenerRequest generates a "aws/request.Request" representing the client's request for the UpdateListener operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateListener for more information on using the UpdateListener API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateListenerRequest method.
req, resp := client.UpdateListenerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListener

func (*GlobalAccelerator) UpdateListenerWithContext

func (c *GlobalAccelerator) UpdateListenerWithContext(ctx aws.Context, input *UpdateListenerInput, opts ...request.Option) (*UpdateListenerOutput, error)

UpdateListenerWithContext is the same as UpdateListener with the addition of the ability to pass a context and additional request options.

See UpdateListener for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type IpSet

type IpSet struct {

	// The array of IP addresses in the IP address set. An IP address set can have
	// a maximum of two IP addresses.
	IpAddresses []*string `type:"list"`

	// The types of IP addresses included in this IP set.
	IpFamily *string `type:"string"`
	// contains filtered or unexported fields
}

A complex type for the set of IP addresses for an accelerator.

func (IpSet) GoString

func (s IpSet) GoString() string

GoString returns the string representation

func (*IpSet) SetIpAddresses

func (s *IpSet) SetIpAddresses(v []*string) *IpSet

SetIpAddresses sets the IpAddresses field's value.

func (*IpSet) SetIpFamily

func (s *IpSet) SetIpFamily(v string) *IpSet

SetIpFamily sets the IpFamily field's value.

func (IpSet) String

func (s IpSet) String() string

String returns the string representation

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 *int64 `min:"1" type:"integer"`

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

func (ListAcceleratorsInput) GoString

func (s ListAcceleratorsInput) GoString() string

GoString returns the string representation

func (*ListAcceleratorsInput) SetMaxResults

func (s *ListAcceleratorsInput) SetMaxResults(v int64) *ListAcceleratorsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAcceleratorsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAcceleratorsInput) String

func (s ListAcceleratorsInput) String() string

String returns the string representation

func (*ListAcceleratorsInput) Validate

func (s *ListAcceleratorsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAcceleratorsOutput

type ListAcceleratorsOutput struct {

	// The list of accelerators for a customer account.
	Accelerators []*Accelerator `type:"list"`

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

func (ListAcceleratorsOutput) GoString

func (s ListAcceleratorsOutput) GoString() string

GoString returns the string representation

func (*ListAcceleratorsOutput) SetAccelerators

func (s *ListAcceleratorsOutput) SetAccelerators(v []*Accelerator) *ListAcceleratorsOutput

SetAccelerators sets the Accelerators field's value.

func (*ListAcceleratorsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAcceleratorsOutput) String

func (s ListAcceleratorsOutput) String() string

String returns the string representation

type ListEndpointGroupsInput

type ListEndpointGroupsInput struct {

	// The Amazon Resource Name (ARN) of the listener.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// The number of endpoint group objects that you want to return with this call.
	// The default value is 10.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListEndpointGroupsInput) GoString

func (s ListEndpointGroupsInput) GoString() string

GoString returns the string representation

func (*ListEndpointGroupsInput) SetListenerArn

SetListenerArn sets the ListenerArn field's value.

func (*ListEndpointGroupsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListEndpointGroupsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEndpointGroupsInput) String

func (s ListEndpointGroupsInput) String() string

String returns the string representation

func (*ListEndpointGroupsInput) Validate

func (s *ListEndpointGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListEndpointGroupsOutput

type ListEndpointGroupsOutput struct {

	// The list of the endpoint groups associated with a listener.
	EndpointGroups []*EndpointGroup `type:"list"`

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

func (ListEndpointGroupsOutput) GoString

func (s ListEndpointGroupsOutput) GoString() string

GoString returns the string representation

func (*ListEndpointGroupsOutput) SetEndpointGroups

SetEndpointGroups sets the EndpointGroups field's value.

func (*ListEndpointGroupsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListEndpointGroupsOutput) String

func (s ListEndpointGroupsOutput) String() string

String returns the string representation

type ListListenersInput

type ListListenersInput struct {

	// The Amazon Resource Name (ARN) of the accelerator for which you want to list
	// listener objects.
	//
	// AcceleratorArn is a required field
	AcceleratorArn *string `type:"string" required:"true"`

	// The number of listener objects that you want to return with this call. The
	// default value is 10.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListListenersInput) GoString

func (s ListListenersInput) GoString() string

GoString returns the string representation

func (*ListListenersInput) SetAcceleratorArn

func (s *ListListenersInput) SetAcceleratorArn(v string) *ListListenersInput

SetAcceleratorArn sets the AcceleratorArn field's value.

func (*ListListenersInput) SetMaxResults

func (s *ListListenersInput) SetMaxResults(v int64) *ListListenersInput

SetMaxResults sets the MaxResults field's value.

func (*ListListenersInput) SetNextToken

func (s *ListListenersInput) SetNextToken(v string) *ListListenersInput

SetNextToken sets the NextToken field's value.

func (ListListenersInput) String

func (s ListListenersInput) String() string

String returns the string representation

func (*ListListenersInput) Validate

func (s *ListListenersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListListenersOutput

type ListListenersOutput struct {

	// The list of listeners for an accelerator.
	Listeners []*Listener `type:"list"`

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

func (ListListenersOutput) GoString

func (s ListListenersOutput) GoString() string

GoString returns the string representation

func (*ListListenersOutput) SetListeners

func (s *ListListenersOutput) SetListeners(v []*Listener) *ListListenersOutput

SetListeners sets the Listeners field's value.

func (*ListListenersOutput) SetNextToken

func (s *ListListenersOutput) SetNextToken(v string) *ListListenersOutput

SetNextToken sets the NextToken field's value.

func (ListListenersOutput) String

func (s ListListenersOutput) String() string

String returns the string representation

type Listener

type Listener struct {

	// 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. Clienty affinity gives you control over whether to always
	// route each client to the same specific endpoint.
	//
	// AWS 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 *string `type:"string" enum:"ClientAffinity"`

	// The Amazon Resource Name (ARN) of the listener.
	ListenerArn *string `type:"string"`

	// The list of port ranges for the connections from clients to the accelerator.
	PortRanges []*PortRange `min:"1" type:"list"`

	// The protocol for the connections from clients to the accelerator.
	Protocol *string `type:"string" enum:"Protocol"`
	// contains filtered or unexported fields
}

A complex type for a listener.

func (Listener) GoString

func (s Listener) GoString() string

GoString returns the string representation

func (*Listener) SetClientAffinity

func (s *Listener) SetClientAffinity(v string) *Listener

SetClientAffinity sets the ClientAffinity field's value.

func (*Listener) SetListenerArn

func (s *Listener) SetListenerArn(v string) *Listener

SetListenerArn sets the ListenerArn field's value.

func (*Listener) SetPortRanges

func (s *Listener) SetPortRanges(v []*PortRange) *Listener

SetPortRanges sets the PortRanges field's value.

func (*Listener) SetProtocol

func (s *Listener) SetProtocol(v string) *Listener

SetProtocol sets the Protocol field's value.

func (Listener) String

func (s Listener) String() string

String returns the string representation

type PortRange

type PortRange struct {

	// The first port in the range of ports, inclusive.
	FromPort *int64 `min:"1" type:"integer"`

	// The last port in the range of ports, inclusive.
	ToPort *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

A complex type for a range of ports for a listener.

func (PortRange) GoString

func (s PortRange) GoString() string

GoString returns the string representation

func (*PortRange) SetFromPort

func (s *PortRange) SetFromPort(v int64) *PortRange

SetFromPort sets the FromPort field's value.

func (*PortRange) SetToPort

func (s *PortRange) SetToPort(v int64) *PortRange

SetToPort sets the ToPort field's value.

func (PortRange) String

func (s PortRange) String() string

String returns the string representation

func (*PortRange) Validate

func (s *PortRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAcceleratorAttributesInput

type UpdateAcceleratorAttributesInput struct {

	// The Amazon Resource Name (ARN) of the accelerator that you want to update.
	// Attribute is required.
	AcceleratorArn *string `type:"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 (https://docs.aws.amazon.com/global-accelerator/latest/dg/monitoring-global-accelerator.flow-logs.html)
	// in the AWS Global Accelerator Developer Guide.
	FlowLogsEnabled *bool `type:"boolean"`

	// 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 AWS Global Accelerator permission to write to the bucket.
	FlowLogsS3Bucket *string `type:"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.
	FlowLogsS3Prefix *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAcceleratorAttributesInput) GoString

GoString returns the string representation

func (*UpdateAcceleratorAttributesInput) SetAcceleratorArn

SetAcceleratorArn sets the AcceleratorArn field's value.

func (*UpdateAcceleratorAttributesInput) SetFlowLogsEnabled

SetFlowLogsEnabled sets the FlowLogsEnabled field's value.

func (*UpdateAcceleratorAttributesInput) SetFlowLogsS3Bucket

SetFlowLogsS3Bucket sets the FlowLogsS3Bucket field's value.

func (*UpdateAcceleratorAttributesInput) SetFlowLogsS3Prefix

SetFlowLogsS3Prefix sets the FlowLogsS3Prefix field's value.

func (UpdateAcceleratorAttributesInput) String

String returns the string representation

type UpdateAcceleratorAttributesOutput

type UpdateAcceleratorAttributesOutput struct {

	// Updated attributes for the accelerator.
	AcceleratorAttributes *AcceleratorAttributes `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAcceleratorAttributesOutput) GoString

GoString returns the string representation

func (*UpdateAcceleratorAttributesOutput) SetAcceleratorAttributes

SetAcceleratorAttributes sets the AcceleratorAttributes field's value.

func (UpdateAcceleratorAttributesOutput) String

String returns the string representation

type UpdateAcceleratorInput

type UpdateAcceleratorInput struct {

	// The Amazon Resource Name (ARN) of the accelerator to update.
	//
	// AcceleratorArn is a required field
	AcceleratorArn *string `type:"string" required:"true"`

	// 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 `type:"boolean"`

	// The value for the address type must be IPv4.
	IpAddressType *string `type:"string" enum:"IpAddressType"`

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

func (UpdateAcceleratorInput) GoString

func (s UpdateAcceleratorInput) GoString() string

GoString returns the string representation

func (*UpdateAcceleratorInput) SetAcceleratorArn

func (s *UpdateAcceleratorInput) SetAcceleratorArn(v string) *UpdateAcceleratorInput

SetAcceleratorArn sets the AcceleratorArn field's value.

func (*UpdateAcceleratorInput) SetEnabled

SetEnabled sets the Enabled field's value.

func (*UpdateAcceleratorInput) SetIpAddressType

func (s *UpdateAcceleratorInput) SetIpAddressType(v string) *UpdateAcceleratorInput

SetIpAddressType sets the IpAddressType field's value.

func (*UpdateAcceleratorInput) SetName

SetName sets the Name field's value.

func (UpdateAcceleratorInput) String

func (s UpdateAcceleratorInput) String() string

String returns the string representation

func (*UpdateAcceleratorInput) Validate

func (s *UpdateAcceleratorInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAcceleratorOutput

type UpdateAcceleratorOutput struct {

	// Information about the updated accelerator.
	Accelerator *Accelerator `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateAcceleratorOutput) GoString

func (s UpdateAcceleratorOutput) GoString() string

GoString returns the string representation

func (*UpdateAcceleratorOutput) SetAccelerator

SetAccelerator sets the Accelerator field's value.

func (UpdateAcceleratorOutput) String

func (s UpdateAcceleratorOutput) String() string

String returns the string representation

type UpdateEndpointGroupInput

type UpdateEndpointGroupInput struct {

	// The list of endpoint objects.
	EndpointConfigurations []*EndpointConfiguration `type:"list"`

	// The Amazon Resource Name (ARN) of the endpoint group.
	//
	// EndpointGroupArn is a required field
	EndpointGroupArn *string `type:"string" required:"true"`

	// The time—10 seconds or 30 seconds—between each health check for an endpoint.
	// The default value is 30.
	HealthCheckIntervalSeconds *int64 `min:"10" type:"integer"`

	// 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 `type:"string"`

	// The port that AWS 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 *int64 `min:"1" type:"integer"`

	// The protocol that AWS Global Accelerator uses to check the health of endpoints
	// that are part of this endpoint group. The default value is TCP.
	HealthCheckProtocol *string `type:"string" enum:"HealthCheckProtocol"`

	// 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 *int64 `min:"1" type:"integer"`

	// The percentage of traffic to send to an AWS 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 *float64 `type:"float"`
	// contains filtered or unexported fields
}

func (UpdateEndpointGroupInput) GoString

func (s UpdateEndpointGroupInput) GoString() string

GoString returns the string representation

func (*UpdateEndpointGroupInput) SetEndpointConfigurations

func (s *UpdateEndpointGroupInput) SetEndpointConfigurations(v []*EndpointConfiguration) *UpdateEndpointGroupInput

SetEndpointConfigurations sets the EndpointConfigurations field's value.

func (*UpdateEndpointGroupInput) SetEndpointGroupArn

func (s *UpdateEndpointGroupInput) SetEndpointGroupArn(v string) *UpdateEndpointGroupInput

SetEndpointGroupArn sets the EndpointGroupArn field's value.

func (*UpdateEndpointGroupInput) SetHealthCheckIntervalSeconds

func (s *UpdateEndpointGroupInput) SetHealthCheckIntervalSeconds(v int64) *UpdateEndpointGroupInput

SetHealthCheckIntervalSeconds sets the HealthCheckIntervalSeconds field's value.

func (*UpdateEndpointGroupInput) SetHealthCheckPath

func (s *UpdateEndpointGroupInput) SetHealthCheckPath(v string) *UpdateEndpointGroupInput

SetHealthCheckPath sets the HealthCheckPath field's value.

func (*UpdateEndpointGroupInput) SetHealthCheckPort

func (s *UpdateEndpointGroupInput) SetHealthCheckPort(v int64) *UpdateEndpointGroupInput

SetHealthCheckPort sets the HealthCheckPort field's value.

func (*UpdateEndpointGroupInput) SetHealthCheckProtocol

func (s *UpdateEndpointGroupInput) SetHealthCheckProtocol(v string) *UpdateEndpointGroupInput

SetHealthCheckProtocol sets the HealthCheckProtocol field's value.

func (*UpdateEndpointGroupInput) SetThresholdCount

func (s *UpdateEndpointGroupInput) SetThresholdCount(v int64) *UpdateEndpointGroupInput

SetThresholdCount sets the ThresholdCount field's value.

func (*UpdateEndpointGroupInput) SetTrafficDialPercentage

func (s *UpdateEndpointGroupInput) SetTrafficDialPercentage(v float64) *UpdateEndpointGroupInput

SetTrafficDialPercentage sets the TrafficDialPercentage field's value.

func (UpdateEndpointGroupInput) String

func (s UpdateEndpointGroupInput) String() string

String returns the string representation

func (*UpdateEndpointGroupInput) Validate

func (s *UpdateEndpointGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateEndpointGroupOutput

type UpdateEndpointGroupOutput struct {

	// The information about the endpoint group that was updated.
	EndpointGroup *EndpointGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateEndpointGroupOutput) GoString

func (s UpdateEndpointGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateEndpointGroupOutput) SetEndpointGroup

SetEndpointGroup sets the EndpointGroup field's value.

func (UpdateEndpointGroupOutput) String

func (s UpdateEndpointGroupOutput) String() string

String returns the string representation

type UpdateListenerInput

type UpdateListenerInput struct {

	// 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. Clienty affinity gives you control over whether to always
	// route each client to the same specific endpoint.
	//
	// AWS 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 *string `type:"string" enum:"ClientAffinity"`

	// The Amazon Resource Name (ARN) of the listener to update.
	//
	// ListenerArn is a required field
	ListenerArn *string `type:"string" required:"true"`

	// The updated list of port ranges for the connections from clients to the accelerator.
	PortRanges []*PortRange `min:"1" type:"list"`

	// The updated protocol for the connections from clients to the accelerator.
	Protocol *string `type:"string" enum:"Protocol"`
	// contains filtered or unexported fields
}

func (UpdateListenerInput) GoString

func (s UpdateListenerInput) GoString() string

GoString returns the string representation

func (*UpdateListenerInput) SetClientAffinity

func (s *UpdateListenerInput) SetClientAffinity(v string) *UpdateListenerInput

SetClientAffinity sets the ClientAffinity field's value.

func (*UpdateListenerInput) SetListenerArn

func (s *UpdateListenerInput) SetListenerArn(v string) *UpdateListenerInput

SetListenerArn sets the ListenerArn field's value.

func (*UpdateListenerInput) SetPortRanges

func (s *UpdateListenerInput) SetPortRanges(v []*PortRange) *UpdateListenerInput

SetPortRanges sets the PortRanges field's value.

func (*UpdateListenerInput) SetProtocol

func (s *UpdateListenerInput) SetProtocol(v string) *UpdateListenerInput

SetProtocol sets the Protocol field's value.

func (UpdateListenerInput) String

func (s UpdateListenerInput) String() string

String returns the string representation

func (*UpdateListenerInput) Validate

func (s *UpdateListenerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateListenerOutput

type UpdateListenerOutput struct {

	// Information for the updated listener.
	Listener *Listener `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateListenerOutput) GoString

func (s UpdateListenerOutput) GoString() string

GoString returns the string representation

func (*UpdateListenerOutput) SetListener

SetListener sets the Listener field's value.

func (UpdateListenerOutput) String

func (s UpdateListenerOutput) String() string

String returns the string representation

Directories

Path Synopsis
Package globalacceleratoriface provides an interface to enable mocking the AWS Global Accelerator service client for testing your code.
Package globalacceleratoriface provides an interface to enable mocking the AWS Global Accelerator service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL