Google Native

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

ApiProduct

Creates an API product in an organization. You create API products after you have proxied backend services using API proxies. An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata can include: - Scope - Environments - API proxies - Extensible profile API products enable you repackage APIs on the fly, without having to do any additional coding or configuration. Apigee recommends that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs. After you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product. WARNING: - If you don’t specify an API proxy in the request body, any app associated with the product can make calls to any API in your entire organization. - If you don’t specify an environment in the request body, the product allows access to all environments. For more information, see What is an API product?

Create a ApiProduct Resource

new ApiProduct(name: string, args: ApiProductArgs, opts?: CustomResourceOptions);
@overload
def ApiProduct(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_resources: Optional[Sequence[str]] = None,
               approval_type: Optional[str] = None,
               attributes: Optional[Sequence[GoogleCloudApigeeV1AttributeArgs]] = None,
               created_at: Optional[str] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               environments: Optional[Sequence[str]] = None,
               graphql_operation_group: Optional[GoogleCloudApigeeV1GraphQLOperationGroupArgs] = None,
               last_modified_at: Optional[str] = None,
               name: Optional[str] = None,
               operation_group: Optional[GoogleCloudApigeeV1OperationGroupArgs] = None,
               organization_id: Optional[str] = None,
               proxies: Optional[Sequence[str]] = None,
               quota: Optional[str] = None,
               quota_interval: Optional[str] = None,
               quota_time_unit: Optional[str] = None,
               scopes: Optional[Sequence[str]] = None)
@overload
def ApiProduct(resource_name: str,
               args: ApiProductArgs,
               opts: Optional[ResourceOptions] = None)
func NewApiProduct(ctx *Context, name string, args ApiProductArgs, opts ...ResourceOption) (*ApiProduct, error)
public ApiProduct(string name, ApiProductArgs args, CustomResourceOptions? opts = null)
public ApiProduct(String name, ApiProductArgs args)
public ApiProduct(String name, ApiProductArgs args, CustomResourceOptions options)
type: google-native:apigee/v1:ApiProduct
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ApiProductArgs
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 ApiProductArgs
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 ApiProductArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiProductArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApiProductArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApiProduct 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 ApiProduct resource accepts the following input properties:

OrganizationId string
ApiResources List<string>

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

ApprovalType string

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1AttributeArgs>

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

CreatedAt string

Response only. Creation time of this environment as milliseconds since epoch.

Description string

Description of the API product. Include key information about the API product that is not captured by other fields.

DisplayName string

Name displayed in the UI or developer portal to developers registering for API access.

Environments List<string>

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

GraphqlOperationGroup Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1GraphQLOperationGroupArgs

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

LastModifiedAt string

Response only. Modified time of this environment as milliseconds since epoch.

Name string

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

OperationGroup Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1OperationGroupArgs

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

Proxies List<string>

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

Quota string

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

QuotaInterval string

Time interval over which the number of request messages is calculated.

QuotaTimeUnit string

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

Scopes List<string>

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

OrganizationId string
ApiResources []string

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

ApprovalType string

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

Attributes []GoogleCloudApigeeV1AttributeArgs

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

CreatedAt string

Response only. Creation time of this environment as milliseconds since epoch.

Description string

Description of the API product. Include key information about the API product that is not captured by other fields.

DisplayName string

Name displayed in the UI or developer portal to developers registering for API access.

Environments []string

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

GraphqlOperationGroup GoogleCloudApigeeV1GraphQLOperationGroupArgs

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

LastModifiedAt string

Response only. Modified time of this environment as milliseconds since epoch.

Name string

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

OperationGroup GoogleCloudApigeeV1OperationGroupArgs

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

Proxies []string

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

Quota string

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

QuotaInterval string

Time interval over which the number of request messages is calculated.

QuotaTimeUnit string

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

Scopes []string

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

organizationId String
apiResources List<String>

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

approvalType String

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

attributes List<GoogleCloudApigeeV1AttributeArgs>

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

