Google Cloud Native v0.28.0, Feb 2 23

google-native.apigeeregistry/v1.Api

Creates a specified API.

Create Api Resource

new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);

@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        api_id: Optional[str] = None,
        availability: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        recommended_deployment: Optional[str] = None,
        recommended_version: 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:apigeeregistry/v1: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. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Annotations Dictionary<string, string>: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
Availability string: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
Description string: A detailed description.
DisplayName string: Human-meaningful name.
Labels Dictionary<string, string>: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
Location string
Name string: Resource name.
Project string
RecommendedDeployment string: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
RecommendedVersion string: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

ApiId string: Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
Annotations map[string]string: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
Availability string: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
Description string: A detailed description.
DisplayName string: Human-meaningful name.
Labels map[string]string: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
Location string
Name string: Resource name.
Project string
RecommendedDeployment string: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
RecommendedVersion string: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

apiId String: Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
annotations Map<String,String>: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
availability String: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
description String: A detailed description.
displayName String: Human-meaningful name.
labels Map<String,String>: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
location String
name String: Resource name.
project String
recommendedDeployment String: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommendedVersion String: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

apiId string: Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
annotations {[key: string]: string}: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
availability string: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
description string: A detailed description.
displayName string: Human-meaningful name.
labels {[key: string]: string}: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
location string
name string: Resource name.
project string
recommendedDeployment string: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommendedVersion string: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

api_id str: Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
annotations Mapping[str, str]: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
availability str: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
description str: A detailed description.
display_name str: Human-meaningful name.
labels Mapping[str, str]: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
location str
name str: Resource name.
project str
recommended_deployment str: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommended_version str: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

apiId String: Required. The ID to use for the API, which will become the final component of the API's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. Following AIP-162, IDs must not have the form of a UUID.
annotations Map<String>: Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.
availability String: A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
description String: A detailed description.
displayName String: Human-meaningful name.
labels Map<String>: Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.
location String
name String: Resource name.
project String
recommendedDeployment String: The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommendedVersion String: The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Outputs

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

CreateTime string: Creation timestamp.
Id string: The provider-assigned unique ID for this managed resource.
UpdateTime string: Last update timestamp.

CreateTime string: Creation timestamp.
Id string: The provider-assigned unique ID for this managed resource.
UpdateTime string: Last update timestamp.

createTime String: Creation timestamp.
id String: The provider-assigned unique ID for this managed resource.
updateTime String: Last update timestamp.

createTime string: Creation timestamp.
id string: The provider-assigned unique ID for this managed resource.
updateTime string: Last update timestamp.

create_time str: Creation timestamp.
id str: The provider-assigned unique ID for this managed resource.
update_time str: Last update timestamp.

createTime String: Creation timestamp.
id String: The provider-assigned unique ID for this managed resource.
updateTime String: Last update timestamp.

Package Details

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