RestAPI

apigateway.services.k8s.aws/v1alpha1

Metadata#

Represents a REST API.

Spec#

apiKeySource: string
binaryMediaTypes:
- string
cloneFrom: string
cloneFromRef: 
  from: 
    name: string
    namespace: string
description: string
disableExecuteAPIEndpoint: boolean
endpointAccessMode: string
endpointConfiguration: 
  ipAddressType: string
  types:
  - string
  vpcEndpointIDs:
  - string
  vpcEndpointRefs:
    from: 
      name: string
      namespace: string
minimumCompressionSize: integer
name: string
policy: string
securityPolicy: string
tags: {}
version: string

from:
  name: my-api || **endpointConfiguration.vpcEndpointRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| endpointConfiguration.vpcEndpointRefs.[].from.name
Optional | string
| | endpointConfiguration.vpcEndpointRefs.[].from.namespace
Optional | string
| | minimumCompressionSize
Optional | integer
A nullable integer that is used to enable compression (with non-negative
between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with
a null value) on an API. When compression is enabled, compression or decompression
is not applied on the payload if the payload size is smaller than this value.
Setting it to zero allows compression for any payload size. | | name
Required | string
The name of the RestApi. | | policy
Optional | string
A stringified JSON policy document that applies to this RestApi regardless
of the caller and Method configuration. | | securityPolicy
Optional | string
The Transport Layer Security (TLS) version + cipher suite for this RestApi. | | 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. | | version
Optional | string
A version identifier for the API. |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
apiStatus: string
apiStatusMessage: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdDate: string
id: string
rootResourceID: string
warnings:
- string