createdAt String

Response only. Creation time of this environment as milliseconds since epoch.

description String

Description of the API product. Include key information about the API product that is not captured by other fields.

displayName String

Name displayed in the UI or developer portal to developers registering for API access.

environments List<String>

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

graphqlOperationGroup GoogleCloudApigeeV1GraphQLOperationGroupArgs

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

lastModifiedAt String

Response only. Modified time of this environment as milliseconds since epoch.

name String

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

operationGroup GoogleCloudApigeeV1OperationGroupArgs

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

proxies List<String>

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

quota String

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

quotaInterval String

Time interval over which the number of request messages is calculated.

quotaTimeUnit String

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

scopes List<String>

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

organizationId string
apiResources string[]

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

approvalType string

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

attributes GoogleCloudApigeeV1AttributeArgs[]

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

createdAt string

Response only. Creation time of this environment as milliseconds since epoch.

description string

Description of the API product. Include key information about the API product that is not captured by other fields.

displayName string

Name displayed in the UI or developer portal to developers registering for API access.

environments string[]

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

graphqlOperationGroup GoogleCloudApigeeV1GraphQLOperationGroupArgs

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

lastModifiedAt string

Response only. Modified time of this environment as milliseconds since epoch.

name string

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

operationGroup GoogleCloudApigeeV1OperationGroupArgs

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

proxies string[]

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

quota string

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

quotaInterval string

Time interval over which the number of request messages is calculated.

quotaTimeUnit string

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

scopes string[]

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

organization_id str
api_resources Sequence[str]

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

approval_type str

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

attributes Sequence[GoogleCloudApigeeV1AttributeArgs]

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

created_at str

Response only. Creation time of this environment as milliseconds since epoch.

description str

Description of the API product. Include key information about the API product that is not captured by other fields.

display_name str

Name displayed in the UI or developer portal to developers registering for API access.

environments Sequence[str]

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

graphql_operation_group GoogleCloudApigeeV1GraphQLOperationGroupArgs

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

last_modified_at str

Response only. Modified time of this environment as milliseconds since epoch.

name str

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

operation_group GoogleCloudApigeeV1OperationGroupArgs

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

proxies Sequence[str]

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

quota str

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

quota_interval str

Time interval over which the number of request messages is calculated.

quota_time_unit str

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

scopes Sequence[str]

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

