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.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
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 use 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 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/globalaccelerator/#New
Index ¶
- Constants
- type Accelerator
- type AcceleratorAttributes
- type AcceleratorStatus
- type Affinity
- type Client
- func (c *Client) CreateAcceleratorRequest(input *CreateAcceleratorInput) CreateAcceleratorRequest
- func (c *Client) CreateEndpointGroupRequest(input *CreateEndpointGroupInput) CreateEndpointGroupRequest
- func (c *Client) CreateListenerRequest(input *CreateListenerInput) CreateListenerRequest
- func (c *Client) DeleteAcceleratorRequest(input *DeleteAcceleratorInput) DeleteAcceleratorRequest
- func (c *Client) DeleteEndpointGroupRequest(input *DeleteEndpointGroupInput) DeleteEndpointGroupRequest
- func (c *Client) DeleteListenerRequest(input *DeleteListenerInput) DeleteListenerRequest
- func (c *Client) DescribeAcceleratorAttributesRequest(input *DescribeAcceleratorAttributesInput) DescribeAcceleratorAttributesRequest
- func (c *Client) DescribeAcceleratorRequest(input *DescribeAcceleratorInput) DescribeAcceleratorRequest
- func (c *Client) DescribeEndpointGroupRequest(input *DescribeEndpointGroupInput) DescribeEndpointGroupRequest
- func (c *Client) DescribeListenerRequest(input *DescribeListenerInput) DescribeListenerRequest
- func (c *Client) ListAcceleratorsRequest(input *ListAcceleratorsInput) ListAcceleratorsRequest
- func (c *Client) ListEndpointGroupsRequest(input *ListEndpointGroupsInput) ListEndpointGroupsRequest
- func (c *Client) ListListenersRequest(input *ListListenersInput) ListListenersRequest
- func (c *Client) UpdateAcceleratorAttributesRequest(input *UpdateAcceleratorAttributesInput) UpdateAcceleratorAttributesRequest
- func (c *Client) UpdateAcceleratorRequest(input *UpdateAcceleratorInput) UpdateAcceleratorRequest
- func (c *Client) UpdateEndpointGroupRequest(input *UpdateEndpointGroupInput) UpdateEndpointGroupRequest
- func (c *Client) UpdateListenerRequest(input *UpdateListenerInput) UpdateListenerRequest
- type CreateAcceleratorInput
- type CreateAcceleratorOutput
- type CreateAcceleratorRequest
- type CreateAcceleratorResponse
- type CreateEndpointGroupInput
- type CreateEndpointGroupOutput
- type CreateEndpointGroupRequest
- type CreateEndpointGroupResponse
- type CreateListenerInput
- type CreateListenerOutput
- type CreateListenerRequest
- type CreateListenerResponse
- type DeleteAcceleratorInput
- type DeleteAcceleratorOutput
- type DeleteAcceleratorRequest
- type DeleteAcceleratorResponse
- type DeleteEndpointGroupInput
- type DeleteEndpointGroupOutput
- type DeleteEndpointGroupRequest
- type DeleteEndpointGroupResponse
- type DeleteListenerInput
- type DeleteListenerOutput
- type DeleteListenerRequest
- type DeleteListenerResponse
- type DescribeAcceleratorAttributesInput
- type DescribeAcceleratorAttributesOutput
- type DescribeAcceleratorAttributesRequest
- type DescribeAcceleratorAttributesResponse
- type DescribeAcceleratorInput
- type DescribeAcceleratorOutput
- type DescribeAcceleratorRequest
- type DescribeAcceleratorResponse
- type DescribeEndpointGroupInput
- type DescribeEndpointGroupOutput
- type DescribeEndpointGroupRequest
- type DescribeEndpointGroupResponse
- type DescribeListenerInput
- type DescribeListenerOutput
- type DescribeListenerRequest
- type DescribeListenerResponse
- type EndpointConfiguration
- type EndpointDescription
- type EndpointGroup
- type HealthCheckProtocol
- type HealthState
- type IpAddressType
- type IpSet
- type ListAcceleratorsInput
- type ListAcceleratorsOutput
- type ListAcceleratorsRequest
- type ListAcceleratorsResponse
- type ListEndpointGroupsInput
- type ListEndpointGroupsOutput
- type ListEndpointGroupsRequest
- type ListEndpointGroupsResponse
- type ListListenersInput
- type ListListenersOutput
- type ListListenersRequest
- type ListListenersResponse
- type Listener
- type PortRange
- type Protocol
- type UpdateAcceleratorAttributesInput
- type UpdateAcceleratorAttributesOutput
- type UpdateAcceleratorAttributesRequest
- type UpdateAcceleratorAttributesResponse
- type UpdateAcceleratorInput
- type UpdateAcceleratorOutput
- type UpdateAcceleratorRequest
- type UpdateAcceleratorResponse
- type UpdateEndpointGroupInput
- type UpdateEndpointGroupOutput
- type UpdateEndpointGroupRequest
- type UpdateEndpointGroupResponse
- type UpdateListenerInput
- type UpdateListenerOutput
- type UpdateListenerRequest
- type UpdateListenerResponse
Constants ¶
const ( ServiceName = "AWS Global Accelerator" // Service's name ServiceID = "GlobalAccelerator" // Service's identifier EndpointsID = "globalaccelerator" // Service's Endpoint identifier )
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" // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You don't have access permission. ErrCodeAccessDeniedException = "AccessDeniedException" // 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" )
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"` // The Domain Name System (DNS) name that Global Accelerator creates that points // to your accelerator's static IP addresses. // // The naming convention for the DNS name is: a lower case letter a, followed // by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For // example: a1234567890abcdef.awsglobalaccelerator.com. // // For more information about the default DNS name, see Support for DNS Addressing // in Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html#about-accelerators.dns-addressing) // in the AWS Global Accelerator Developer Guide. DnsName *string `type:"string"` // Indicates whether the 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, accelerator can be deleted. Enabled *bool `type:"boolean"` // The value for the address type must be IPv4. IpAddressType IpAddressType `type:"string" enum:"true"` // The static IP addresses that Global Accelerator associates 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 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 AcceleratorStatus `type:"string" enum:"true"` // 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) 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) String ¶
func (s AcceleratorAttributes) String() string
String returns the string representation
type AcceleratorStatus ¶
type AcceleratorStatus string
const ( AcceleratorStatusDeployed AcceleratorStatus = "DEPLOYED" AcceleratorStatusInProgress AcceleratorStatus = "IN_PROGRESS" )
Enum values for AcceleratorStatus
func (AcceleratorStatus) MarshalValue ¶
func (enum AcceleratorStatus) MarshalValue() (string, error)
func (AcceleratorStatus) MarshalValueBuf ¶
func (enum AcceleratorStatus) MarshalValueBuf(b []byte) ([]byte, error)
type Affinity ¶ added in v0.9.0
type Affinity string
Enum values for Affinity
func (Affinity) MarshalValue ¶ added in v0.9.0
type Client ¶ added in v0.9.0
Client provides the API operation methods for making requests to AWS Global Accelerator. See this package's package overview docs for details on the service.
The client's 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 client from the provided Config.
Example:
// Create a client from just a config. svc := globalaccelerator.New(myConfig)
func (*Client) CreateAcceleratorRequest ¶ added in v0.9.0
func (c *Client) CreateAcceleratorRequest(input *CreateAcceleratorInput) CreateAcceleratorRequest
CreateAcceleratorRequest returns a request value for making 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.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
// Example sending a request using CreateAcceleratorRequest. req := client.CreateAcceleratorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateAccelerator
func (*Client) CreateEndpointGroupRequest ¶ added in v0.9.0
func (c *Client) CreateEndpointGroupRequest(input *CreateEndpointGroupInput) CreateEndpointGroupRequest
CreateEndpointGroupRequest returns a request value for making 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.
// Example sending a request using CreateEndpointGroupRequest. req := client.CreateEndpointGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateEndpointGroup
func (*Client) CreateListenerRequest ¶ added in v0.9.0
func (c *Client) CreateListenerRequest(input *CreateListenerInput) CreateListenerRequest
CreateListenerRequest returns a request value for making 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.
// Example sending a request using CreateListenerRequest. req := client.CreateListenerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/CreateListener
func (*Client) DeleteAcceleratorRequest ¶ added in v0.9.0
func (c *Client) DeleteAcceleratorRequest(input *DeleteAcceleratorInput) DeleteAcceleratorRequest
DeleteAcceleratorRequest returns a request value for making 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).
// Example sending a request using DeleteAcceleratorRequest. req := client.DeleteAcceleratorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteAccelerator
func (*Client) DeleteEndpointGroupRequest ¶ added in v0.9.0
func (c *Client) DeleteEndpointGroupRequest(input *DeleteEndpointGroupInput) DeleteEndpointGroupRequest
DeleteEndpointGroupRequest returns a request value for making API operation for AWS Global Accelerator.
Delete an endpoint group from a listener.
// Example sending a request using DeleteEndpointGroupRequest. req := client.DeleteEndpointGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteEndpointGroup
func (*Client) DeleteListenerRequest ¶ added in v0.9.0
func (c *Client) DeleteListenerRequest(input *DeleteListenerInput) DeleteListenerRequest
DeleteListenerRequest returns a request value for making API operation for AWS Global Accelerator.
Delete a listener from an accelerator.
// Example sending a request using DeleteListenerRequest. req := client.DeleteListenerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DeleteListener
func (*Client) DescribeAcceleratorAttributesRequest ¶ added in v0.9.0
func (c *Client) DescribeAcceleratorAttributesRequest(input *DescribeAcceleratorAttributesInput) DescribeAcceleratorAttributesRequest
DescribeAcceleratorAttributesRequest returns a request value for making API operation for AWS Global Accelerator.
Describe the attributes of an accelerator.
// Example sending a request using DescribeAcceleratorAttributesRequest. req := client.DescribeAcceleratorAttributesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAcceleratorAttributes
func (*Client) DescribeAcceleratorRequest ¶ added in v0.9.0
func (c *Client) DescribeAcceleratorRequest(input *DescribeAcceleratorInput) DescribeAcceleratorRequest
DescribeAcceleratorRequest returns a request value for making API operation for AWS Global Accelerator.
Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.
// Example sending a request using DescribeAcceleratorRequest. req := client.DescribeAcceleratorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeAccelerator
func (*Client) DescribeEndpointGroupRequest ¶ added in v0.9.0
func (c *Client) DescribeEndpointGroupRequest(input *DescribeEndpointGroupInput) DescribeEndpointGroupRequest
DescribeEndpointGroupRequest returns a request value for making API operation for AWS Global Accelerator.
Describe an endpoint group.
// Example sending a request using DescribeEndpointGroupRequest. req := client.DescribeEndpointGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeEndpointGroup
func (*Client) DescribeListenerRequest ¶ added in v0.9.0
func (c *Client) DescribeListenerRequest(input *DescribeListenerInput) DescribeListenerRequest
DescribeListenerRequest returns a request value for making API operation for AWS Global Accelerator.
Describe a listener.
// Example sending a request using DescribeListenerRequest. req := client.DescribeListenerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/DescribeListener
func (*Client) ListAcceleratorsRequest ¶ added in v0.9.0
func (c *Client) ListAcceleratorsRequest(input *ListAcceleratorsInput) ListAcceleratorsRequest
ListAcceleratorsRequest returns a request value for making API operation for AWS Global Accelerator.
List the accelerators for an AWS account.
// Example sending a request using ListAcceleratorsRequest. req := client.ListAcceleratorsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListAccelerators
func (*Client) ListEndpointGroupsRequest ¶ added in v0.9.0
func (c *Client) ListEndpointGroupsRequest(input *ListEndpointGroupsInput) ListEndpointGroupsRequest
ListEndpointGroupsRequest returns a request value for making API operation for AWS Global Accelerator.
List the endpoint groups that are associated with a listener.
// Example sending a request using ListEndpointGroupsRequest. req := client.ListEndpointGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListEndpointGroups
func (*Client) ListListenersRequest ¶ added in v0.9.0
func (c *Client) ListListenersRequest(input *ListListenersInput) ListListenersRequest
ListListenersRequest returns a request value for making API operation for AWS Global Accelerator.
List the listeners for an accelerator.
// Example sending a request using ListListenersRequest. req := client.ListListenersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/ListListeners
func (*Client) UpdateAcceleratorAttributesRequest ¶ added in v0.9.0
func (c *Client) UpdateAcceleratorAttributesRequest(input *UpdateAcceleratorAttributesInput) UpdateAcceleratorAttributesRequest
UpdateAcceleratorAttributesRequest returns a request value for making 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.
// Example sending a request using UpdateAcceleratorAttributesRequest. req := client.UpdateAcceleratorAttributesRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAcceleratorAttributes
func (*Client) UpdateAcceleratorRequest ¶ added in v0.9.0
func (c *Client) UpdateAcceleratorRequest(input *UpdateAcceleratorInput) UpdateAcceleratorRequest
UpdateAcceleratorRequest returns a request value for making API operation for AWS Global Accelerator.
Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example.
You must specify the US-West-2 (Oregon) Region to create or update accelerators.
// Example sending a request using UpdateAcceleratorRequest. req := client.UpdateAcceleratorRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateAccelerator
func (*Client) UpdateEndpointGroupRequest ¶ added in v0.9.0
func (c *Client) UpdateEndpointGroupRequest(input *UpdateEndpointGroupInput) UpdateEndpointGroupRequest
UpdateEndpointGroupRequest returns a request value for making 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.
// Example sending a request using UpdateEndpointGroupRequest. req := client.UpdateEndpointGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateEndpointGroup
func (*Client) UpdateListenerRequest ¶ added in v0.9.0
func (c *Client) UpdateListenerRequest(input *UpdateListenerInput) UpdateListenerRequest
UpdateListenerRequest returns a request value for making API operation for AWS Global Accelerator.
Update a listener.
// Example sending a request using UpdateListenerRequest. req := client.UpdateListenerRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/globalaccelerator-2018-08-08/UpdateListener
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 IpAddressType `type:"string" enum:"true"` // 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) 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) String ¶
func (s CreateAcceleratorOutput) String() string
String returns the string representation
type CreateAcceleratorRequest ¶
type CreateAcceleratorRequest struct { *aws.Request Input *CreateAcceleratorInput Copy func(*CreateAcceleratorInput) CreateAcceleratorRequest }
CreateAcceleratorRequest is the request type for the CreateAccelerator API operation.
func (CreateAcceleratorRequest) Send ¶
func (r CreateAcceleratorRequest) Send(ctx context.Context) (*CreateAcceleratorResponse, error)
Send marshals and sends the CreateAccelerator API request.
type CreateAcceleratorResponse ¶ added in v0.9.0
type CreateAcceleratorResponse struct { *CreateAcceleratorOutput // contains filtered or unexported fields }
CreateAcceleratorResponse is the response type for the CreateAccelerator API operation.
func (*CreateAcceleratorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateAcceleratorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateAccelerator request.
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 HealthCheckProtocol `type:"string" enum:"true"` // 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) 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) String ¶
func (s CreateEndpointGroupOutput) String() string
String returns the string representation
type CreateEndpointGroupRequest ¶
type CreateEndpointGroupRequest struct { *aws.Request Input *CreateEndpointGroupInput Copy func(*CreateEndpointGroupInput) CreateEndpointGroupRequest }
CreateEndpointGroupRequest is the request type for the CreateEndpointGroup API operation.
func (CreateEndpointGroupRequest) Send ¶
func (r CreateEndpointGroupRequest) Send(ctx context.Context) (*CreateEndpointGroupResponse, error)
Send marshals and sends the CreateEndpointGroup API request.
type CreateEndpointGroupResponse ¶ added in v0.9.0
type CreateEndpointGroupResponse struct { *CreateEndpointGroupOutput // contains filtered or unexported fields }
CreateEndpointGroupResponse is the response type for the CreateEndpointGroup API operation.
func (*CreateEndpointGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateEndpointGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateEndpointGroup request.
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 Affinity `type:"string" enum:"true"` // 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 Protocol `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
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) String ¶
func (s CreateListenerOutput) String() string
String returns the string representation
type CreateListenerRequest ¶
type CreateListenerRequest struct { *aws.Request Input *CreateListenerInput Copy func(*CreateListenerInput) CreateListenerRequest }
CreateListenerRequest is the request type for the CreateListener API operation.
func (CreateListenerRequest) Send ¶
func (r CreateListenerRequest) Send(ctx context.Context) (*CreateListenerResponse, error)
Send marshals and sends the CreateListener API request.
type CreateListenerResponse ¶ added in v0.9.0
type CreateListenerResponse struct { *CreateListenerOutput // contains filtered or unexported fields }
CreateListenerResponse is the response type for the CreateListener API operation.
func (*CreateListenerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *CreateListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the CreateListener request.
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) 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) String ¶
func (s DeleteAcceleratorOutput) String() string
String returns the string representation
type DeleteAcceleratorRequest ¶
type DeleteAcceleratorRequest struct { *aws.Request Input *DeleteAcceleratorInput Copy func(*DeleteAcceleratorInput) DeleteAcceleratorRequest }
DeleteAcceleratorRequest is the request type for the DeleteAccelerator API operation.
func (DeleteAcceleratorRequest) Send ¶
func (r DeleteAcceleratorRequest) Send(ctx context.Context) (*DeleteAcceleratorResponse, error)
Send marshals and sends the DeleteAccelerator API request.
type DeleteAcceleratorResponse ¶ added in v0.9.0
type DeleteAcceleratorResponse struct { *DeleteAcceleratorOutput // contains filtered or unexported fields }
DeleteAcceleratorResponse is the response type for the DeleteAccelerator API operation.
func (*DeleteAcceleratorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteAcceleratorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteAccelerator request.
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) 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) String ¶
func (s DeleteEndpointGroupOutput) String() string
String returns the string representation
type DeleteEndpointGroupRequest ¶
type DeleteEndpointGroupRequest struct { *aws.Request Input *DeleteEndpointGroupInput Copy func(*DeleteEndpointGroupInput) DeleteEndpointGroupRequest }
DeleteEndpointGroupRequest is the request type for the DeleteEndpointGroup API operation.
func (DeleteEndpointGroupRequest) Send ¶
func (r DeleteEndpointGroupRequest) Send(ctx context.Context) (*DeleteEndpointGroupResponse, error)
Send marshals and sends the DeleteEndpointGroup API request.
type DeleteEndpointGroupResponse ¶ added in v0.9.0
type DeleteEndpointGroupResponse struct { *DeleteEndpointGroupOutput // contains filtered or unexported fields }
DeleteEndpointGroupResponse is the response type for the DeleteEndpointGroup API operation.
func (*DeleteEndpointGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteEndpointGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteEndpointGroup request.
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) 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) String ¶
func (s DeleteListenerOutput) String() string
String returns the string representation
type DeleteListenerRequest ¶
type DeleteListenerRequest struct { *aws.Request Input *DeleteListenerInput Copy func(*DeleteListenerInput) DeleteListenerRequest }
DeleteListenerRequest is the request type for the DeleteListener API operation.
func (DeleteListenerRequest) Send ¶
func (r DeleteListenerRequest) Send(ctx context.Context) (*DeleteListenerResponse, error)
Send marshals and sends the DeleteListener API request.
type DeleteListenerResponse ¶ added in v0.9.0
type DeleteListenerResponse struct { *DeleteListenerOutput // contains filtered or unexported fields }
DeleteListenerResponse is the response type for the DeleteListener API operation.
func (*DeleteListenerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DeleteListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteListener request.
type DescribeAcceleratorAttributesInput ¶
type DescribeAcceleratorAttributesInput struct { // The Amazon Resource Name (ARN) of the accelerator with the attributes that // you want to describe. // // AcceleratorArn is a required field AcceleratorArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeAcceleratorAttributesInput) String ¶
func (s DescribeAcceleratorAttributesInput) String() string
String returns the string representation
func (*DescribeAcceleratorAttributesInput) Validate ¶ added in v0.12.0
func (s *DescribeAcceleratorAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAcceleratorAttributesOutput ¶
type DescribeAcceleratorAttributesOutput struct { // The attributes of the accelerator. AcceleratorAttributes *AcceleratorAttributes `type:"structure"` // contains filtered or unexported fields }
func (DescribeAcceleratorAttributesOutput) String ¶
func (s DescribeAcceleratorAttributesOutput) String() string
String returns the string representation
type DescribeAcceleratorAttributesRequest ¶
type DescribeAcceleratorAttributesRequest struct { *aws.Request Input *DescribeAcceleratorAttributesInput Copy func(*DescribeAcceleratorAttributesInput) DescribeAcceleratorAttributesRequest }
DescribeAcceleratorAttributesRequest is the request type for the DescribeAcceleratorAttributes API operation.
func (DescribeAcceleratorAttributesRequest) Send ¶
func (r DescribeAcceleratorAttributesRequest) Send(ctx context.Context) (*DescribeAcceleratorAttributesResponse, error)
Send marshals and sends the DescribeAcceleratorAttributes API request.
type DescribeAcceleratorAttributesResponse ¶ added in v0.9.0
type DescribeAcceleratorAttributesResponse struct { *DescribeAcceleratorAttributesOutput // contains filtered or unexported fields }
DescribeAcceleratorAttributesResponse is the response type for the DescribeAcceleratorAttributes API operation.
func (*DescribeAcceleratorAttributesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeAcceleratorAttributesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeAcceleratorAttributes request.
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) 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) String ¶
func (s DescribeAcceleratorOutput) String() string
String returns the string representation
type DescribeAcceleratorRequest ¶
type DescribeAcceleratorRequest struct { *aws.Request Input *DescribeAcceleratorInput Copy func(*DescribeAcceleratorInput) DescribeAcceleratorRequest }
DescribeAcceleratorRequest is the request type for the DescribeAccelerator API operation.
func (DescribeAcceleratorRequest) Send ¶
func (r DescribeAcceleratorRequest) Send(ctx context.Context) (*DescribeAcceleratorResponse, error)
Send marshals and sends the DescribeAccelerator API request.
type DescribeAcceleratorResponse ¶ added in v0.9.0
type DescribeAcceleratorResponse struct { *DescribeAcceleratorOutput // contains filtered or unexported fields }
DescribeAcceleratorResponse is the response type for the DescribeAccelerator API operation.
func (*DescribeAcceleratorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeAcceleratorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeAccelerator request.
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) String ¶
func (s DescribeEndpointGroupInput) String() 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) String ¶
func (s DescribeEndpointGroupOutput) String() string
String returns the string representation
type DescribeEndpointGroupRequest ¶
type DescribeEndpointGroupRequest struct { *aws.Request Input *DescribeEndpointGroupInput Copy func(*DescribeEndpointGroupInput) DescribeEndpointGroupRequest }
DescribeEndpointGroupRequest is the request type for the DescribeEndpointGroup API operation.
func (DescribeEndpointGroupRequest) Send ¶
func (r DescribeEndpointGroupRequest) Send(ctx context.Context) (*DescribeEndpointGroupResponse, error)
Send marshals and sends the DescribeEndpointGroup API request.
type DescribeEndpointGroupResponse ¶ added in v0.9.0
type DescribeEndpointGroupResponse struct { *DescribeEndpointGroupOutput // contains filtered or unexported fields }
DescribeEndpointGroupResponse is the response type for the DescribeEndpointGroup API operation.
func (*DescribeEndpointGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeEndpointGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeEndpointGroup request.
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) 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) String ¶
func (s DescribeListenerOutput) String() string
String returns the string representation
type DescribeListenerRequest ¶
type DescribeListenerRequest struct { *aws.Request Input *DescribeListenerInput Copy func(*DescribeListenerInput) DescribeListenerRequest }
DescribeListenerRequest is the request type for the DescribeListener API operation.
func (DescribeListenerRequest) Send ¶
func (r DescribeListenerRequest) Send(ctx context.Context) (*DescribeListenerResponse, error)
Send marshals and sends the DescribeListener API request.
type DescribeListenerResponse ¶ added in v0.9.0
type DescribeListenerResponse struct { *DescribeListenerOutput // contains filtered or unexported fields }
DescribeListenerResponse is the response type for the DescribeListener API operation.
func (*DescribeListenerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *DescribeListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DescribeListener request.
type EndpointConfiguration ¶
type EndpointConfiguration struct { // Indicates whether client IP address preservation is enabled for an Application // Load Balancer endpoint. The value is true or false. The default value is // true for new accelerators. // // If the value is set to true, the client's IP address is preserved in the // X-Forwarded-For request header as traffic travels to applications on the // Application Load Balancer endpoint fronted by the accelerator. // // For more information, see Viewing Client IP Addresses in AWS Global Accelerator // (https://docs.aws.amazon.com/global-accelerator/latest/dg/introduction-how-it-works-client-ip.html) // in the AWS Global Accelerator Developer Guide. ClientIPPreservationEnabled *bool `type:"boolean"` // 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) String ¶
func (s EndpointConfiguration) String() string
String returns the string representation
type EndpointDescription ¶
type EndpointDescription struct { // Indicates whether client IP address preservation is enabled for an Application // Load Balancer endpoint. The value is true or false. The default value is // true for new accelerators. // // If the value is set to true, the client's IP address is preserved in the // X-Forwarded-For request header as traffic travels to applications on the // Application Load Balancer endpoint fronted by the accelerator. // // For more information, see Viewing Client IP Addresses in AWS Global Accelerator // (https://docs.aws.amazon.com/global-accelerator/latest/dg/introduction-how-it-works-client-ip.html) // in the AWS Global Accelerator Developer Guide. ClientIPPreservationEnabled *bool `type:"boolean"` // 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. An Application Load Balancer can be either internal or internet-facing. 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 HealthState `type:"string" enum:"true"` // 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) 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 HealthCheckProtocol `type:"string" enum:"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 }
A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.
func (EndpointGroup) String ¶
func (s EndpointGroup) String() string
String returns the string representation
type HealthCheckProtocol ¶
type HealthCheckProtocol string
const ( HealthCheckProtocolTcp HealthCheckProtocol = "TCP" HealthCheckProtocolHttp HealthCheckProtocol = "HTTP" HealthCheckProtocolHttps HealthCheckProtocol = "HTTPS" )
Enum values for HealthCheckProtocol
func (HealthCheckProtocol) MarshalValue ¶
func (enum HealthCheckProtocol) MarshalValue() (string, error)
func (HealthCheckProtocol) MarshalValueBuf ¶
func (enum HealthCheckProtocol) MarshalValueBuf(b []byte) ([]byte, error)
type HealthState ¶
type HealthState string
const ( HealthStateInitial HealthState = "INITIAL" HealthStateHealthy HealthState = "HEALTHY" HealthStateUnhealthy HealthState = "UNHEALTHY" )
Enum values for HealthState
func (HealthState) MarshalValue ¶
func (enum HealthState) MarshalValue() (string, error)
func (HealthState) MarshalValueBuf ¶
func (enum HealthState) MarshalValueBuf(b []byte) ([]byte, error)
type IpAddressType ¶
type IpAddressType string
const (
IpAddressTypeIpv4 IpAddressType = "IPV4"
)
Enum values for IpAddressType
func (IpAddressType) MarshalValue ¶
func (enum IpAddressType) MarshalValue() (string, error)
func (IpAddressType) MarshalValueBuf ¶
func (enum IpAddressType) MarshalValueBuf(b []byte) ([]byte, error)
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.
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) 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) String ¶
func (s ListAcceleratorsOutput) String() string
String returns the string representation
type ListAcceleratorsRequest ¶
type ListAcceleratorsRequest struct { *aws.Request Input *ListAcceleratorsInput Copy func(*ListAcceleratorsInput) ListAcceleratorsRequest }
ListAcceleratorsRequest is the request type for the ListAccelerators API operation.
func (ListAcceleratorsRequest) Send ¶
func (r ListAcceleratorsRequest) Send(ctx context.Context) (*ListAcceleratorsResponse, error)
Send marshals and sends the ListAccelerators API request.
type ListAcceleratorsResponse ¶ added in v0.9.0
type ListAcceleratorsResponse struct { *ListAcceleratorsOutput // contains filtered or unexported fields }
ListAcceleratorsResponse is the response type for the ListAccelerators API operation.
func (*ListAcceleratorsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListAcceleratorsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListAccelerators request.
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) 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) String ¶
func (s ListEndpointGroupsOutput) String() string
String returns the string representation
type ListEndpointGroupsRequest ¶
type ListEndpointGroupsRequest struct { *aws.Request Input *ListEndpointGroupsInput Copy func(*ListEndpointGroupsInput) ListEndpointGroupsRequest }
ListEndpointGroupsRequest is the request type for the ListEndpointGroups API operation.
func (ListEndpointGroupsRequest) Send ¶
func (r ListEndpointGroupsRequest) Send(ctx context.Context) (*ListEndpointGroupsResponse, error)
Send marshals and sends the ListEndpointGroups API request.
type ListEndpointGroupsResponse ¶ added in v0.9.0
type ListEndpointGroupsResponse struct { *ListEndpointGroupsOutput // contains filtered or unexported fields }
ListEndpointGroupsResponse is the response type for the ListEndpointGroups API operation.
func (*ListEndpointGroupsResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListEndpointGroupsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListEndpointGroups request.
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) 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) String ¶
func (s ListListenersOutput) String() string
String returns the string representation
type ListListenersRequest ¶
type ListListenersRequest struct { *aws.Request Input *ListListenersInput Copy func(*ListListenersInput) ListListenersRequest }
ListListenersRequest is the request type for the ListListeners API operation.
func (ListListenersRequest) Send ¶
func (r ListListenersRequest) Send(ctx context.Context) (*ListListenersResponse, error)
Send marshals and sends the ListListeners API request.
type ListListenersResponse ¶ added in v0.9.0
type ListListenersResponse struct { *ListListenersOutput // contains filtered or unexported fields }
ListListenersResponse is the response type for the ListListeners API operation.
func (*ListListenersResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *ListListenersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListListeners request.
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 Affinity `type:"string" enum:"true"` // 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 Protocol `type:"string" enum:"true"` // contains filtered or unexported fields }
A complex type for a listener.
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.
type UpdateAcceleratorAttributesInput ¶
type UpdateAcceleratorAttributesInput struct { // The Amazon Resource Name (ARN) of the accelerator that you want to update. // // AcceleratorArn is a required field AcceleratorArn *string `type:"string" required:"true"` // 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) String ¶
func (s UpdateAcceleratorAttributesInput) String() string
String returns the string representation
func (*UpdateAcceleratorAttributesInput) Validate ¶ added in v0.12.0
func (s *UpdateAcceleratorAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAcceleratorAttributesOutput ¶
type UpdateAcceleratorAttributesOutput struct { // Updated attributes for the accelerator. AcceleratorAttributes *AcceleratorAttributes `type:"structure"` // contains filtered or unexported fields }
func (UpdateAcceleratorAttributesOutput) String ¶
func (s UpdateAcceleratorAttributesOutput) String() string
String returns the string representation
type UpdateAcceleratorAttributesRequest ¶
type UpdateAcceleratorAttributesRequest struct { *aws.Request Input *UpdateAcceleratorAttributesInput Copy func(*UpdateAcceleratorAttributesInput) UpdateAcceleratorAttributesRequest }
UpdateAcceleratorAttributesRequest is the request type for the UpdateAcceleratorAttributes API operation.
func (UpdateAcceleratorAttributesRequest) Send ¶
func (r UpdateAcceleratorAttributesRequest) Send(ctx context.Context) (*UpdateAcceleratorAttributesResponse, error)
Send marshals and sends the UpdateAcceleratorAttributes API request.
type UpdateAcceleratorAttributesResponse ¶ added in v0.9.0
type UpdateAcceleratorAttributesResponse struct { *UpdateAcceleratorAttributesOutput // contains filtered or unexported fields }
UpdateAcceleratorAttributesResponse is the response type for the UpdateAcceleratorAttributes API operation.
func (*UpdateAcceleratorAttributesResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateAcceleratorAttributesResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateAcceleratorAttributes request.
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 IpAddressType `type:"string" enum:"true"` // 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) 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) String ¶
func (s UpdateAcceleratorOutput) String() string
String returns the string representation
type UpdateAcceleratorRequest ¶
type UpdateAcceleratorRequest struct { *aws.Request Input *UpdateAcceleratorInput Copy func(*UpdateAcceleratorInput) UpdateAcceleratorRequest }
UpdateAcceleratorRequest is the request type for the UpdateAccelerator API operation.
func (UpdateAcceleratorRequest) Send ¶
func (r UpdateAcceleratorRequest) Send(ctx context.Context) (*UpdateAcceleratorResponse, error)
Send marshals and sends the UpdateAccelerator API request.
type UpdateAcceleratorResponse ¶ added in v0.9.0
type UpdateAcceleratorResponse struct { *UpdateAcceleratorOutput // contains filtered or unexported fields }
UpdateAcceleratorResponse is the response type for the UpdateAccelerator API operation.
func (*UpdateAcceleratorResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateAcceleratorResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateAccelerator request.
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 HealthCheckProtocol `type:"string" enum:"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 (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) String ¶
func (s UpdateEndpointGroupOutput) String() string
String returns the string representation
type UpdateEndpointGroupRequest ¶
type UpdateEndpointGroupRequest struct { *aws.Request Input *UpdateEndpointGroupInput Copy func(*UpdateEndpointGroupInput) UpdateEndpointGroupRequest }
UpdateEndpointGroupRequest is the request type for the UpdateEndpointGroup API operation.
func (UpdateEndpointGroupRequest) Send ¶
func (r UpdateEndpointGroupRequest) Send(ctx context.Context) (*UpdateEndpointGroupResponse, error)
Send marshals and sends the UpdateEndpointGroup API request.
type UpdateEndpointGroupResponse ¶ added in v0.9.0
type UpdateEndpointGroupResponse struct { *UpdateEndpointGroupOutput // contains filtered or unexported fields }
UpdateEndpointGroupResponse is the response type for the UpdateEndpointGroup API operation.
func (*UpdateEndpointGroupResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateEndpointGroupResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateEndpointGroup request.
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 Affinity `type:"string" enum:"true"` // 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 Protocol `type:"string" enum:"true"` // contains filtered or unexported fields }
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) String ¶
func (s UpdateListenerOutput) String() string
String returns the string representation
type UpdateListenerRequest ¶
type UpdateListenerRequest struct { *aws.Request Input *UpdateListenerInput Copy func(*UpdateListenerInput) UpdateListenerRequest }
UpdateListenerRequest is the request type for the UpdateListener API operation.
func (UpdateListenerRequest) Send ¶
func (r UpdateListenerRequest) Send(ctx context.Context) (*UpdateListenerResponse, error)
Send marshals and sends the UpdateListener API request.
type UpdateListenerResponse ¶ added in v0.9.0
type UpdateListenerResponse struct { *UpdateListenerOutput // contains filtered or unexported fields }
UpdateListenerResponse is the response type for the UpdateListener API operation.
func (*UpdateListenerResponse) SDKResponseMetdata ¶ added in v0.9.0
func (r *UpdateListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateListener request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_CreateAccelerator.go
- api_op_CreateEndpointGroup.go
- api_op_CreateListener.go
- api_op_DeleteAccelerator.go
- api_op_DeleteEndpointGroup.go
- api_op_DeleteListener.go
- api_op_DescribeAccelerator.go
- api_op_DescribeAcceleratorAttributes.go
- api_op_DescribeEndpointGroup.go
- api_op_DescribeListener.go
- api_op_ListAccelerators.go
- api_op_ListEndpointGroups.go
- api_op_ListListeners.go
- api_op_UpdateAccelerator.go
- api_op_UpdateAcceleratorAttributes.go
- api_op_UpdateEndpointGroup.go
- api_op_UpdateListener.go
- api_types.go
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. |