pulumi-gcp-kotlin/com.pulumi.gcp.apigateway.kotlin/Api

Api

class Api : KotlinCustomResource

A consumable API that can be used by multiple Gateways. To get more information about Api, see:

Example Usage

Apigateway Api Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.apigateway.Api;
import com.pulumi.gcp.apigateway.ApiArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var api = new Api("api", ApiArgs.builder()
            .apiId("my-api")
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
    }
}
Content copied to clipboard

Import

Api can be imported using any of these accepted formats

$ pulumi import gcp:apigateway/api:Api default projects/{{project}}/locations/global/apis/{{api_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/api:Api default {{project}}/{{api_id}}
Content copied to clipboard
$ pulumi import gcp:apigateway/api:Api default {{api_id}}
Content copied to clipboard

Properties

Link copied to clipboard
val apiId: Output<String>

Identifier to assign to the API. Must be unique within scope of the parent resource(project)

Link copied to clipboard
val createTime: Output<String>

Creation timestamp in RFC3339 text format.

Link copied to clipboard
val displayName: Output<String>

A user-visible name for the API.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val labels: Output<Map<String, String>>?

Resource labels to represent user-provided metadata.

Link copied to clipboard
val managedService: Output<String>

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.

Link copied to clipboard
val name: Output<String>

The resource name of the API. Format projects/{{project}}/locations/global/apis/{{apiId}}

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>