Subnet
ec2.services.k8s.aws/v1alpha1
Type | Link |
---|---|
GoDoc | ec2-controller/apis/v1alpha1#Subnet |
Metadata
Property | Value |
---|---|
Scope | Namespaced |
Kind | Subnet |
ListKind | SubnetList |
Plural | subnets |
Singular | subnet |
Describes a subnet.
Spec
assignIPv6AddressOnCreation: boolean
availabilityZone: string
availabilityZoneID: string
cidrBlock: string
customerOwnedIPv4Pool: string
enableDNS64: boolean
enableResourceNameDNSAAAARecord: boolean
enableResourceNameDNSARecord: boolean
hostnameType: string
ipv6CIDRBlock: string
ipv6Native: boolean
mapPublicIPOnLaunch: boolean
outpostARN: string
routeTableRefs:
from:
name: string
namespace: string
routeTables:
- string
tags:
- key: string
value: string
vpcID: string
vpcRef:
from:
name: string
namespace: string
Field | Description |
---|---|
assignIPv6AddressOnCreation Optional | boolean |
availabilityZone Optional | string The Availability Zone or Local Zone for the subnet. Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet. To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions) in the Amazon Elastic Compute Cloud User Guide. To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN. |
availabilityZoneID Optional | string The AZ ID or the Local Zone ID of the subnet. |
cidrBlock Optional | string The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18. This parameter is not supported for an IPv6 only subnet. |
customerOwnedIPv4Pool Optional | string |
enableDNS64 Optional | boolean |
enableResourceNameDNSAAAARecord Optional | boolean |
enableResourceNameDNSARecord Optional | boolean |
hostnameType Optional | string |
ipv6CIDRBlock Optional | string The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length. This parameter is required for an IPv6 only subnet. |
ipv6Native Optional | boolean Indicates whether to create an IPv6 only subnet. |
mapPublicIPOnLaunch Optional | boolean |
outpostARN Optional | string The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet. |
routeTableRefs Optional | array |
routeTableRefs.[] 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 || **routeTableRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| routeTableRefs.[].from.name
Optional | string
|
| routeTableRefs.[].from.namespace
Optional | string
|
| routeTables
Optional | array
|
| routeTables.[]
Required | 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.[].key
Optional | string
|
| tags.[].value
Optional | string
|
| vpcID
Optional | string
The ID of the VPC. |
| vpcRef
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 |
| vpcRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| vpcRef.from.name
Optional | string
|
| vpcRef.from.namespace
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
availableIPAddressCount: integer
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
defaultForAZ: boolean
enableLniAtDeviceIndex: integer
ipv6CIDRBlockAssociationSet:
- associationID: string
ipv6CIDRBlock: string
ipv6CIDRBlockState:
state: string
statusMessage: string
mapCustomerOwnedIPOnLaunch: boolean
ownerID: string
privateDNSNameOptionsOnLaunch:
enableResourceNameDNSAAAARecord: boolean
enableResourceNameDNSARecord: boolean
hostnameType: string
state: string
subnetID: 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. |
availableIPAddressCount Optional | integer The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable. |
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 |
defaultForAZ Optional | boolean Indicates whether this is the default subnet for the Availability Zone. |
enableLniAtDeviceIndex Optional | integer Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). |
ipv6CIDRBlockAssociationSet Optional | array Information about the IPv6 CIDR blocks associated with the subnet. |
ipv6CIDRBlockAssociationSet.[] Required | object Describes an association between a subnet and an IPv6 CIDR block. |
ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock Optional | string |
ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState Optional | object Describes the state of a CIDR block. |
ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state Optional | string |
ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage Optional | string |
mapCustomerOwnedIPOnLaunch Optional | boolean Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address. |
ownerID Optional | string The ID of the Amazon Web Services account that owns the subnet. |
privateDNSNameOptionsOnLaunch Optional | object The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance. |
privateDNSNameOptionsOnLaunch.enableResourceNameDNSAAAARecord Optional | boolean |
privateDNSNameOptionsOnLaunch.enableResourceNameDNSARecord Optional | boolean |
privateDNSNameOptionsOnLaunch.hostnameType Optional | string |
state Optional | string The current state of the subnet. |
subnetID Optional | string The ID of the subnet. |