VPC

ec2.services.k8s.aws/v1alpha1

TypeLink
GoDocec2-controller/apis/v1alpha1#VPC

Metadata

PropertyValue
ScopeNamespaced
KindVPC
ListKindVPCList
Pluralvpcs
Singularvpc

Describes a VPC.

Spec

amazonProvidedIPv6CIDRBlock: boolean
cidrBlocks:
- string
enableDNSHostnames: boolean
enableDNSSupport: boolean
instanceTenancy: string
ipv4IPAMPoolID: string
ipv4NetmaskLength: integer
ipv6CIDRBlock: string
ipv6CIDRBlockNetworkBorderGroup: string
ipv6IPAMPoolID: string
ipv6NetmaskLength: integer
ipv6Pool: string
tags:
- key: string
  value: string
FieldDescription
amazonProvidedIPv6CIDRBlock
Optional
boolean
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for
the VPC. You cannot specify the range of IP addresses, or the size of the
CIDR block.
cidrBlocks
Required
array
cidrBlocks.[]
Required
string
enableDNSSupport
Optional
boolean
The attribute value. The valid values are true or false.
instanceTenancy
Optional
string
The tenancy options for instances launched into the VPC. For default, instances
are launched with shared tenancy by default. You can launch instances with
any tenancy into a shared tenancy VPC. For dedicated, instances are launched
as dedicated tenancy instances by default. You can only launch instances
with a tenancy of dedicated or host into a dedicated tenancy VPC.


Important: The host value cannot be used with this parameter. Use the default
or dedicated values only.


Default: default
ipv4IPAMPoolID
Optional
string
The ID of an IPv4 IPAM pool you want to use for allocating this VPC’s CIDR.
For more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)
in the Amazon VPC IPAM User Guide.
ipv4NetmaskLength
Optional
integer
The netmask length of the IPv4 CIDR you want to allocate to this VPC from
an Amazon VPC IP Address Manager (IPAM) pool. For more information about
IPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)
in the Amazon VPC IPAM User Guide.
ipv6CIDRBlock
Optional
string
The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool
in the request.


To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
ipv6CIDRBlockNetworkBorderGroup
Optional
string
The name of the location from which we advertise the IPV6 CIDR block. Use
this parameter to limit the address to this location.


You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
ipv6IPAMPoolID
Optional
string
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6
CIDR. IPAM is a VPC feature that you can use to automate your IP address
management workflows including assigning, tracking, troubleshooting, and
auditing IP addresses across Amazon Web Services Regions and accounts throughout
your Amazon Web Services Organization. For more information, see What is
IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)
in the Amazon VPC IPAM User Guide.
ipv6NetmaskLength
Optional
integer
The netmask length of the IPv6 CIDR you want to allocate to this VPC from
an Amazon VPC IP Address Manager (IPAM) pool. For more information about
IPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)
in the Amazon VPC IPAM User Guide.
ipv6Pool
Optional
string
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
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
cidrBlockAssociationSet:
- associationID: string
  cidrBlock: string
  cidrBlockState: 
    state: string
    statusMessage: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
dhcpOptionsID: string
ipv6CIDRBlockAssociationSet:
- associationID: string
  ipv6CIDRBlock: string
  ipv6CIDRBlockState: 
    state: string
    statusMessage: string
  ipv6Pool: string
  networkBorderGroup: string
isDefault: boolean
ownerID: string
state: string
vpcID: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that 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.
TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse
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.
cidrBlockAssociationSet
Optional
array
Information about the IPv4 CIDR blocks associated with the VPC.
cidrBlockAssociationSet.[]
Required
object
Describes an IPv4 CIDR block associated with a VPC.
cidrBlockAssociationSet.[].cidrBlock
Optional
string
cidrBlockAssociationSet.[].cidrBlockState
Optional
object
Describes the state of a CIDR block.
cidrBlockAssociationSet.[].cidrBlockState.state
Optional
string
cidrBlockAssociationSet.[].cidrBlockState.statusMessage
Optional
string
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the 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
dhcpOptionsID
Optional
string
The ID of the set of DHCP options you’ve associated with the VPC.
ipv6CIDRBlockAssociationSet
Optional
array
Information about the IPv6 CIDR blocks associated with the VPC.
ipv6CIDRBlockAssociationSet.[]
Required
object
Describes an IPv6 CIDR block associated with a VPC.
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
ipv6CIDRBlockAssociationSet.[].ipv6Pool
Optional
string
ipv6CIDRBlockAssociationSet.[].networkBorderGroup
Optional
string
isDefault
Optional
boolean
Indicates whether the VPC is the default VPC.
ownerID
Optional
string
The ID of the Amazon Web Services account that owns the VPC.
state
Optional
string
The current state of the VPC.
vpcID
Optional
string
The ID of the VPC.