gcp.apigateway.Api
Explore with Pulumi AI
A consumable API that can be used by multiple Gateways.
To get more information about Api, see:
- API documentation
- How-to Guides
Example Usage
Apigateway Api Basic
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var api = new Gcp.ApiGateway.Api("api", new()
{
ApiId = "my-api",
}, new CustomResourceOptions
{
Provider = google_beta,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewApi(ctx, "api", &apigateway.ApiArgs{
ApiId: pulumi.String("my-api"),
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
return nil
})
}
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());
}
}
import pulumi
import pulumi_gcp as gcp
api = gcp.apigateway.Api("api", api_id="my-api",
opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const api = new gcp.apigateway.Api("api", {apiId: "my-api"}, {
provider: google_beta,
});
resources:
api:
type: gcp:apigateway:Api
properties:
apiId: my-api
options:
provider: ${["google-beta"]}
Create Api Resource
new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
display_name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
managed_service: Optional[str] = None,
project: Optional[str] = None)
@overload
def Api(resource_name: str,
args: ApiArgs,
opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
type: gcp:apigateway:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Api Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Api resource accepts the following input properties:
- Api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- Display
Name string A user-visible name for the API.
- Labels Dictionary<string, string>
Resource labels to represent user-provided metadata.
- Managed
Service 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.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- Display
Name string A user-visible name for the API.
- Labels map[string]string
Resource labels to represent user-provided metadata.
- Managed
Service 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.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id String Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- display
Name String A user-visible name for the API.
- labels Map<String,String>
Resource labels to represent user-provided metadata.
- managed
Service 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- display
Name string A user-visible name for the API.
- labels {[key: string]: string}
Resource labels to represent user-provided metadata.
- managed
Service 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.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api_
id str Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- display_
name str A user-visible name for the API.
- labels Mapping[str, str]
Resource labels to represent user-provided metadata.
- managed_
service str 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.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id String Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- display
Name String A user-visible name for the API.
- labels Map<String>
Resource labels to represent user-provided metadata.
- managed
Service 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:
- Create
Time string Creation timestamp in RFC3339 text format.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- Create
Time string Creation timestamp in RFC3339 text format.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- create
Time String Creation timestamp in RFC3339 text format.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- create
Time string Creation timestamp in RFC3339 text format.
- id string
The provider-assigned unique ID for this managed resource.
- name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- create_
time str Creation timestamp in RFC3339 text format.
- id str
The provider-assigned unique ID for this managed resource.
- name str
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- create
Time String Creation timestamp in RFC3339 text format.
- id String
The provider-assigned unique ID for this managed resource.
- name String
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
Look up Existing Api Resource
Get an existing Api resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ApiState, opts?: CustomResourceOptions): Api
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
create_time: Optional[str] = None,
display_name: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
managed_service: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None) -> Api
func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)
public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)
public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- Create
Time string Creation timestamp in RFC3339 text format.
- Display
Name string A user-visible name for the API.
- Labels Dictionary<string, string>
Resource labels to represent user-provided metadata.
- Managed
Service 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.
- Name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- Create
Time string Creation timestamp in RFC3339 text format.
- Display
Name string A user-visible name for the API.
- Labels map[string]string
Resource labels to represent user-provided metadata.
- Managed
Service 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.
- Name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id String Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- create
Time String Creation timestamp in RFC3339 text format.
- display
Name String A user-visible name for the API.
- labels Map<String,String>
Resource labels to represent user-provided metadata.
- managed
Service 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.
- name String
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id string Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- create
Time string Creation timestamp in RFC3339 text format.
- display
Name string A user-visible name for the API.
- labels {[key: string]: string}
Resource labels to represent user-provided metadata.
- managed
Service 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.
- name string
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api_
id str Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- create_
time str Creation timestamp in RFC3339 text format.
- display_
name str A user-visible name for the API.
- labels Mapping[str, str]
Resource labels to represent user-provided metadata.
- managed_
service str 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.
- name str
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- api
Id String Identifier to assign to the API. Must be unique within scope of the parent resource(project)
- create
Time String Creation timestamp in RFC3339 text format.
- display
Name String A user-visible name for the API.
- labels Map<String>
Resource labels to represent user-provided metadata.
- managed
Service 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.
- name String
The resource name of the API. Format
projects/{{project}}/locations/global/apis/{{apiId}}
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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}}
$ pulumi import gcp:apigateway/api:Api default {{project}}/{{api_id}}
$ pulumi import gcp:apigateway/api:Api default {{api_id}}
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.