import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * An API Configuration is an association of an API Controller Config and a Gateway Config * * > **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 ApiConfig, see: * * * [API documentation](https://cloud.google.com/api-gateway/docs/reference/rest/v1beta/projects.locations.apis.configs) * * How-to Guides * * [Official Documentation](https://cloud.google.com/api-gateway/docs/creating-api-config) * * ## Example Usage * * ## Import * * ApiConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}}` * * `{{project}}/{{api}}/{{api_config_id}}` * * `{{api}}/{{api_config_id}}` * * When using the `pulumi import` command, ApiConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:apigateway/apiConfig:ApiConfig default projects/{{project}}/locations/global/apis/{{api}}/configs/{{api_config_id}} * $ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{project}}/{{api}}/{{api_config_id}} * $ pulumi import gcp:apigateway/apiConfig:ApiConfig default {{api}}/{{api_config_id}} * ``` */ export declare class ApiConfig extends pulumi.CustomResource { /** * Get an existing ApiConfig 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?: ApiConfigState, opts?: pulumi.CustomResourceOptions): ApiConfig; /** * Returns true if the given object is an instance of ApiConfig. 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 ApiConfig; /** * The API to attach the config to. */ readonly api: pulumi.Output; /** * Identifier to assign to the API Config. Must be unique within scope of the parent resource(api). */ readonly apiConfigId: pulumi.Output; /** * Creates a unique name beginning with the * specified prefix. If this and apiConfigId are unspecified, a random value is chosen for the name. */ readonly apiConfigIdPrefix: 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; }>; /** * Immutable. Gateway specific configuration. * If not specified, backend authentication will be set to use OIDC authentication using the default compute service account * Structure is documented below. */ readonly gatewayConfig: pulumi.Output; /** * gRPC service definition files. If specified, openapiDocuments must not be included. * Structure is documented below. */ readonly grpcServices: 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>; /** * Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. * If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. * Structure is documented below. */ readonly managedServiceConfigs: pulumi.Output; /** * The resource name of the API Config. */ readonly name: pulumi.Output; /** * OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. * Structure is documented below. */ readonly openapiDocuments: 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 ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config). */ readonly serviceConfigId: pulumi.Output; /** * Create a ApiConfig 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: ApiConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ApiConfig resources. */ export interface ApiConfigState { /** * The API to attach the config to. */ api?: pulumi.Input; /** * Identifier to assign to the API Config. Must be unique within scope of the parent resource(api). */ apiConfigId?: pulumi.Input; /** * Creates a unique name beginning with the * specified prefix. If this and apiConfigId are unspecified, a random value is chosen for the name. */ apiConfigIdPrefix?: 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; }>; /** * Immutable. Gateway specific configuration. * If not specified, backend authentication will be set to use OIDC authentication using the default compute service account * Structure is documented below. */ gatewayConfig?: pulumi.Input; /** * gRPC service definition files. If specified, openapiDocuments must not be included. * Structure is documented below. */ grpcServices?: 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; }>; /** * Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. * If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. * Structure is documented below. */ managedServiceConfigs?: pulumi.Input[]>; /** * The resource name of the API Config. */ name?: pulumi.Input; /** * OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. * Structure is documented below. */ openapiDocuments?: 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 ID of the associated Service Config (https://cloud.google.com/service-infrastructure/docs/glossary#config). */ serviceConfigId?: pulumi.Input; } /** * The set of arguments for constructing a ApiConfig resource. */ export interface ApiConfigArgs { /** * The API to attach the config to. */ api: pulumi.Input; /** * Identifier to assign to the API Config. Must be unique within scope of the parent resource(api). */ apiConfigId?: pulumi.Input; /** * Creates a unique name beginning with the * specified prefix. If this and apiConfigId are unspecified, a random value is chosen for the name. */ apiConfigIdPrefix?: pulumi.Input; /** * A user-visible name for the API. */ displayName?: pulumi.Input; /** * Immutable. Gateway specific configuration. * If not specified, backend authentication will be set to use OIDC authentication using the default compute service account * Structure is documented below. */ gatewayConfig?: pulumi.Input; /** * gRPC service definition files. If specified, openapiDocuments must not be included. * Structure is documented below. */ grpcServices?: 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; }>; /** * Optional. Service Configuration files. At least one must be included when using gRPC service definitions. See https://cloud.google.com/endpoints/docs/grpc/grpc-service-config#service_configuration_overview for the expected file contents. * If multiple files are specified, the files are merged with the following rules: * All singular scalar fields are merged using "last one wins" semantics in the order of the files uploaded. * Repeated fields are concatenated. * Singular embedded messages are merged using these rules for nested fields. * Structure is documented below. */ managedServiceConfigs?: pulumi.Input[]>; /** * OpenAPI specification documents. If specified, grpcServices and managedServiceConfigs must not be included. * Structure is documented below. */ openapiDocuments?: 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; }