NATGateway
ec2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | ec2-controller/apis/v1alpha1#NATGateway |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | NATGateway |
| ListKind | NATGatewayList |
| Plural | natgateways |
| Singular | natgateway |
Describes a NAT gateway.
Spec
allocationID: string
allocationRef:
from:
name: string
namespace: string
connectivityType: string
subnetID: string
subnetRef:
from:
name: string
namespace: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| allocationID Optional | string [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. |
| allocationRef Optional | 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 |
| allocationRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| allocationRef.from.name Optional | string |
| allocationRef.from.namespace Optional | string |
| connectivityType Optional | string Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. |
| subnetID Optional | string The subnet in which to create the NAT gateway. |
| subnetRef Optional | 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 |
| subnetRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| subnetRef.from.name Optional | string |
| subnetRef.from.namespace Optional | string |
| tags Optional | array The tags. The value parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. |
| tags.[] Required | object Describes a tag. |
| tags.[].value Optional | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createTime: string
deleteTime: string
failureCode: string
failureMessage: string
natGatewayAddresses:
- allocationID: string
networkInterfaceID: string
privateIP: string
publicIP: string
natGatewayID: string
provisionedBandwidth:
provisionTime: string
provisioned: string
requestTime: string
requested: string
status: string
state: 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. |
| 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 |
| createTime Optional | string The date and time the NAT gateway was created. |
| deleteTime Optional | string The date and time the NAT gateway was deleted, if applicable. |
| failureCode Optional | string If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet |
| failureMessage Optional | string If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code. * For InsufficientFreeAddressesInSubnet: “Subnet has insufficient free addresses to create this NAT gateway” * For Gateway.NotAttached: “Network vpc-xxxxxxxx has no Internet gateway attached” * For InvalidAllocationID.NotFound: “Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway” * For Resource.AlreadyAssociated: “Elastic IP address eipalloc-xxxxxxxx is already associated” * For InternalError: “Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again." * For InvalidSubnetID.NotFound: “The specified subnet subnet-xxxxxxxx does not exist or could not be found.” |
| natGatewayAddresses Optional | array Information about the IP addresses and network interface associated with the NAT gateway. |
| natGatewayAddresses.[] Required | object Describes the IP addresses and network interface associated with a NAT gateway. |
| natGatewayAddresses.[].networkInterfaceID Optional | string |
| natGatewayAddresses.[].privateIP Optional | string |
| natGatewayAddresses.[].publicIP Optional | string |
| natGatewayID Optional | string The ID of the NAT gateway. |
| provisionedBandwidth Optional | object Reserved. If you need to sustain traffic greater than the documented limits (https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html), contact us through the Support Center (https://console.aws.amazon.com/support/home?). |
| provisionedBandwidth.provisionTime Optional | string |
| provisionedBandwidth.provisioned Optional | string |
| provisionedBandwidth.requestTime Optional | string |
| provisionedBandwidth.requested Optional | string |
| provisionedBandwidth.status Optional | string |
| state Optional | string The state of the NAT gateway. * pending: The NAT gateway is being created and is not ready to process traffic. * failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason. * available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway. * deleting: The NAT gateway is in the process of being terminated and may still be processing traffic. * deleted: The NAT gateway has been terminated and is no longer processing traffic. |
| vpcID Optional | string The ID of the VPC in which the NAT gateway is located. |