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 service in which you create accelerators to improve availability and performance of your applications for local and global users.
You must specify the US West (Oregon) Region to create or update accelerators.
By default, Global Accelerator provides you with static IP addresses that you associate with your accelerator. (Instead of using the IP addresses that Global Accelerator provides, you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator.) The static IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Network Load Balancers, Application Load Balancers, EC2 instances, or Elastic IP addresses 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 ¶
By default, AWS Global Accelerator provides you with a set of static IP addresses that are anycast from the AWS edge network and serve as the single fixed entry points for your clients. Or you can configure these entry points to be IPv4 addresses from your own IP address ranges that you bring to Global Accelerator (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide. If you already have load balancers, EC2 instances, or Elastic IP addresses set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by the static IP addresses.
The static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Authentication and Access Control (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) in the AWS Global Accelerator Developer Guide.
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.
DNS name ¶
Global Accelerator assigns each accelerator a default Domain Name System (DNS) name, similar to a1234567890abcdef.awsglobalaccelerator.com, that points to your Global Accelerator static IP addresses. Depending on the use case, you can use your accelerator's static IP addresses or DNS name to route traffic to your accelerator, or set up DNS records to route traffic using your own custom domain name.
Network zone ¶
A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, by default, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.
Listener ¶
A listener processes inbound connections from clients to Global Accelerator, based on the 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 a Network Load Balancer, Application Load Balancer, EC2 instance, or Elastic IP address. 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 AdvertiseByoipCidrInput
- type AdvertiseByoipCidrOutput
- type AdvertiseByoipCidrRequest
- type AdvertiseByoipCidrResponse
- type Affinity
- type ByoipCidr
- type ByoipCidrEvent
- type ByoipCidrState
- type CidrAuthorizationContext
- type Client
- func (c *Client) AdvertiseByoipCidrRequest(input *AdvertiseByoipCidrInput) AdvertiseByoipCidrRequest
- 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) DeprovisionByoipCidrRequest(input *DeprovisionByoipCidrInput) DeprovisionByoipCidrRequest
- 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) ListByoipCidrsRequest(input *ListByoipCidrsInput) ListByoipCidrsRequest
- func (c *Client) ListEndpointGroupsRequest(input *ListEndpointGroupsInput) ListEndpointGroupsRequest
- func (c *Client) ListListenersRequest(input *ListListenersInput) ListListenersRequest
- func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
- func (c *Client) ProvisionByoipCidrRequest(input *ProvisionByoipCidrInput) ProvisionByoipCidrRequest
- func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
- func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
- 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
- func (c *Client) WithdrawByoipCidrRequest(input *WithdrawByoipCidrInput) WithdrawByoipCidrRequest
- 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 DeprovisionByoipCidrInput
- type DeprovisionByoipCidrOutput
- type DeprovisionByoipCidrRequest
- type DeprovisionByoipCidrResponse
- 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 ListByoipCidrsInput
- type ListByoipCidrsOutput
- type ListByoipCidrsRequest
- type ListByoipCidrsResponse
- type ListEndpointGroupsInput
- type ListEndpointGroupsOutput
- type ListEndpointGroupsRequest
- type ListEndpointGroupsResponse
- type ListListenersInput
- type ListListenersOutput
- type ListListenersRequest
- type ListListenersResponse
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourceRequest
- type ListTagsForResourceResponse
- type Listener
- type PortRange
- type Protocol
- type ProvisionByoipCidrInput
- type ProvisionByoipCidrOutput
- type ProvisionByoipCidrRequest
- type ProvisionByoipCidrResponse
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type TagResourceRequest
- type TagResourceResponse
- type UntagResourceInput
- type UntagResourceOutput
- type UntagResourceRequest
- type UntagResourceResponse
- 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
- type WithdrawByoipCidrInput
- type WithdrawByoipCidrOutput
- type WithdrawByoipCidrRequest
- type WithdrawByoipCidrResponse
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" // ErrCodeByoipCidrNotFoundException for service response error code // "ByoipCidrNotFoundException". // // The CIDR that you specified was not found or is incorrect. ErrCodeByoipCidrNotFoundException = "ByoipCidrNotFoundException" // 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" // ErrCodeIncorrectCidrStateException for service response error code // "IncorrectCidrStateException". // // The CIDR that you specified is not valid for this action. For example, the // state of the CIDR might be incorrect for this action. ErrCodeIncorrectCidrStateException = "IncorrectCidrStateException" // 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 the following: A lowercase 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. If you specify slash (/) for the S3 bucket prefix, the log file // bucket folder structure will include a double slash (//), like the following: // // s3-bucket_name//AWSLogs/aws_account_id FlowLogsS3Prefix *string `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 AdvertiseByoipCidrInput ¶
type AdvertiseByoipCidrInput struct { // The address range, in CIDR notation. This must be the exact range that you // provisioned. You can't advertise only a portion of the provisioned range. // // Cidr is a required field Cidr *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AdvertiseByoipCidrInput) String ¶
func (s AdvertiseByoipCidrInput) String() string
String returns the string representation
func (*AdvertiseByoipCidrInput) Validate ¶
func (s *AdvertiseByoipCidrInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AdvertiseByoipCidrOutput ¶
type AdvertiseByoipCidrOutput struct { // Information about the address range. ByoipCidr *ByoipCidr `type:"structure"` // contains filtered or unexported fields }
func (AdvertiseByoipCidrOutput) String ¶
func (s AdvertiseByoipCidrOutput) String() string
String returns the string representation
type AdvertiseByoipCidrRequest ¶
type AdvertiseByoipCidrRequest struct { *aws.Request Input *AdvertiseByoipCidrInput Copy func(*AdvertiseByoipCidrInput) AdvertiseByoipCidrRequest }
AdvertiseByoipCidrRequest is the request type for the AdvertiseByoipCidr API operation.
func (AdvertiseByoipCidrRequest) Send ¶
func (r AdvertiseByoipCidrRequest) Send(ctx context.Context) (*AdvertiseByoipCidrResponse, error)
Send marshals and sends the AdvertiseByoipCidr API request.
type AdvertiseByoipCidrResponse ¶
type AdvertiseByoipCidrResponse struct { *AdvertiseByoipCidrOutput // contains filtered or unexported fields }
AdvertiseByoipCidrResponse is the response type for the AdvertiseByoipCidr API operation.
func (*AdvertiseByoipCidrResponse) SDKResponseMetdata ¶
func (r *AdvertiseByoipCidrResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the AdvertiseByoipCidr request.
type ByoipCidr ¶
type ByoipCidr struct { // The address range, in CIDR notation. Cidr *string `type:"string"` // A history of status changes for an IP address range that that you bring to // AWS Global Accelerator through bring your own IP address (BYOIP). Events []ByoipCidrEvent `type:"list"` // The state of the address pool. State ByoipCidrState `type:"string" enum:"true"` // contains filtered or unexported fields }
Information about an IP address range that is provisioned for use with your AWS resources through bring your own IP address (BYOIP).
The following describes each BYOIP State that your IP address range can be in.
PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with AWS Global Accelerator.
READY — The address range is provisioned with AWS Global Accelerator and can be advertised.
PENDING_ADVERTISING — You’ve submitted a request for AWS Global Accelerator to advertise an address range but it is not yet being advertised.
ADVERTISING — The address range is being advertised by AWS Global Accelerator.
PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by AWS Global Accelerator.
PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from AWS Global Accelerator but it is still provisioned.
DEPROVISIONED — The address range is deprovisioned from AWS Global Accelerator.
FAILED_PROVISION — The request to provision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_ADVERTISING — The request for AWS Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_WITHDRAW — The request to withdraw the address range from advertising by AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
FAILED_DEPROVISION — The request to deprovision the address range from AWS Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact AWS support.
type ByoipCidrEvent ¶
type ByoipCidrEvent struct { // A string that contains an Event message describing changes that you make // in the status of an IP address range that you bring to AWS Global Accelerator // through bring your own IP address (BYOIP). Message *string `type:"string"` // A timestamp when you make a status change for an IP address range that you // bring to AWS Global Accelerator through bring your own IP address (BYOIP). Timestamp *time.Time `type:"timestamp"` // contains filtered or unexported fields }
A complex type that contains a Message and a Timestamp value for changes that you make in the status an IP address range that you bring to AWS Global Accelerator through bring your own IP address (BYOIP).
func (ByoipCidrEvent) String ¶
func (s ByoipCidrEvent) String() string
String returns the string representation
type ByoipCidrState ¶
type ByoipCidrState string
const ( ByoipCidrStatePendingProvisioning ByoipCidrState = "PENDING_PROVISIONING" ByoipCidrStateReady ByoipCidrState = "READY" ByoipCidrStatePendingAdvertising ByoipCidrState = "PENDING_ADVERTISING" ByoipCidrStateAdvertising ByoipCidrState = "ADVERTISING" ByoipCidrStatePendingWithdrawing ByoipCidrState = "PENDING_WITHDRAWING" ByoipCidrStatePendingDeprovisioning ByoipCidrState = "PENDING_DEPROVISIONING" ByoipCidrStateDeprovisioned ByoipCidrState = "DEPROVISIONED" ByoipCidrStateFailedProvision ByoipCidrState = "FAILED_PROVISION" ByoipCidrStateFailedAdvertising ByoipCidrState = "FAILED_ADVERTISING" ByoipCidrStateFailedWithdraw ByoipCidrState = "FAILED_WITHDRAW" ByoipCidrStateFailedDeprovision ByoipCidrState = "FAILED_DEPROVISION" )
Enum values for ByoipCidrState
func (ByoipCidrState) MarshalValue ¶
func (enum ByoipCidrState) MarshalValue() (string, error)
func (ByoipCidrState) MarshalValueBuf ¶
func (enum ByoipCidrState) MarshalValueBuf(b []byte) ([]byte, error)
type CidrAuthorizationContext ¶
type CidrAuthorizationContext struct { // The plain-text authorization message for the prefix and account. // // Message is a required field Message *string `type:"string" required:"true"` // The signed authorization message for the prefix and account. // // Signature is a required field Signature *string `type:"string" required:"true"` // contains filtered or unexported fields }
Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP).
For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide.
func (CidrAuthorizationContext) String ¶
func (s CidrAuthorizationContext) String() string
String returns the string representation
func (*CidrAuthorizationContext) Validate ¶
func (s *CidrAuthorizationContext) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Client ¶
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) AdvertiseByoipCidrRequest ¶
func (c *Client) AdvertiseByoipCidrRequest(input *AdvertiseByoipCidrInput) AdvertiseByoipCidrRequest
AdvertiseByoipCidrRequest returns a request value for making API operation for AWS Global Accelerator.
Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). It can take a few minutes before traffic to the specified addresses starts routing to AWS because of propagation delays. To see an AWS CLI example of advertising an address range, scroll down to Example.
To stop advertising the BYOIP address range, use WithdrawByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html).
For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using AdvertiseByoipCidrRequest. req := client.AdvertiseByoipCidrRequest(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/AdvertiseByoipCidr
func (*Client) CreateAcceleratorRequest ¶
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.
If you bring your own IP address ranges to AWS Global Accelerator (BYOIP), you can assign IP addresses from your own pool to your accelerator as the static IP address entry points. Only one IP address from each of your IP address ranges can be used for each accelerator.
You must specify the US West (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 ¶
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 ¶
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 ¶
func (c *Client) DeleteAcceleratorRequest(input *DeleteAcceleratorInput) DeleteAcceleratorRequest
DeleteAcceleratorRequest returns a request value for making API operation for AWS Global Accelerator.
Delete an accelerator. Before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups). To disable the accelerator, update the accelerator to set Enabled to false.
When you create an accelerator, by default, Global Accelerator provides you with a set of two static IP addresses. Alternatively, you can bring your own IP address ranges to Global Accelerator and assign IP addresses from those ranges.
The IP addresses are assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete an accelerator, you lose the static IP addresses that are assigned to the accelerator, so you can no longer route traffic by using them. As a best practice, ensure that you have permissions in place to avoid inadvertently deleting accelerators. You can use IAM policies with Global Accelerator to limit the users who have permissions to delete an accelerator. For more information, see Authentication and Access Control (https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html) in the AWS Global Accelerator Developer Guide.
// 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 ¶
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 ¶
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) DeprovisionByoipCidrRequest ¶
func (c *Client) DeprovisionByoipCidrRequest(input *DeprovisionByoipCidrInput) DeprovisionByoipCidrRequest
DeprovisionByoipCidrRequest returns a request value for making API operation for AWS Global Accelerator.
Releases the specified address range that you provisioned to use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. To see an AWS CLI example of deprovisioning an address range, scroll down to Example.
Before you can release an address range, you must stop advertising it by using WithdrawByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/WithdrawByoipCidr.html) and you must not have any accelerators that are using static IP addresses allocated from its address range.
For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using DeprovisionByoipCidrRequest. req := client.DeprovisionByoipCidrRequest(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/DeprovisionByoipCidr
func (*Client) DescribeAcceleratorAttributesRequest ¶
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. To see an AWS CLI example of describing the attributes of an accelerator, scroll down to Example.
// 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 ¶
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 ¶
func (c *Client) DescribeEndpointGroupRequest(input *DescribeEndpointGroupInput) DescribeEndpointGroupRequest
DescribeEndpointGroupRequest returns a request value for making API operation for AWS Global Accelerator.
Describe an endpoint group. To see an AWS CLI example of describing an endpoint group, scroll down to Example.
// 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 ¶
func (c *Client) DescribeListenerRequest(input *DescribeListenerInput) DescribeListenerRequest
DescribeListenerRequest returns a request value for making API operation for AWS Global Accelerator.
Describe a listener. To see an AWS CLI example of describing a listener, scroll down to Example.
// 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 ¶
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. To see an AWS CLI example of listing the accelerators for an AWS account, scroll down to Example.
// 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) ListByoipCidrsRequest ¶
func (c *Client) ListByoipCidrsRequest(input *ListByoipCidrsInput) ListByoipCidrsRequest
ListByoipCidrsRequest returns a request value for making API operation for AWS Global Accelerator.
Lists the IP address ranges that were specified in calls to ProvisionByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/ProvisionByoipCidr.html), including the current state and a history of state changes.
To see an AWS CLI example of listing BYOIP CIDR addresses, scroll down to Example.
// Example sending a request using ListByoipCidrsRequest. req := client.ListByoipCidrsRequest(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/ListByoipCidrs
func (*Client) ListEndpointGroupsRequest ¶
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. To see an AWS CLI example of listing the endpoint groups for listener, scroll down to Example.
// 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 ¶
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. To see an AWS CLI example of listing the listeners for an accelerator, scroll down to Example.
// 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) ListTagsForResourceRequest ¶
func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest
ListTagsForResourceRequest returns a request value for making API operation for AWS Global Accelerator.
List all tags for an accelerator. To see an AWS CLI example of listing tags for an accelerator, scroll down to Example.
For more information, see Tagging in AWS Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using ListTagsForResourceRequest. req := client.ListTagsForResourceRequest(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/ListTagsForResource
func (*Client) ProvisionByoipCidrRequest ¶
func (c *Client) ProvisionByoipCidrRequest(input *ProvisionByoipCidrInput) ProvisionByoipCidrRequest
ProvisionByoipCidrRequest returns a request value for making API operation for AWS Global Accelerator.
Provisions an IP address range to use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr (https://docs.aws.amazon.com/global-accelerator/latest/api/AdvertiseByoipCidr.html).
To see an AWS CLI example of provisioning an address range for BYOIP, scroll down to Example.
For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using ProvisionByoipCidrRequest. req := client.ProvisionByoipCidrRequest(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/ProvisionByoipCidr
func (*Client) TagResourceRequest ¶
func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest
TagResourceRequest returns a request value for making API operation for AWS Global Accelerator.
Add tags to an accelerator resource. To see an AWS CLI example of adding tags to an accelerator, scroll down to Example.
For more information, see Tagging in AWS Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using TagResourceRequest. req := client.TagResourceRequest(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/TagResource
func (*Client) UntagResourceRequest ¶
func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest
UntagResourceRequest returns a request value for making API operation for AWS Global Accelerator.
Remove tags from a Global Accelerator resource. When you specify a tag key, the action removes both that key and its associated value. To see an AWS CLI example of removing tags from an accelerator, scroll down to Example. The operation succeeds even if you attempt to remove tags from an accelerator that was already removed.
For more information, see Tagging in AWS Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using UntagResourceRequest. req := client.UntagResourceRequest(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/UntagResource
func (*Client) UpdateAcceleratorAttributesRequest ¶
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 ¶
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 (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 ¶
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 ¶
func (c *Client) UpdateListenerRequest(input *UpdateListenerInput) UpdateListenerRequest
UpdateListenerRequest returns a request value for making API operation for AWS Global Accelerator.
Update a listener. To see an AWS CLI example of updating listener, scroll down to Example.
// 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
func (*Client) WithdrawByoipCidrRequest ¶
func (c *Client) WithdrawByoipCidrRequest(input *WithdrawByoipCidrInput) WithdrawByoipCidrRequest
WithdrawByoipCidrRequest returns a request value for making API operation for AWS Global Accelerator.
Stops advertising an address range that is provisioned as an address pool. You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time. To see an AWS CLI example of withdrawing an address range for BYOIP so it will no longer be advertised by AWS, scroll down to Example.
It can take a few minutes before traffic to the specified addresses stops routing to AWS because of propagation delays.
For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) in the AWS Global Accelerator Developer Guide.
// Example sending a request using WithdrawByoipCidrRequest. req := client.WithdrawByoipCidrRequest(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/WithdrawByoipCidr
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" idempotencyToken:"true"` // The value for the address type must be IPv4. IpAddressType IpAddressType `type:"string" enum:"true"` // Optionally, if you've added your own IP address pool to Global Accelerator, // you can choose IP addresses from your own pool to use for the accelerator's // static IP addresses. You can specify one or two addresses, separated by a // comma. Do not include the /32 suffix. // // If you specify only one IP address from your IP address range, Global Accelerator // assigns a second static IP address for the accelerator from the AWS IP address // pool. // // For more information, see Bring Your Own IP Addresses (BYOIP) (https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html) // in the AWS Global Accelerator Developer Guide. IpAddresses []string `type:"list"` // 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"` // Create tags for an accelerator. // // For more information, see Tagging in AWS Global Accelerator (https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html) // in the AWS Global Accelerator Developer Guide. Tags []Tag `type:"list"` // 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 ¶
type CreateAcceleratorResponse struct { *CreateAcceleratorOutput // contains filtered or unexported fields }
CreateAcceleratorResponse is the response type for the CreateAccelerator API operation.
func (*CreateAcceleratorResponse) SDKResponseMetdata ¶
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" idempotencyToken:"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 ¶
type CreateEndpointGroupResponse struct { *CreateEndpointGroupOutput // contains filtered or unexported fields }
CreateEndpointGroupResponse is the response type for the CreateEndpointGroup API operation.
func (*CreateEndpointGroupResponse) SDKResponseMetdata ¶
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" idempotencyToken:"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 ¶
type CreateListenerResponse struct { *CreateListenerOutput // contains filtered or unexported fields }
CreateListenerResponse is the response type for the CreateListener API operation.
func (*CreateListenerResponse) SDKResponseMetdata ¶
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 ¶
type DeleteAcceleratorResponse struct { *DeleteAcceleratorOutput // contains filtered or unexported fields }
DeleteAcceleratorResponse is the response type for the DeleteAccelerator API operation.
func (*DeleteAcceleratorResponse) SDKResponseMetdata ¶
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 ¶
type DeleteEndpointGroupResponse struct { *DeleteEndpointGroupOutput // contains filtered or unexported fields }
DeleteEndpointGroupResponse is the response type for the DeleteEndpointGroup API operation.
func (*DeleteEndpointGroupResponse) SDKResponseMetdata ¶
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 ¶
type DeleteListenerResponse struct { *DeleteListenerOutput // contains filtered or unexported fields }
DeleteListenerResponse is the response type for the DeleteListener API operation.
func (*DeleteListenerResponse) SDKResponseMetdata ¶
func (r *DeleteListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeleteListener request.
type DeprovisionByoipCidrInput ¶
type DeprovisionByoipCidrInput struct { // The address range, in CIDR notation. The prefix must be the same prefix that // you specified when you provisioned the address range. // // Cidr is a required field Cidr *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeprovisionByoipCidrInput) String ¶
func (s DeprovisionByoipCidrInput) String() string
String returns the string representation
func (*DeprovisionByoipCidrInput) Validate ¶
func (s *DeprovisionByoipCidrInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeprovisionByoipCidrOutput ¶
type DeprovisionByoipCidrOutput struct { // Information about the address range. ByoipCidr *ByoipCidr `type:"structure"` // contains filtered or unexported fields }
func (DeprovisionByoipCidrOutput) String ¶
func (s DeprovisionByoipCidrOutput) String() string
String returns the string representation
type DeprovisionByoipCidrRequest ¶
type DeprovisionByoipCidrRequest struct { *aws.Request Input *DeprovisionByoipCidrInput Copy func(*DeprovisionByoipCidrInput) DeprovisionByoipCidrRequest }
DeprovisionByoipCidrRequest is the request type for the DeprovisionByoipCidr API operation.
func (DeprovisionByoipCidrRequest) Send ¶
func (r DeprovisionByoipCidrRequest) Send(ctx context.Context) (*DeprovisionByoipCidrResponse, error)
Send marshals and sends the DeprovisionByoipCidr API request.
type DeprovisionByoipCidrResponse ¶
type DeprovisionByoipCidrResponse struct { *DeprovisionByoipCidrOutput // contains filtered or unexported fields }
DeprovisionByoipCidrResponse is the response type for the DeprovisionByoipCidr API operation.
func (*DeprovisionByoipCidrResponse) SDKResponseMetdata ¶
func (r *DeprovisionByoipCidrResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the DeprovisionByoipCidr 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 ¶
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 ¶
type DescribeAcceleratorAttributesResponse struct { *DescribeAcceleratorAttributesOutput // contains filtered or unexported fields }
DescribeAcceleratorAttributesResponse is the response type for the DescribeAcceleratorAttributes API operation.
func (*DescribeAcceleratorAttributesResponse) SDKResponseMetdata ¶
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 ¶
type DescribeAcceleratorResponse struct { *DescribeAcceleratorOutput // contains filtered or unexported fields }
DescribeAcceleratorResponse is the response type for the DescribeAccelerator API operation.
func (*DescribeAcceleratorResponse) SDKResponseMetdata ¶
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 ¶
type DescribeEndpointGroupResponse struct { *DescribeEndpointGroupOutput // contains filtered or unexported fields }
DescribeEndpointGroupResponse is the response type for the DescribeEndpointGroup API operation.
func (*DescribeEndpointGroupResponse) SDKResponseMetdata ¶
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 ¶
type DescribeListenerResponse struct { *DescribeListenerOutput // contains filtered or unexported fields }
DescribeListenerResponse is the response type for the DescribeListener API operation.
func (*DescribeListenerResponse) SDKResponseMetdata ¶
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 Preserve Client IP Addresses in AWS Global Accelerator // (https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.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. For EC2 instances, this is the EC2 instance ID. // // An Application Load Balancer can be either internal or internet-facing. 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. For EC2 instances, this is the EC2 instance 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 ¶
type ListAcceleratorsResponse struct { *ListAcceleratorsOutput // contains filtered or unexported fields }
ListAcceleratorsResponse is the response type for the ListAccelerators API operation.
func (*ListAcceleratorsResponse) SDKResponseMetdata ¶
func (r *ListAcceleratorsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListAccelerators request.
type ListByoipCidrsInput ¶
type ListByoipCidrsInput struct { // The maximum number of results to return with a single call. To retrieve the // remaining results, make another call with the returned nextToken value. MaxResults *int64 `min:"1" type:"integer"` // The token for the next page of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListByoipCidrsInput) String ¶
func (s ListByoipCidrsInput) String() string
String returns the string representation
func (*ListByoipCidrsInput) Validate ¶
func (s *ListByoipCidrsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListByoipCidrsOutput ¶
type ListByoipCidrsOutput struct { // Information about your address ranges. ByoipCidrs []ByoipCidr `type:"list"` // The token for the next page of results. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListByoipCidrsOutput) String ¶
func (s ListByoipCidrsOutput) String() string
String returns the string representation
type ListByoipCidrsRequest ¶
type ListByoipCidrsRequest struct { *aws.Request Input *ListByoipCidrsInput Copy func(*ListByoipCidrsInput) ListByoipCidrsRequest }
ListByoipCidrsRequest is the request type for the ListByoipCidrs API operation.
func (ListByoipCidrsRequest) Send ¶
func (r ListByoipCidrsRequest) Send(ctx context.Context) (*ListByoipCidrsResponse, error)
Send marshals and sends the ListByoipCidrs API request.
type ListByoipCidrsResponse ¶
type ListByoipCidrsResponse struct { *ListByoipCidrsOutput // contains filtered or unexported fields }
ListByoipCidrsResponse is the response type for the ListByoipCidrs API operation.
func (*ListByoipCidrsResponse) SDKResponseMetdata ¶
func (r *ListByoipCidrsResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListByoipCidrs 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 ¶
type ListEndpointGroupsResponse struct { *ListEndpointGroupsOutput // contains filtered or unexported fields }
ListEndpointGroupsResponse is the response type for the ListEndpointGroups API operation.
func (*ListEndpointGroupsResponse) SDKResponseMetdata ¶
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 ¶
type ListListenersResponse struct { *ListListenersOutput // contains filtered or unexported fields }
ListListenersResponse is the response type for the ListListeners API operation.
func (*ListListenersResponse) SDKResponseMetdata ¶
func (r *ListListenersResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListListeners request.
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the accelerator to list tags for. An ARN // uniquely identifies an accelerator. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Root level tag for the Tags parameters. Tags []Tag `type:"list"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTagsForResourceRequest ¶
type ListTagsForResourceRequest struct { *aws.Request Input *ListTagsForResourceInput Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest }
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
func (ListTagsForResourceRequest) Send ¶
func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)
Send marshals and sends the ListTagsForResource API request.
type ListTagsForResourceResponse ¶
type ListTagsForResourceResponse struct { *ListTagsForResourceOutput // contains filtered or unexported fields }
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
func (*ListTagsForResourceResponse) SDKResponseMetdata ¶
func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ListTagsForResource 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 ProvisionByoipCidrInput ¶
type ProvisionByoipCidrInput struct { // The public IPv4 address range, in CIDR notation. The most specific IP prefix // that you can specify is /24. The address range cannot overlap with another // address range that you've brought to this or another Region. // // Cidr is a required field Cidr *string `type:"string" required:"true"` // A signed document that proves that you are authorized to bring the specified // IP address range to Amazon using BYOIP. // // CidrAuthorizationContext is a required field CidrAuthorizationContext *CidrAuthorizationContext `type:"structure" required:"true"` // contains filtered or unexported fields }
func (ProvisionByoipCidrInput) String ¶
func (s ProvisionByoipCidrInput) String() string
String returns the string representation
func (*ProvisionByoipCidrInput) Validate ¶
func (s *ProvisionByoipCidrInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProvisionByoipCidrOutput ¶
type ProvisionByoipCidrOutput struct { // Information about the address range. ByoipCidr *ByoipCidr `type:"structure"` // contains filtered or unexported fields }
func (ProvisionByoipCidrOutput) String ¶
func (s ProvisionByoipCidrOutput) String() string
String returns the string representation
type ProvisionByoipCidrRequest ¶
type ProvisionByoipCidrRequest struct { *aws.Request Input *ProvisionByoipCidrInput Copy func(*ProvisionByoipCidrInput) ProvisionByoipCidrRequest }
ProvisionByoipCidrRequest is the request type for the ProvisionByoipCidr API operation.
func (ProvisionByoipCidrRequest) Send ¶
func (r ProvisionByoipCidrRequest) Send(ctx context.Context) (*ProvisionByoipCidrResponse, error)
Send marshals and sends the ProvisionByoipCidr API request.
type ProvisionByoipCidrResponse ¶
type ProvisionByoipCidrResponse struct { *ProvisionByoipCidrOutput // contains filtered or unexported fields }
ProvisionByoipCidrResponse is the response type for the ProvisionByoipCidr API operation.
func (*ProvisionByoipCidrResponse) SDKResponseMetdata ¶
func (r *ProvisionByoipCidrResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the ProvisionByoipCidr request.
type Tag ¶
type Tag struct { // A string that contains a Tag key. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // A string that contains a Tag value. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
A complex type that contains a Tag key and Tag value.
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the Global Accelerator resource to add // tags to. An ARN uniquely identifies a resource. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // The tags to add to a resource. A tag consists of a key and a value that you // define. // // Tags is a required field Tags []Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TagResourceRequest ¶
type TagResourceRequest struct { *aws.Request Input *TagResourceInput Copy func(*TagResourceInput) TagResourceRequest }
TagResourceRequest is the request type for the TagResource API operation.
func (TagResourceRequest) Send ¶
func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)
Send marshals and sends the TagResource API request.
type TagResourceResponse ¶
type TagResourceResponse struct { *TagResourceOutput // contains filtered or unexported fields }
TagResourceResponse is the response type for the TagResource API operation.
func (*TagResourceResponse) SDKResponseMetdata ¶
func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the TagResource request.
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the Global Accelerator resource to remove // tags from. An ARN uniquely identifies a resource. // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // The tag key pairs that you want to remove from the specified resources. // // TagKeys is a required field TagKeys []string `type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UntagResourceRequest ¶
type UntagResourceRequest struct { *aws.Request Input *UntagResourceInput Copy func(*UntagResourceInput) UntagResourceRequest }
UntagResourceRequest is the request type for the UntagResource API operation.
func (UntagResourceRequest) Send ¶
func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)
Send marshals and sends the UntagResource API request.
type UntagResourceResponse ¶
type UntagResourceResponse struct { *UntagResourceOutput // contains filtered or unexported fields }
UntagResourceResponse is the response type for the UntagResource API operation.
func (*UntagResourceResponse) SDKResponseMetdata ¶
func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UntagResource request.
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. If you specify slash (/) for the S3 bucket prefix, the log file // bucket folder structure will include a double slash (//), like the following: // // s3-bucket_name//AWSLogs/aws_account_id FlowLogsS3Prefix *string `type:"string"` // contains filtered or unexported fields }
func (UpdateAcceleratorAttributesInput) String ¶
func (s UpdateAcceleratorAttributesInput) String() string
String returns the string representation
func (*UpdateAcceleratorAttributesInput) Validate ¶
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 ¶
type UpdateAcceleratorAttributesResponse struct { *UpdateAcceleratorAttributesOutput // contains filtered or unexported fields }
UpdateAcceleratorAttributesResponse is the response type for the UpdateAcceleratorAttributes API operation.
func (*UpdateAcceleratorAttributesResponse) SDKResponseMetdata ¶
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 ¶
type UpdateAcceleratorResponse struct { *UpdateAcceleratorOutput // contains filtered or unexported fields }
UpdateAcceleratorResponse is the response type for the UpdateAccelerator API operation.
func (*UpdateAcceleratorResponse) SDKResponseMetdata ¶
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 ¶
type UpdateEndpointGroupResponse struct { *UpdateEndpointGroupOutput // contains filtered or unexported fields }
UpdateEndpointGroupResponse is the response type for the UpdateEndpointGroup API operation.
func (*UpdateEndpointGroupResponse) SDKResponseMetdata ¶
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 ¶
type UpdateListenerResponse struct { *UpdateListenerOutput // contains filtered or unexported fields }
UpdateListenerResponse is the response type for the UpdateListener API operation.
func (*UpdateListenerResponse) SDKResponseMetdata ¶
func (r *UpdateListenerResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the UpdateListener request.
type WithdrawByoipCidrInput ¶
type WithdrawByoipCidrInput struct { // The address range, in CIDR notation. // // Cidr is a required field Cidr *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (WithdrawByoipCidrInput) String ¶
func (s WithdrawByoipCidrInput) String() string
String returns the string representation
func (*WithdrawByoipCidrInput) Validate ¶
func (s *WithdrawByoipCidrInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type WithdrawByoipCidrOutput ¶
type WithdrawByoipCidrOutput struct { // Information about the address pool. ByoipCidr *ByoipCidr `type:"structure"` // contains filtered or unexported fields }
func (WithdrawByoipCidrOutput) String ¶
func (s WithdrawByoipCidrOutput) String() string
String returns the string representation
type WithdrawByoipCidrRequest ¶
type WithdrawByoipCidrRequest struct { *aws.Request Input *WithdrawByoipCidrInput Copy func(*WithdrawByoipCidrInput) WithdrawByoipCidrRequest }
WithdrawByoipCidrRequest is the request type for the WithdrawByoipCidr API operation.
func (WithdrawByoipCidrRequest) Send ¶
func (r WithdrawByoipCidrRequest) Send(ctx context.Context) (*WithdrawByoipCidrResponse, error)
Send marshals and sends the WithdrawByoipCidr API request.
type WithdrawByoipCidrResponse ¶
type WithdrawByoipCidrResponse struct { *WithdrawByoipCidrOutput // contains filtered or unexported fields }
WithdrawByoipCidrResponse is the response type for the WithdrawByoipCidr API operation.
func (*WithdrawByoipCidrResponse) SDKResponseMetdata ¶
func (r *WithdrawByoipCidrResponse) SDKResponseMetdata() *aws.Response
SDKResponseMetdata returns the response metadata for the WithdrawByoipCidr request.
Source Files ¶
- api_client.go
- api_doc.go
- api_enums.go
- api_errors.go
- api_op_AdvertiseByoipCidr.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_DeprovisionByoipCidr.go
- api_op_DescribeAccelerator.go
- api_op_DescribeAcceleratorAttributes.go
- api_op_DescribeEndpointGroup.go
- api_op_DescribeListener.go
- api_op_ListAccelerators.go
- api_op_ListByoipCidrs.go
- api_op_ListEndpointGroups.go
- api_op_ListListeners.go
- api_op_ListTagsForResource.go
- api_op_ProvisionByoipCidr.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAccelerator.go
- api_op_UpdateAcceleratorAttributes.go
- api_op_UpdateEndpointGroup.go
- api_op_UpdateListener.go
- api_op_WithdrawByoipCidr.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. |