import * as pulumi from "@pulumi/pulumi"; /** * A consumable API that can be used by multiple Gateways. * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * To get more information about Api, see: * * * [API documentation](https://cloud.google.com/api-gateway/docs/reference/rest/v1beta/projects.locations.apis) * * How-to Guides * * [Official Documentation](https://cloud.google.com/api-gateway/docs/quickstart) * * ## Example Usage * * ### Apigateway Api Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const api = new gcp.apigateway.Api("api", {apiId: "my-api"}); * ``` * * ## Import * * Api can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/global/apis/{{api_id}}` * * `{{project}}/{{api_id}}` * * `{{api_id}}` * * When using the `pulumi import` command, Api can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigateway/api:Api default projects/{{project}}/locations/global/apis/{{api_id}} * $ pulumi import gcp:apigateway/api:Api default {{project}}/{{api_id}} * $ pulumi import gcp:apigateway/api:Api default {{api_id}} * ``` */ 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, 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; /** * Identifier to assign to the API. Must be unique within scope of the parent resource(project) */ readonly apiId: pulumi.Output; /** * Creation timestamp in RFC3339 text format. */ readonly createTime: pulumi.Output; /** * A user-visible name for the API. */ readonly displayName: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * Resource labels to represent user-provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). * If not specified, a new Service will automatically be created in the same project as this API. */ readonly managedService: pulumi.Output; /** * The resource name of the API. Format `projects/{{project}}/locations/global/apis/{{apiId}}` */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: 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 { /** * Identifier to assign to the API. Must be unique within scope of the parent resource(project) */ apiId?: pulumi.Input; /** * Creation timestamp in RFC3339 text format. */ createTime?: pulumi.Input; /** * A user-visible name for the API. */ displayName?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Resource labels to represent user-provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). * If not specified, a new Service will automatically be created in the same project as this API. */ managedService?: pulumi.Input; /** * The resource name of the API. Format `projects/{{project}}/locations/global/apis/{{apiId}}` */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; } /** * The set of arguments for constructing a Api resource. */ export interface ApiArgs { /** * Identifier to assign to the API. Must be unique within scope of the parent resource(project) */ apiId: pulumi.Input; /** * A user-visible name for the API. */ displayName?: pulumi.Input; /** * Resource labels to represent user-provided metadata. * * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). * If not specified, a new Service will automatically be created in the same project as this API. */ managedService?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; }