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 Gateway, 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 * * ## Import * * Gateway can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{region}}/gateways/{{gateway_id}}` * * `{{project}}/{{region}}/{{gateway_id}}` * * `{{region}}/{{gateway_id}}` * * `{{gateway_id}}` * * When using the `pulumi import` command, Gateway can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigateway/gateway:Gateway default projects/{{project}}/locations/{{region}}/gateways/{{gateway_id}} * $ pulumi import gcp:apigateway/gateway:Gateway default {{project}}/{{region}}/{{gateway_id}} * $ pulumi import gcp:apigateway/gateway:Gateway default {{region}}/{{gateway_id}} * $ pulumi import gcp:apigateway/gateway:Gateway default {{gateway_id}} * ``` */ export declare class Gateway extends pulumi.CustomResource { /** * Get an existing Gateway 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?: GatewayState, opts?: pulumi.CustomResourceOptions): Gateway; /** * Returns true if the given object is an instance of Gateway. 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 Gateway; /** * Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. * When changing api configs please ensure the new config is a new resource and the * lifecycle rule `createBeforeDestroy` is set. */ readonly apiConfig: pulumi.Output; /** * The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev. */ readonly defaultHostname: 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; }>; /** * Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project). */ readonly gatewayId: pulumi.Output; /** * 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>; /** * Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway} */ 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; }>; /** * The region of the gateway for the API. */ readonly region: pulumi.Output; /** * Create a Gateway 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: GatewayArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Gateway resources. */ export interface GatewayState { /** * Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. * When changing api configs please ensure the new config is a new resource and the * lifecycle rule `createBeforeDestroy` is set. */ apiConfig?: pulumi.Input; /** * The default API Gateway host name of the form {gatewayId}-{hash}.{region_code}.gateway.dev. */ defaultHostname?: 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; }>; /** * Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project). */ gatewayId?: 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; }>; /** * Resource name of the Gateway. Format: projects/{project}/locations/{region}/gateways/{gateway} */ 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 region of the gateway for the API. */ region?: pulumi.Input; } /** * The set of arguments for constructing a Gateway resource. */ export interface GatewayArgs { /** * Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}. * When changing api configs please ensure the new config is a new resource and the * lifecycle rule `createBeforeDestroy` is set. */ apiConfig: pulumi.Input; /** * A user-visible name for the API. */ displayName?: pulumi.Input; /** * Identifier to assign to the Gateway. Must be unique within scope of the parent resource(project). */ gatewayId: 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; }>; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The region of the gateway for the API. */ region?: pulumi.Input; }