APIKey
apigateway.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | apigateway-controller/apis/v1alpha1#APIKey |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | APIKey |
| ListKind | APIKeyList |
| Plural | apikeys |
| Singular | apikey |
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
Spec
customerID: string
description: string
enabled: boolean
generateDistinctID: boolean
name: string
stageKeys:
- restAPIID: string
stageName: string
tags: {}
value:
key: string
name: string
namespace: string
| Field | Description |
|---|---|
| customerID Optional | string An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. |
| description Optional | string The description of the ApiKey. |
| enabled Optional | boolean Specifies whether the ApiKey can be used by callers. |
| generateDistinctID Optional | boolean Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used. |
| name Required | string The name of the ApiKey. |
| stageKeys Optional | array DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. |
| stageKeys.[] Required | object A reference to a unique stage identified in the format {restApiId}/{stage}. |
| stageKeys.[].stageName Optional | string |
| 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. |
| value Optional | object Specifies a value of the API key. |
| value.key Required | string Key is the key within the secret |
| value.name Optional | string name is unique within a namespace to reference a secret resource. |
| value.namespace Optional | string namespace defines the space within which the secret name must be unique. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdDate: string
id: 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. |
| 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 API Key was created. |
| id Optional | string The identifier of the API Key. |
| lastUpdatedDate Optional | string The timestamp when the API Key was last updated. |