Stage

apigatewayv2.services.k8s.aws/v1alpha1

TypeLink
GoDocapigatewayv2-controller/apis/v1alpha1#Stage

Metadata

PropertyValue
ScopeNamespaced
KindStage
ListKindStageList
Pluralstages
Singularstage

Represents an API stage.

Spec

accessLogSettings: 
  destinationARN: string
  format: string
apiID: string
apiRef: 
  from: 
    name: string
    namespace: string
autoDeploy: boolean
clientCertificateID: string
defaultRouteSettings: 
  dataTraceEnabled: boolean
  detailedMetricsEnabled: boolean
  loggingLevel: string
  throttlingBurstLimit: integer
  throttlingRateLimit: number
deploymentID: string
deploymentRef: 
  from: 
    name: string
    namespace: string
description: string
routeSettings: {}
stageName: string
stageVariables: {}
tags: {}
FieldDescription
accessLogSettings
Optional
object
Settings for logging access in a stage.
accessLogSettings.destinationARN
Optional
string
Represents an Amazon Resource Name (ARN).
accessLogSettings.format
Optional
string
A string with a length between [1-1024].
apiID
Optional
string
apiRef
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
apiRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
apiRef.from.name
Optional
string
apiRef.from.namespace
Optional
string
autoDeploy
Optional
boolean
clientCertificateID
Optional
string
defaultRouteSettings
Optional
object
Represents a collection of route settings.
defaultRouteSettings.dataTraceEnabled
Optional
boolean
defaultRouteSettings.detailedMetricsEnabled
Optional
boolean
defaultRouteSettings.loggingLevel
Optional
string
The logging level.
defaultRouteSettings.throttlingBurstLimit
Optional
integer
defaultRouteSettings.throttlingRateLimit
Optional
number
deploymentID
Optional
string
deploymentRef
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
deploymentRef.from
Optional
object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
deploymentRef.from.name
Optional
string
deploymentRef.from.namespace
Optional
string
description
Optional
string
routeSettings
Optional
object
stageName
Required
string
stageVariables
Optional
object
tags
Optional
object

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
apiGatewayManaged: boolean
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdDate: string
lastDeploymentStatusMessage: string
lastUpdatedDate: 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.
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.
apiGatewayManaged
Optional
boolean
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
createdDate
Optional
string
lastDeploymentStatusMessage
Optional
string
lastUpdatedDate
Optional
string