import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../../types/output"; /** * Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client. */ export declare class Api extends pulumi.CustomResource { /** * Get an existing Api 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, opts?: pulumi.CustomResourceOptions): Api; /** * Returns true if the given object is an instance of Api. 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 Api; /** * Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it. */ readonly action: pulumi.Output; /** * The type of the API proxy. */ readonly apiProxyType: pulumi.Output; /** * User labels applied to this API Proxy. */ readonly labels: pulumi.Output<{ [key: string]: string; }>; /** * The id of the most recently created revision for this api proxy. */ readonly latestRevisionId: pulumi.Output; /** * Metadata describing the API proxy. */ readonly metaData: pulumi.Output; /** * Name of the API proxy. Restrict the characters used to: A-Za-z0-9._- */ readonly name: pulumi.Output; readonly organizationId: pulumi.Output; /** * Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive. */ readonly readOnly: pulumi.Output; /** * List of revisions defined for the API proxy. */ readonly revision: pulumi.Output; /** * Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API. */ readonly validate: pulumi.Output; /** * Create a Api 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: ApiArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Api resource. */ export interface ApiArgs { /** * Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values: * `import` to import the API proxy configuration bundle. * `validate` to validate the API proxy configuration bundle without importing it. */ action?: pulumi.Input; /** * The HTTP Content-Type header value specifying the content type of the body. */ contentType?: pulumi.Input; /** * The HTTP request/response body as raw binary. */ data?: pulumi.Input; /** * Application specific response metadata. Must be set in the first response for streaming APIs. */ extensions?: pulumi.Input; }>[]>; /** * File to upload. */ file?: pulumi.Input; /** * Name of the API proxy. Restrict the characters used to: A-Za-z0-9._- */ name?: pulumi.Input; organizationId: pulumi.Input; /** * Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API. */ validate?: pulumi.Input; }