VPCLink

apigateway.services.k8s.aws/v1alpha1

TypeLink
GoDocapigateway-controller/apis/v1alpha1#VPCLink

Metadata

PropertyValue
ScopeNamespaced
KindVPCLink
ListKindVPCLinkList
Pluralvpclinks
Singularvpclink

Spec

description: string
name: string
tags: {}
targetARNs:
- string
FieldDescription
description
Optional
string
The description of the VPC link.
name
Required
string
The name used to label and identify the VPC link.
tags
Optional
object
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/].
The tag key can be up to 128 characters and must not start with aws:. The
tag value can be up to 256 characters.
targetARNs
Required
array
The ARN of the network load balancer of the VPC targeted by the VPC link.
The network load balancer must be owned by the same Amazon Web Services account
of the API owner.
targetARNs.[]
Required
string

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
id: string
status: string
statusMessage: 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.
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
id
Optional
string
The identifier of the VpcLink. It is used in an Integration to reference
this VpcLink.
status
Optional
string
The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING,
or FAILED. Deploying an API will wait if the status is PENDING and will fail
if the status is DELETING.
statusMessage
Optional
string
A description about the VPC link status.