Deployment
apigatewayv2.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigatewayv2-controller/apis/v1alpha1#Deployment |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | Deployment |
| ListKind | DeploymentList |
| Plural | deployments |
| Singular | deployment |
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
Spec
apiID: string
apiRef:
from:
name: string
namespace: string
description: string
stageName: string
| Field | Description |
|---|---|
| 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 |
| description Optional | string The description for the deployment resource. |
| stageName Optional | string The name of the Stage resource for the Deployment resource to create. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
autoDeployed: boolean
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: string
deploymentID: string
deploymentStatus: string
deploymentStatusMessage: 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. |
| autoDeployed Optional | boolean Specifies whether a deployment was automatically released. |
| 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 when the Deployment resource was created. |
| deploymentID Optional | string The identifier for the deployment. |
| deploymentStatus Optional | string The status of the deployment: PENDING, FAILED, or SUCCEEDED. |
| deploymentStatusMessage Optional | string May contain additional feedback on the status of an API deployment. |