Deployment
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#Deployment |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Deployment |
| ListKind | DeploymentList |
| Plural | deployments |
| Singular | deployment |
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Spec
cacheClusterEnabled: boolean
cacheClusterSize: string
canarySettings:
percentTraffic: number
stageVariableOverrides: {}
useStageCache: boolean
description: string
restAPIID: string
restAPIRef:
from:
name: string
namespace: string
stageDescription: string
stageName: string
tracingEnabled: boolean
variables: {}
| Field | Description |
|---|---|
| cacheClusterEnabled Optional | boolean Enables a cache cluster for the Stage resource specified in the input. |
| 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 input configuration for the canary deployment when the deployment is a canary release deployment. |
| canarySettings.percentTraffic Optional | number |
| canarySettings.stageVariableOverrides Optional | object |
| canarySettings.useStageCache Optional | boolean |
| description Optional | string The description for the Deployment resource to create. |
| 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 |
| stageDescription Optional | string The description of the Stage resource for the Deployment resource to create. |
| stageName Optional | string The name of the Stage resource for the Deployment resource to create. |
| 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 Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
apiSummary: {}
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: string
id: 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. |
| apiSummary Optional | object A summary of the RestApi at the date and time that the deployment resource was created. |
| 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 date and time that the deployment resource was created. |
| id Optional | string The identifier for the deployment resource. |