Stage
apigatewayv2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigatewayv2-controller/apis/v1alpha1#Stage |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Stage |
| ListKind | StageList |
| Plural | stages |
| Singular | stage |
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: {}
| Field | Description |
|---|---|
| accessLogSettings Optional | object Settings for logging access in this 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 The API identifier. |
| 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 Specifies whether updates to an API automatically trigger a new deployment. The default value is false. |
| clientCertificateID Optional | string The identifier of a client certificate for a Stage. Supported only for WebSocket APIs. |
| defaultRouteSettings Optional | object The default route settings for the stage. |
| 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 The deployment identifier of the API stage. |
| 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 The description for the API stage. |
| routeSettings Optional | object Route settings for the stage, by routeKey. |
| stageName Required | string The name of the stage. |
| stageVariables Optional | object A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. |
| tags Optional | object The collection of tags. Each tag element is associated with a given resource. |
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
| 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. |
| apiGatewayManaged Optional | boolean Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can’t modify the $default stage. |
| 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 |
| createdDate Optional | string The timestamp when the stage was created. |
| lastDeploymentStatusMessage Optional | string Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled. |
| lastUpdatedDate Optional | string The timestamp when the stage was last updated. |