organizationId String
apiResources List<String>

Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the proxy.pathsuffix variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the apiResources element is defined to be /forecastrss and the base path defined for the API proxy is /weather, then only requests to /weather/forecastrss are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - /**: Indicates that all sub-URIs are included. - /* : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is /v1/weatherapikey, then the API product supports requests to /v1/weatherapikey and to any sub-URIs, such as /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA, and so on. For more information, see Managing API products.

approvalType String

Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to manual, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to auto, the consumer key is generated and returned in "approved" state and can be used immediately. Note: Typically, auto is used to provide access to free or trial API products that provide limited quota or capabilities.

attributes List<Property Map>

Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either public, private, or internal. Only products marked public are available to developers in the Apigee developer portal. For example, you can set a product to internal while it is in development and then change access to public when it is ready to release on the portal. API products marked as private do not appear on the portal, but can be accessed by external developers.

createdAt String

Response only. Creation time of this environment as milliseconds since epoch.

description String

Description of the API product. Include key information about the API product that is not captured by other fields.

displayName String

Name displayed in the UI or developer portal to developers registering for API access.

environments List<String>

Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in prod from being accessed by API proxies deployed in test.

graphqlOperationGroup Property Map

Configuration used to group Apigee proxies or remote services with graphQL operation name, graphQL operation type and quotas. This grouping allows us to precisely set quota for a particular combination of graphQL name and operation type for a particular proxy request. If graphQL name is not set, this would imply quota will be applied on all graphQL requests matching the operation type.

lastModifiedAt String

Response only. Modified time of this environment as milliseconds since epoch.

name String

Internal name of the API product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. Note: The internal name cannot be edited when updating the API product.

operationGroup Property Map

Configuration used to group Apigee proxies or remote services with resources, method types, and quotas. The resource refers to the resource URI (excluding the base path). With this grouping, the API product creator is able to fine-tune and give precise control over which REST methods have access to specific resources and how many calls can be made (using the quota setting). Note: The api_resources setting cannot be specified for both the API product and operation group; otherwise the call will fail.

proxies List<String>

Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. Note: The API proxy names must already exist in the specified environment as they will be validated upon creation.

quota String

Number of request messages permitted per app by this API product for the specified quotaInterval and quotaTimeUnit. For example, a quota of 50, for a quotaInterval of 12 and a quotaTimeUnit of hours means 50 requests are allowed every 12 hours.

quotaInterval String

Time interval over which the number of request messages is calculated.

quotaTimeUnit String

Time unit defined for the quotaInterval. Valid values include minute, hour, day, or month.

scopes List<String>

Comma-separated list of OAuth scopes that are validated at runtime. Apigee validates that the scopes in any access token presented match the scopes defined in the OAuth policy associated with the API product.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudApigeeV1Attribute

Name string

API key of the attribute.

Value string

Value of the attribute.

Name string

API key of the attribute.

Value string

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

name string

API key of the attribute.

value string

Value of the attribute.

name str

API key of the attribute.

value str

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

GoogleCloudApigeeV1AttributeResponse

Name string

API key of the attribute.

Value string

Value of the attribute.

Name string

API key of the attribute.

Value string

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

name string

API key of the attribute.

value string

Value of the attribute.

name str

API key of the attribute.

value str

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

GoogleCloudApigeeV1GraphQLOperation

OperationTypes List<string>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

Operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

OperationTypes []string

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

Operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes List<String>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation String

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes string[]

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operation_types Sequence[str]

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation str

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes List<String>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation String

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

GoogleCloudApigeeV1GraphQLOperationConfig

ApiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

Operations List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1GraphQLOperation>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Attribute>

Custom attributes associated with the operation.

Quota Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

ApiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

Operations []GoogleCloudApigeeV1GraphQLOperation

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

Attributes []GoogleCloudApigeeV1Attribute

Custom attributes associated with the operation.

Quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

operations List<GoogleCloudApigeeV1GraphQLOperation>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

attributes List<GoogleCloudApigeeV1Attribute>

Custom attributes associated with the operation.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

operations GoogleCloudApigeeV1GraphQLOperation[]

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

attributes GoogleCloudApigeeV1Attribute[]

Custom attributes associated with the operation.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

api_source str

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

operations Sequence[GoogleCloudApigeeV1GraphQLOperation]

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

attributes Sequence[GoogleCloudApigeeV1Attribute]

Custom attributes associated with the operation.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

operations List<Property Map>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

attributes List<Property Map>

Custom attributes associated with the operation.

quota Property Map

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

GoogleCloudApigeeV1GraphQLOperationConfigResponse

ApiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1AttributeResponse>

Custom attributes associated with the operation.

Operations List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1GraphQLOperationResponse>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

Quota Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

ApiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

Attributes []GoogleCloudApigeeV1AttributeResponse

Custom attributes associated with the operation.

Operations []GoogleCloudApigeeV1GraphQLOperationResponse

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

Quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

attributes List<GoogleCloudApigeeV1AttributeResponse>

Custom attributes associated with the operation.

operations List<GoogleCloudApigeeV1GraphQLOperationResponse>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource string

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

attributes GoogleCloudApigeeV1AttributeResponse[]

Custom attributes associated with the operation.

operations GoogleCloudApigeeV1GraphQLOperationResponse[]

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

api_source str

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

attributes Sequence[GoogleCloudApigeeV1AttributeResponse]

Custom attributes associated with the operation.

operations Sequence[GoogleCloudApigeeV1GraphQLOperationResponse]

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy endpoint or remote service with which the GraphQL operation and quota are associated.

attributes List<Property Map>

Custom attributes associated with the operation.

operations List<Property Map>

List of GraphQL name/operation type pairs for the proxy or remote service to which quota will be applied. If only operation types are specified, the quota will be applied to all GraphQL requests irrespective of the GraphQL name. Note: Currently, you can specify only a single GraphQLOperation. Specifying more than one will cause the operation to fail.

quota Property Map

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

GoogleCloudApigeeV1GraphQLOperationGroup

OperationConfigs List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1GraphQLOperationConfig>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs []GoogleCloudApigeeV1GraphQLOperationConfig

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<GoogleCloudApigeeV1GraphQLOperationConfig>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs GoogleCloudApigeeV1GraphQLOperationConfig[]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operation_configs Sequence[GoogleCloudApigeeV1GraphQLOperationConfig]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operation_config_type str

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<Property Map>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

GoogleCloudApigeeV1GraphQLOperationGroupResponse

OperationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1GraphQLOperationConfigResponse>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs []GoogleCloudApigeeV1GraphQLOperationConfigResponse

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<GoogleCloudApigeeV1GraphQLOperationConfigResponse>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType string

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs GoogleCloudApigeeV1GraphQLOperationConfigResponse[]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operation_config_type str

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operation_configs Sequence[GoogleCloudApigeeV1GraphQLOperationConfigResponse]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifies whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<Property Map>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

GoogleCloudApigeeV1GraphQLOperationResponse

Operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

OperationTypes List<string>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

Operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

OperationTypes []string

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation String

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes List<String>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation string

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes string[]

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation str

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operation_types Sequence[str]

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

operation String

GraphQL operation name. The name and operation type will be used to apply quotas. If no name is specified, the quota will be applied to all GraphQL operations irrespective of their operation names in the payload.

operationTypes List<String>

GraphQL operation types. Valid values include query or mutation. Note: Apigee does not currently support subscription types.

GoogleCloudApigeeV1Operation

Resource string

REST resource path associated with the API proxy or remote service.

Methods List<string>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

Resource string

REST resource path associated with the API proxy or remote service.

Methods []string

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource String

REST resource path associated with the API proxy or remote service.

methods List<String>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource string

REST resource path associated with the API proxy or remote service.

methods string[]

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource str

REST resource path associated with the API proxy or remote service.

methods Sequence[str]

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource String

REST resource path associated with the API proxy or remote service.

methods List<String>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

GoogleCloudApigeeV1OperationConfig

ApiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Attribute>

Custom attributes associated with the operation.

Operations List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Operation>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

Quota Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

ApiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

Attributes []GoogleCloudApigeeV1Attribute

Custom attributes associated with the operation.

Operations []GoogleCloudApigeeV1Operation

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

Quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes List<GoogleCloudApigeeV1Attribute>

Custom attributes associated with the operation.

operations List<GoogleCloudApigeeV1Operation>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes GoogleCloudApigeeV1Attribute[]

Custom attributes associated with the operation.

operations GoogleCloudApigeeV1Operation[]

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

api_source str

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes Sequence[GoogleCloudApigeeV1Attribute]

Custom attributes associated with the operation.

operations Sequence[GoogleCloudApigeeV1Operation]

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1Quota

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes List<Property Map>

Custom attributes associated with the operation.

operations List<Property Map>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota Property Map

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

GoogleCloudApigeeV1OperationConfigResponse

ApiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1AttributeResponse>

Custom attributes associated with the operation.

Operations List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1OperationResponse>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

Quota Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

ApiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

Attributes []GoogleCloudApigeeV1AttributeResponse

Custom attributes associated with the operation.

Operations []GoogleCloudApigeeV1OperationResponse

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

Quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes List<GoogleCloudApigeeV1AttributeResponse>

Custom attributes associated with the operation.

operations List<GoogleCloudApigeeV1OperationResponse>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource string

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes GoogleCloudApigeeV1AttributeResponse[]

Custom attributes associated with the operation.

operations GoogleCloudApigeeV1OperationResponse[]

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

api_source str

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes Sequence[GoogleCloudApigeeV1AttributeResponse]

Custom attributes associated with the operation.

operations Sequence[GoogleCloudApigeeV1OperationResponse]

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota GoogleCloudApigeeV1QuotaResponse

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

apiSource String

Name of the API proxy or remote service with which the resources, methods, and quota are associated.

attributes List<Property Map>

Custom attributes associated with the operation.

operations List<Property Map>

List of resource/method pairs for the API proxy or remote service to which quota will applied. Note: Currently, you can specify only a single resource/method pair. The call will fail if more than one resource/method pair is provided.

quota Property Map

Quota parameters to be enforced for the resources, methods, and API source combination. If none are specified, quota enforcement will not be done.

GoogleCloudApigeeV1OperationGroup

OperationConfigs List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1OperationConfig>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs []GoogleCloudApigeeV1OperationConfig

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<GoogleCloudApigeeV1OperationConfig>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs GoogleCloudApigeeV1OperationConfig[]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operation_configs Sequence[GoogleCloudApigeeV1OperationConfig]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operation_config_type str

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<Property Map>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

GoogleCloudApigeeV1OperationGroupResponse

OperationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1OperationConfigResponse>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

OperationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

OperationConfigs []GoogleCloudApigeeV1OperationConfigResponse

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<GoogleCloudApigeeV1OperationConfigResponse>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType string

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs GoogleCloudApigeeV1OperationConfigResponse[]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operation_config_type str

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operation_configs Sequence[GoogleCloudApigeeV1OperationConfigResponse]

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

operationConfigType String

Flag that specifes whether the configuration is for Apigee API proxy or a remote service. Valid values include proxy or remoteservice. Defaults to proxy. Set to proxy when Apigee API proxies are associated with the API product. Set to remoteservice when non-Apigee proxies like Istio-Envoy are associated with the API product.

operationConfigs List<Property Map>

List of operation configurations for either Apigee API proxies or other remote services that are associated with this API product.

GoogleCloudApigeeV1OperationResponse

Methods List<string>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

Resource string

REST resource path associated with the API proxy or remote service.

Methods []string

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

Resource string

REST resource path associated with the API proxy or remote service.

methods List<String>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource String

REST resource path associated with the API proxy or remote service.

methods string[]

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource string

REST resource path associated with the API proxy or remote service.

methods Sequence[str]

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource str

REST resource path associated with the API proxy or remote service.

methods List<String>

methods refers to the REST verbs as in https://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html. When none specified, all verb types are allowed.

resource String

REST resource path associated with the API proxy or remote service.

GoogleCloudApigeeV1Quota

Interval string

Time interval over which the number of request messages is calculated.

Limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

TimeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

Interval string

Time interval over which the number of request messages is calculated.

Limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

TimeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval String

Time interval over which the number of request messages is calculated.

limit String

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit String

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval string

Time interval over which the number of request messages is calculated.

limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval str

Time interval over which the number of request messages is calculated.

limit str

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

time_unit str

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval String

Time interval over which the number of request messages is calculated.

limit String

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit String

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

GoogleCloudApigeeV1QuotaResponse

Interval string

Time interval over which the number of request messages is calculated.

Limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

TimeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

Interval string

Time interval over which the number of request messages is calculated.

Limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

TimeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval String

Time interval over which the number of request messages is calculated.

limit String

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit String

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval string

Time interval over which the number of request messages is calculated.

limit string

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit string

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval str

Time interval over which the number of request messages is calculated.

limit str

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

time_unit str

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

interval String

Time interval over which the number of request messages is calculated.

limit String

Upper limit allowed for the time interval and time unit specified. Requests exceeding this limit will be rejected.

timeUnit String

Time unit defined for the interval. Valid values include minute, hour, day, or month. If limit and interval are valid, the default value is hour; otherwise, the default is null.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0