Files
pulumi-crds/generated/crds/gateway/v1alpha2/grpcroute.d.ts
2025-11-24 08:22:20 +00:00

91 lines
5.2 KiB
TypeScript

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* GRPCRoute provides a way to route gRPC requests. This includes the capability
* to match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.
* Filters can be used to specify additional processing steps. Backends specify
* where matching requests will be routed.
*
* GRPCRoute falls under extended support within the Gateway API. Within the
* following specification, the word "MUST" indicates that an implementation
* supporting GRPCRoute must conform to the indicated requirement, but an
* implementation not supporting this route type need not follow the requirement
* unless explicitly indicated.
*
* Implementations supporting `GRPCRoute` with the `HTTPS` `ProtocolType` MUST
* accept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. via
* ALPN. If the implementation does not support this, then it MUST set the
* "Accepted" condition to "False" for the affected listener with a reason of
* "UnsupportedProtocol". Implementations MAY also accept HTTP/2 connections
* with an upgrade from HTTP/1.
*
* Implementations supporting `GRPCRoute` with the `HTTP` `ProtocolType` MUST
* support HTTP/2 over cleartext TCP (h2c,
* https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initial
* upgrade from HTTP/1.1, i.e. with prior knowledge
* (https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementation
* does not support this, then it MUST set the "Accepted" condition to "False"
* for the affected listener with a reason of "UnsupportedProtocol".
* Implementations MAY also accept HTTP/2 connections with an upgrade from
* HTTP/1, i.e. without prior knowledge.
*/
export declare class GRPCRoute extends pulumi.CustomResource {
/**
* Get an existing GRPCRoute resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): GRPCRoute;
/** @internal */
static readonly __pulumiType = "kubernetes:gateway.networking.k8s.io/v1alpha2:GRPCRoute";
/**
* Returns true if the given object is an instance of GRPCRoute. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is GRPCRoute;
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
readonly apiVersion: pulumi.Output<"gateway.networking.k8s.io/v1alpha2">;
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
readonly kind: pulumi.Output<"GRPCRoute">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
readonly metadata: pulumi.Output<outputs.meta.v1.ObjectMeta>;
readonly spec: pulumi.Output<outputs.gateway.v1alpha2.GRPCRouteSpec>;
readonly status: pulumi.Output<outputs.gateway.v1alpha2.GRPCRouteStatus>;
/**
* Create a GRPCRoute resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: GRPCRouteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a GRPCRoute resource.
*/
export interface GRPCRouteArgs {
/**
* APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
*/
apiVersion?: pulumi.Input<"gateway.networking.k8s.io/v1alpha2">;
/**
* Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
*/
kind?: pulumi.Input<"GRPCRoute">;
/**
* Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
*/
metadata?: pulumi.Input<inputs.meta.v1.ObjectMeta>;
spec?: pulumi.Input<inputs.gateway.v1alpha2.GRPCRouteSpec>;
}