Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1beta
  6. Api

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigateway/v1beta.Api

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a new Api in a given project and location. Auto-naming is currently not supported for this resource.

Create Api Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
        args: ApiArgs,
        opts: Optional[ResourceOptions] = None)

@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,
        location: Optional[str] = None,
        managed_service: Optional[str] = None,
        project: Optional[str] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)

type: google-native:apigateway/v1beta:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var google_nativeApiResource = new GoogleNative.APIGateway.V1Beta.Api("google-nativeApiResource", new()
{
    ApiId = "string",
    DisplayName = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Location = "string",
    ManagedService = "string",
    Project = "string",
});
Copy
example, err := apigatewayv1beta.NewApi(ctx, "google-nativeApiResource", &apigatewayv1beta.ApiArgs{
	ApiId:       pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Location:       pulumi.String("string"),
	ManagedService: pulumi.String("string"),
	Project:        pulumi.String("string"),
})
Copy
var google_nativeApiResource = new Api("google-nativeApiResource", ApiArgs.builder()
    .apiId("string")
    .displayName("string")
    .labels(Map.of("string", "string"))
    .location("string")
    .managedService("string")
    .project("string")
    .build());
Copy
google_native_api_resource = google_native.apigateway.v1beta.Api("google-nativeApiResource",
    api_id="string",
    display_name="string",
    labels={
        "string": "string",
    },
    location="string",
    managed_service="string",
    project="string")
Copy
const google_nativeApiResource = new google_native.apigateway.v1beta.Api("google-nativeApiResource", {
    apiId: "string",
    displayName: "string",
    labels: {
        string: "string",
    },
    location: "string",
    managedService: "string",
    project: "string",
});
Copy
type: google-native:apigateway/v1beta:Api
properties:
    apiId: string
    displayName: string
    labels:
        string: string
    location: string
    managedService: string
    project: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Api resource accepts the following input properties:

ApiId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
DisplayName string
Optional. Display name.
Labels Dictionary<string, string>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
Location Changes to this property will trigger replacement. string
ManagedService string
Optional. 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 Changes to this property will trigger replacement. string
ApiId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
DisplayName string
Optional. Display name.
Labels map[string]string
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
Location Changes to this property will trigger replacement. string
ManagedService string
Optional. 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 Changes to this property will trigger replacement. string
apiId
This property is required.
Changes to this property will trigger replacement.
String
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
displayName String
Optional. Display name.
labels Map<String,String>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. String
managedService String
Optional. 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 Changes to this property will trigger replacement. String
apiId
This property is required.
Changes to this property will trigger replacement.
string
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
displayName string
Optional. Display name.
labels {[key: string]: string}
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. string
managedService string
Optional. 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 Changes to this property will trigger replacement. string
api_id
This property is required.
Changes to this property will trigger replacement.
str
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
display_name str
Optional. Display name.
labels Mapping[str, str]
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. str
managed_service str
Optional. 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 Changes to this property will trigger replacement. str
apiId
This property is required.
Changes to this property will trigger replacement.
String
Required. Identifier to assign to the API. Must be unique within scope of the parent resource.
displayName String
Optional. Display name.
labels Map<String>
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
location Changes to this property will trigger replacement. String
managedService String
Optional. 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 Changes to this property will trigger replacement. String

Outputs

All input properties are implicitly available as output properties. Additionally, the Api resource produces the following output properties:

CreateTime string
Created time.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
State string
State of the API.
UpdateTime string
Updated time.
CreateTime string
Created time.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
State string
State of the API.
UpdateTime string
Updated time.
createTime String
Created time.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
state String
State of the API.
updateTime String
Updated time.
createTime string
Created time.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
state string
State of the API.
updateTime string
Updated time.
create_time str
Created time.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
state str
State of the API.
update_time str
Updated time.
createTime String
Created time.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
state String
State of the API.
updateTime String
Updated time.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native