Stage
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#Stage |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Stage |
| ListKind | StageList |
| Plural | stages |
| Singular | stage |
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Spec
cacheClusterEnabled: boolean
cacheClusterSize: string
canarySettings:
deploymentID: string
percentTraffic: number
stageVariableOverrides: {}
useStageCache: boolean
deploymentID: string
description: string
documentationVersion: string
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
stageName: string
tags: {}
tracingEnabled: boolean
variables: {}
| Field | Description |
|---|---|
| cacheClusterEnabled Optional | boolean Whether cache clustering is enabled for the stage. |
| cacheClusterSize Optional | string The stage’s cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness (https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). |
| canarySettings Optional | object The canary deployment settings of this stage. |
| canarySettings.deploymentID Optional | string |
| canarySettings.percentTraffic Optional | number |
| canarySettings.stageVariableOverrides Optional | object |
| canarySettings.useStageCache Optional | boolean |
| deploymentID Required | string The identifier of the Deployment resource for the Stage resource. |
| description Optional | string The description of the Stage resource. |
| documentationVersion Optional | string The version of the associated API documentation. |
| restAPIID Optional | string The string identifier of the associated RestApi. |
| restAPIRef 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 |
| restAPIRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| restAPIRef.from.name Optional | string |
| restAPIRef.from.namespace Optional | string |
| stageName Required | string The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
| 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. |
| tracingEnabled Optional | boolean Specifies whether active tracing with X-ray is enabled for the Stage. |
| variables Optional | object A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. |
Status
accessLogSettings:
destinationARN: string
format: string
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
cacheClusterStatus: string
clientCertificateID: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: string
lastUpdatedDate: string
methodSettings: {}
webACLARN: string
| Field | Description |
|---|---|
| accessLogSettings Optional | object Settings for logging access in this stage. |
| accessLogSettings.destinationARN Optional | string |
| accessLogSettings.format Optional | string |
| 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. |
| cacheClusterStatus Optional | string The status of the cache cluster for the stage, if enabled. |
| clientCertificateID Optional | string The identifier of a client certificate for an API 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. |
| lastUpdatedDate Optional | string The timestamp when the stage last updated. |
| methodSettings Optional | object A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /*/* for overriding all methods in the stage. |
| webACLARN Optional | string The ARN of the WebAcl associated with the Stage. |