Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

Api

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

Create a 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,
        location: Optional[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)
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.

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:

ApiId 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 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 string
ApiId 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 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 string
apiId 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 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 String
apiId 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 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 string
api_id 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 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 str
apiId 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 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 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
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0