API Reference¶
Packages¶
aga.k8s.aws/v1beta1¶
Package v1beta1 contains API Schema definitions for the aga v1beta1 API group
Resource Types¶
ClientAffinityType¶
Underlying type: string
ClientAffinityType defines the client affinity for Global Accelerator listeners.
Validation: - Enum: [SOURCE_IP NONE]
Appears in: - GlobalAcceleratorListener
| Field | Description |
|---|---|
SOURCE_IP |
|
NONE |
GlobalAccelerator¶
GlobalAccelerator is the Schema for the GlobalAccelerator API
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string |
aga.k8s.aws/v1beta1 |
||
kind string |
GlobalAccelerator |
||
metadata ObjectMeta |
Refer to Kubernetes API documentation for fields of metadata. |
||
spec GlobalAcceleratorSpec |
|||
status GlobalAcceleratorStatus |
GlobalAcceleratorEndpoint¶
GlobalAcceleratorEndpoint defines an endpoint for a Global Accelerator endpoint group.
Appears in: - GlobalAcceleratorEndpointGroup
| Field | Description | Default | Validation |
|---|---|---|---|
type GlobalAcceleratorEndpointType |
Type specifies the type of endpoint reference. | Enum: [EndpointID Service Ingress Gateway] |
|
endpointID string |
EndpointID is the ID of the endpoint when type is EndpointID. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. A resource must be valid and active when you add it as an endpoint. Mandatory for remote regions. |
MaxLength: 255 |
|
name string |
Name is the name of the Kubernetes resource when type is Service, Ingress, or Gateway. | ||
namespace string |
Namespace is the namespace of the Kubernetes resource when type is Service, Ingress, or Gateway. If not specified, defaults to the same namespace as the GlobalAccelerator resource. |
||
weight integer |
Weight is the weight associated with the endpoint. When you add weights to endpoints, you configure 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 in the AWS Global Accelerator Developer Guide: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoints-endpoint-weights.html |
128 | Maximum: 255 Minimum: 0 |
clientIPPreservationEnabled boolean |
ClientIPPreservationEnabled 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 the AWS Global Accelerator Developer Guide: https://docs.aws.amazon.com/global-accelerator/latest/dg/preserve-client-ip-address.html |
true |
GlobalAcceleratorEndpointGroup¶
GlobalAcceleratorEndpointGroup defines an endpoint group for a Global Accelerator listener.
Appears in: - GlobalAcceleratorListener
| Field | Description | Default | Validation |
|---|---|---|---|
region string |
Region is the AWS Region where the endpoint group is located. If unspecified, defaults to the current cluster region. |
MaxLength: 255 |
|
trafficDialPercentage integer |
TrafficDialPercentage is the percentage of traffic to send to an AWS Regions. 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. |
100 | Maximum: 100 Minimum: 0 |
portOverrides PortOverride |
PortOverrides is a list of endpoint port overrides. Allows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on. | ||
endpoints GlobalAcceleratorEndpoint |
Endpoints is the list of endpoint configurations for this endpoint group. |
GlobalAcceleratorEndpointType¶
Underlying type: string
GlobalAcceleratorEndpointType defines the type of endpoint for Global Accelerator.
Validation: - Enum: [EndpointID Service Ingress Gateway]
Appears in: - GlobalAcceleratorEndpoint
| Field | Description |
|---|---|
EndpointID |
|
Service |
|
Ingress |
|
Gateway |
GlobalAcceleratorListener¶
GlobalAcceleratorListener defines a listener for the Global Accelerator.
Appears in: - GlobalAcceleratorSpec
| Field | Description | Default | Validation |
|---|---|---|---|
protocol GlobalAcceleratorProtocol |
Protocol is the protocol for the connections from clients to the accelerator. When not specified, the controller will automatically determine the protocol by inspecting the referenced Kubernetes resources (Service, Ingress, or Gateway) in the endpoint groups. |
Enum: [TCP UDP] |
|
portRanges PortRange |
PortRanges is the list of port ranges for the connections from clients to the accelerator. When not specified, the controller will automatically determine the port ranges by inspecting the referenced Kubernetes resources (Service, Ingress, or Gateway) in the endpoint groups. |
MaxItems: 10 MinItems: 1 |
|
clientAffinity ClientAffinityType |
ClientAffinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint. 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. |
NONE | Enum: [SOURCE_IP NONE] |
endpointGroups GlobalAcceleratorEndpointGroup |
EndpointGroups defines a list of endpoint groups for a Global Accelerator listener. |
GlobalAcceleratorProtocol¶
Underlying type: string
GlobalAcceleratorProtocol defines the protocol for Global Accelerator listeners.
Validation: - Enum: [TCP UDP]
Appears in: - GlobalAcceleratorListener
| Field | Description |
|---|---|
TCP |
|
UDP |
GlobalAcceleratorSpec¶
GlobalAcceleratorSpec defines the desired state of GlobalAccelerator
Appears in: - GlobalAccelerator
| Field | Description | Default | Validation |
|---|---|---|---|
name string |
Name is the name of the Global Accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen. |
MaxLength: 64 MinLength: 1 Pattern: ^[a-zA-Z0-9_-]\{1,64\}$ |
|
ipAddresses string |
IpAddresses optionally specifies the IP addresses from your own IP address pool (BYOIP) to use for the accelerator's static IP addresses. You can specify one or two addresses. Do not include the /32 suffix. If you bring your own IP address pool to Global Accelerator (BYOIP), you can choose an IPv4 address from your own pool to use for the accelerator's static IPv4 address. After you bring an address range to AWS, it appears in your account as an address pool. When you create an accelerator, you can assign one IPv4 address from your range to it. Global Accelerator assigns you a second static IPv4 address from an Amazon IP address range. If you bring two IPv4 address ranges to AWS, you can assign one IPv4 address from each range to your accelerator. Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses. For more information, see Bring your own IP addresses (BYOIP) in the AWS Global Accelerator Developer Guide. https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html |
MaxItems: 2 MinItems: 1 |
|
ipAddressType IPAddressType |
IPAddressType is the value for the address type. | IPV4 | Enum: [IPV4 DUAL_STACK] |
tags map[string]string |
Tags defines list of Tags on the Global Accelerator. | ||
listeners GlobalAcceleratorListener |
Listeners defines the listeners for the Global Accelerator. |
GlobalAcceleratorStatus¶
GlobalAcceleratorStatus defines the observed state of GlobalAccelerator
Appears in: - GlobalAccelerator
| Field | Description | Default | Validation |
|---|---|---|---|
observedGeneration integer |
The generation observed by the GlobalAccelerator controller. | ||
acceleratorARN string |
AcceleratorARN is the Amazon Resource Name (ARN) of the accelerator. | ||
dnsName string |
DNSName The Domain Name System (DNS) name that Global Accelerator creates that points to an accelerator's static IPv4 addresses. | ||
dualStackDnsName string |
DualStackDnsName is the Domain Name System (DNS) name that Global Accelerator creates that points to a dual-stack accelerator's four static IP addresses: two IPv4 addresses and two IPv6 addresses. | ||
ipSets IPSet array |
IPSets is the static IP addresses that Global Accelerator associates with the accelerator. | ||
status string |
Status is the current status of the accelerator. | ||
conditions Condition array |
Conditions represent the current conditions of the GlobalAccelerator. |
IPAddressType¶
Underlying type: string
IPAddressType defines the IP address type for Global Accelerator.
Validation: - Enum: [IPV4 DUAL_STACK]
Appears in: - GlobalAcceleratorSpec
| Field | Description |
|---|---|
IPV4 |
|
DUAL_STACK |
IPSet¶
IPSet is the static IP addresses that Global Accelerator associates with the accelerator.
Appears in: - GlobalAcceleratorStatus
| Field | Description | Default | Validation |
|---|---|---|---|
ipAddresses string |
IpAddresses is the array of IP addresses in the IP address set. | ||
ipAddressFamily string |
IpAddressFamily is the types of IP addresses included in this IP set. |
PortOverride¶
PortOverride defines a port override for an endpoint group. Override specific listener ports used to route traffic to endpoints that are part of an endpoint group. For example, you can create a port override in which the listener receives user traffic on ports 80 and 443, but your accelerator routes that traffic to ports 1080 and 1443, respectively, on the endpoints.
For more information, see Port overrides in the AWS Global Accelerator Developer Guide: https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups-port-override.html
Appears in: - GlobalAcceleratorEndpointGroup
| Field | Description | Default | Validation |
|---|---|---|---|
listenerPort integer |
ListenerPort is the listener port that you want to map to a specific endpoint port. This is the port that user traffic arrives to the Global Accelerator on. |
Maximum: 65535 Minimum: 1 |
|
endpointPort integer |
EndpointPort is the endpoint port that you want traffic to be routed to. This is the port on the endpoint, such as the Application Load Balancer or Amazon EC2 instance. |
Maximum: 65535 Minimum: 1 |
PortRange¶
PortRange defines the port range for Global Accelerator listeners.
Appears in: - GlobalAcceleratorListener
| Field | Description | Default | Validation |
|---|---|---|---|
fromPort integer |
FromPort is the first port in the range of ports, inclusive. | Maximum: 65535 Minimum: 1 |
|
toPort integer |
ToPort is the last port in the range of ports, inclusive. | Maximum: 65535 Minimum: 1 |