LoadBalancer
elbv2.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | elbv2-controller/apis/v1alpha1#LoadBalancer |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | LoadBalancer |
ListKind | LoadBalancerList |
Plural | loadbalancers |
Singular | loadbalancer |
Information about a load balancer.
Spec
attributes:
- key: string
value: string
customerOwnedIPv4Pool: string
ipAddressType: string
name: string
scheme: string
securityGroupRefs:
from:
name: string
namespace: string
securityGroups:
- string
subnetMappings:
- allocationID: string
ipv6Address: string
privateIPv4Address: string
subnetID: string
subnetRef:
from:
name: string
namespace: string
subnetRefs:
from:
name: string
namespace: string
subnets:
- string
tags:
- key: string
value: string
type: string
Field | Description |
---|---|
attributes Optional | array The load balancer attributes. |
attributes.[] Required | object Information about a load balancer attribute. |
attributes.[].value Optional | string |
customerOwnedIPv4Pool Optional | string [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool). |
ipAddressType Optional | string The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). |
name Optional | string The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with “internal-”. |
scheme Optional | string The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. |
securityGroupRefs Optional | array |
securityGroupRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference |
type to provide more user friendly syntax for references using ‘from’ field | |
Ex: | |
APIIDRef: |
from:
name: my-api || **securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| securityGroupRefs.[].from.name
Optional | string
|
| securityGroupRefs.[].from.namespace
Optional | string
|
| securityGroups
Optional | array
[Application Load Balancers and Network Load Balancers] The IDs of the security
groups for the load balancer. |
| securityGroups.[]
Required | string
|| subnetMappings
Optional | array
The IDs of the subnets. You can specify only one subnet per Availability
Zone. You must specify either subnets or subnet mappings, but not both.
[Application Load Balancers] You must specify subnets from at least two Availability
Zones. You cannot specify Elastic IP addresses for your subnets.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from
one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability
Zones. You can specify one Elastic IP address per subnet if you need static
IP addresses for your internet-facing load balancer. For internal load balancers,
you can specify one private IP address per subnet from the IPv4 range of
the subnet. For internet-facing load balancer, you can specify one IPv6 address
per subnet.
[Gateway Load Balancers] You can specify subnets from one or more Availability
Zones. You cannot specify Elastic IP addresses for your subnets. |
| subnetMappings.[]
Required | object
Information about a subnet mapping. || subnetMappings.[].allocationID
Optional | string
|
| subnetMappings.[].ipv6Address
Optional | string
|
| subnetMappings.[].privateIPv4Address
Optional | string
|
| subnetMappings.[].subnetID
Optional | string
|
| subnetMappings.[].subnetRef
Optional | object
Reference field for SubnetID |
| subnetMappings.[].subnetRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| subnetMappings.[].subnetRef.from.name
Optional | string
|
| subnetMappings.[].subnetRef.from.namespace
Optional | string
|
| subnetRefs
Optional | array
|
| subnetRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:
from:
name: my-api || **subnetRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| subnetRefs.[].from.name
Optional | string
|
| subnetRefs.[].from.namespace
Optional | string
|
| subnets
Optional | array
The IDs of the subnets. You can specify only one subnet per Availability
Zone. You must specify either subnets or subnet mappings, but not both. To
specify an Elastic IP address, specify subnet mappings instead of subnets.
[Application Load Balancers] You must specify subnets from at least two Availability
Zones.
[Application Load Balancers on Outposts] You must specify one Outpost subnet.
[Application Load Balancers on Local Zones] You can specify subnets from
one or more Local Zones.
[Network Load Balancers] You can specify subnets from one or more Availability
Zones.
[Gateway Load Balancers] You can specify subnets from one or more Availability
Zones. |
| subnets.[]
Required | string
|| tags
Optional | array
The tags to assign to the load balancer. |
| tags.[]
Required | object
Information about a tag. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
| type
Optional | string
The type of load balancer. The default is application. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
availabilityZones:
loadBalancerAddresses:
- allocationID: string
ipAddress: string
ipv6Address: string
privateIPv4Address: string
outpostID: string
subnetID: string
zoneName: string
canonicalHostedZoneID: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdTime: string
dnsName: string
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic: string
state:
code: string
reason: string
vpcID: string
Field | Description |
---|---|
ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
availabilityZones Optional | array The subnets for the load balancer. |
availabilityZones.[] Required | object Information about an Availability Zone. |
availabilityZones.[].loadBalancerAddresses.[] Required | object Information about a static IP address for a load balancer. |
availabilityZones.[].loadBalancerAddresses.[].ipAddress Optional | string |
availabilityZones.[].loadBalancerAddresses.[].ipv6Address Optional | string |
availabilityZones.[].loadBalancerAddresses.[].privateIPv4Address Optional | string |
availabilityZones.[].outpostID Optional | string |
availabilityZones.[].subnetID Optional | string |
availabilityZones.[].zoneName Optional | string |
canonicalHostedZoneID Optional | string The ID of the Amazon Route 53 hosted zone associated with the load balancer. |
conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
controllers to indicate terminal states of the CR and its backend AWS | |
service API resource | |
conditions.[].message Optional | string A human readable message indicating details about the transition. |
conditions.[].reason Optional | string The reason for the condition’s last transition. |
conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
conditions.[].type Optional | string Type is the type of the Condition |
createdTime Optional | string The date and time the load balancer was created. |
dnsName Optional | string The public DNS name of the load balancer. |
enforceSecurityGroupInboundRulesOnPrivateLinkTraffic Optional | string Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through Amazon Web Services PrivateLink. |
state Optional | object The state of the load balancer. |
state.code Optional | string |
state.reason Optional | string |
vpcID Optional | string The ID of the VPC for the load balancer. |