@pulumi/gcp/apigee/api.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * To get more information about API proxies see, see:
 *
 * * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.apis)
 * * How-to Guides
 *   * [API proxies](https://cloud.google.com/apigee/docs/resources)
 *
 * ## Import
 *
 * An API proxy can be imported using any of these accepted formats:
 *
 * * `{{org_id}}/apis/{{name}}`
 *
 * * `{{org_id}}/{{name}}`
 *
 * When using the `pulumi import` command, API proxy can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:apigee/api:Api default {{org_id}}/apis/{{name}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:apigee/api:Api default {{org_id}}/{{name}}
 * ```
 */
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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApiState, 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;
    /**
     * Path to the config zip bundle.
     *
     * - - -
     */
    readonly configBundle: pulumi.Output<string>;
    readonly detectMd5hash: pulumi.Output<string | undefined>;
    /**
     * The id of the most recently created revision for this API proxy.
     */
    readonly latestRevisionId: pulumi.Output<string>;
    /**
     * (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
     */
    readonly md5hash: pulumi.Output<string>;
    /**
     * Metadata describing the API proxy.
     * Structure is documented below.
     */
    readonly metaDatas: pulumi.Output<outputs.apigee.ApiMetaData[]>;
    /**
     * The ID of the API proxy.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The Apigee Organization name associated with the Apigee instance.
     */
    readonly orgId: pulumi.Output<string>;
    /**
     * A list of revisions of this API proxy.
     */
    readonly revisions: pulumi.Output<string[]>;
    /**
     * 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);
}
/**
 * Input properties used for looking up and filtering Api resources.
 */
export interface ApiState {
    /**
     * Path to the config zip bundle.
     *
     * - - -
     */
    configBundle?: pulumi.Input<string>;
    detectMd5hash?: pulumi.Input<string>;
    /**
     * The id of the most recently created revision for this API proxy.
     */
    latestRevisionId?: pulumi.Input<string>;
    /**
     * (Computed) Base 64 MD5 hash of the uploaded data. It is speculative as remote does not return hash of the bundle. Remote changes are detected using returned lastModified timestamp.
     */
    md5hash?: pulumi.Input<string>;
    /**
     * Metadata describing the API proxy.
     * Structure is documented below.
     */
    metaDatas?: pulumi.Input<pulumi.Input<inputs.apigee.ApiMetaData>[]>;
    /**
     * The ID of the API proxy.
     */
    name?: pulumi.Input<string>;
    /**
     * The Apigee Organization name associated with the Apigee instance.
     */
    orgId?: pulumi.Input<string>;
    /**
     * A list of revisions of this API proxy.
     */
    revisions?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a Api resource.
 */
export interface ApiArgs {
    /**
     * Path to the config zip bundle.
     *
     * - - -
     */
    configBundle: pulumi.Input<string>;
    detectMd5hash?: pulumi.Input<string>;
    /**
     * The ID of the API proxy.
     */
    name?: pulumi.Input<string>;
    /**
     * The Apigee Organization name associated with the Apigee instance.
     */
    orgId: pulumi.Input<string>;
}