RestAPI is the Schema for the RestAPIs API. Manages an API Gateway REST API.
Type
CRD
Group
apigateway.aws.upbound.io
Version
v1beta1
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: RestAPI
RestAPISpec defines the desired state of RestAPI
No description provided.
List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-binary-media-types extension. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
Configuration block defining API endpoint configuration including endpoint type. Defined below.
List of endpoint types. This resource currently only supports managing a single value. Valid values: EDGE, REGIONAL or PRIVATE. If unspecified, defaults to EDGE. Must be declared as REGIONAL in non-Commercial partitions. If set to PRIVATE recommend to set put_rest_api_mode = merge to not cause the endpoints and associated Route53 records to be deleted. Refer to the documentation for more information on the difference between edge-optimized and regional APIs.
Set of VPC Endpoint identifiers. It is only supported for PRIVATE endpoint type. If importing an OpenAPI specification via the body argument, this corresponds to the x-amazon-apigateway-endpoint-configuration extension vpcEndpointIds property. If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value.
ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.
Policies for referencing.
ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
Policies for referencing.
PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.
WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.
RestAPIStatus defines the observed state of RestAPI.
No description provided.
Conditions of the resource.
mydemoapi
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: RestAPI
metadata:
labels:
testing.upbound.io/example-name: integration
name: mydemoapi
spec:
forProvider:
description: This is my API for demonstration purposes
name: MyDemoAPI
region: us-west-1
test-demo
apiVersion: apigateway.aws.upbound.io/v1beta1
kind: RestAPI
metadata:
labels:
testing.upbound.io/example-name: stage
name: test-demo
spec:
forProvider:
body: >-
${jsonencode({
openapi = "3.0.1"
info = {
title = "example"
version = "1.0"
}
paths = {
"/path1" = {
get = {
x-amazon-apigateway-integration = {
httpMethod = "GET"
payloadFormatVersion = "1.0"
type = "HTTP_PROXY"
uri = "https://ip-ranges.amazonaws.com/ip-ranges.json"
}
}
}
}
})}
name: test-demo
region: us-west-1
© 2022 Upbound, Inc.
Discover the building blocksfor your internal cloud platform.