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

ApiArgs

data class ApiArgs(val apiId: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val managedService: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ApiArgs>

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

Constructors

Link copied to clipboard
constructor(apiId: Output<String>? = null, displayName: Output<String>? = null, labels: Output<Map<String, String>>? = null, managedService: Output<String>? = null, project: Output<String>? = null)

Properties

Link copied to clipboard
val apiId: Output<String>? = null

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

Link copied to clipboard
val displayName: Output<String>? = null

A user-visible name for the API.

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

Resource labels to represent user-provided metadata.

Link copied to clipboard
val managedService: Output<String>? = null

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 project: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): ApiArgs