Google Cloud Native v0.30.0, Apr 14 23
Google Cloud Native v0.30.0, Apr 14 23
google-native.apigee/v1.App
Explore with Pulumi AI
Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The name
is the unique ID of the app that you can use in API calls. The DisplayName
(set as an attribute) appears in the UI. If you don’t set the DisplayName
attribute, the name
appears in the UI.
Create App Resource
new App(name: string, args: AppArgs, opts?: CustomResourceOptions);
@overload
def App(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_products: Optional[Sequence[str]] = None,
app_family: Optional[str] = None,
app_id: Optional[str] = None,
attributes: Optional[Sequence[GoogleCloudApigeeV1AttributeArgs]] = None,
callback_url: Optional[str] = None,
developer_id: Optional[str] = None,
key_expires_in: Optional[str] = None,
name: Optional[str] = None,
organization_id: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
status: Optional[str] = None)
@overload
def App(resource_name: str,
args: AppArgs,
opts: Optional[ResourceOptions] = None)
func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs args, CustomResourceOptions? opts = null)
type: google-native:apigee/v1:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppArgs
- 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 AppArgs
- 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 AppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
App 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 App resource accepts the following input properties:
- Developer
Id string ID of the developer.
- Organization
Id string - Api
Products List<string> List of API products associated with the developer app.
- App
Family string Developer app family.
- App
Id string ID of the developer app.
- Attributes
List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Args> List of attributes for the developer app.
- Callback
Url string Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Key
Expires stringIn Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- Name string
Name of the developer app.
- Scopes List<string>
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
Status of the credential. Valid values include
approved
orrevoked
.
- Developer
Id string ID of the developer.
- Organization
Id string - Api
Products []string List of API products associated with the developer app.
- App
Family string Developer app family.
- App
Id string ID of the developer app.
- Attributes
[]Google
Cloud Apigee V1Attribute Args List of attributes for the developer app.
- Callback
Url string Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Key
Expires stringIn Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- Name string
Name of the developer app.
- Scopes []string
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
Status of the credential. Valid values include
approved
orrevoked
.
- developer
Id String ID of the developer.
- organization
Id String - api
Products List<String> List of API products associated with the developer app.
- app
Family String Developer app family.
- app
Id String ID of the developer app.
- attributes
List<Google
Cloud Apigee V1Attribute Args> List of attributes for the developer app.
- callback
Url String Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- key
Expires StringIn Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- name String
Name of the developer app.
- scopes List<String>
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
Status of the credential. Valid values include
approved
orrevoked
.
- developer
Id string ID of the developer.
- organization
Id string - api
Products string[] List of API products associated with the developer app.
- app
Family string Developer app family.
- app
Id string ID of the developer app.
- attributes
Google
Cloud Apigee V1Attribute Args[] List of attributes for the developer app.
- callback
Url string Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- key
Expires stringIn Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- name string
Name of the developer app.
- scopes string[]
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status string
Status of the credential. Valid values include
approved
orrevoked
.
- developer_
id str ID of the developer.
- organization_
id str - api_
products Sequence[str] List of API products associated with the developer app.
- app_
family str Developer app family.
- app_
id str ID of the developer app.
- attributes
Sequence[Google
Cloud Apigee V1Attribute Args] List of attributes for the developer app.
- callback_
url str Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- key_
expires_ strin Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- name str
Name of the developer app.
- scopes Sequence[str]
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status str
Status of the credential. Valid values include
approved
orrevoked
.
- developer
Id String ID of the developer.
- organization
Id String - api
Products List<String> List of API products associated with the developer app.
- app
Family String Developer app family.
- app
Id String ID of the developer app.
- attributes List<Property Map>
List of attributes for the developer app.
- callback
Url String Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- key
Expires StringIn Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of
-1
, the API key never expires. The expiration time can't be updated after it is set.- name String
Name of the developer app.
- scopes List<String>
Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
Status of the credential. Valid values include
approved
orrevoked
.
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
- Created
At string Time the developer app was created in milliseconds since epoch.
- Credentials
List<Pulumi.
Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Credential Response> Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Time the developer app was modified in milliseconds since epoch.
- Created
At string Time the developer app was created in milliseconds since epoch.
- Credentials
[]Google
Cloud Apigee V1Credential Response Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Time the developer app was modified in milliseconds since epoch.
- created
At String Time the developer app was created in milliseconds since epoch.
- credentials
List<Google
Cloud Apigee V1Credential Response> Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt Time the developer app was modified in milliseconds since epoch.
- created
At string Time the developer app was created in milliseconds since epoch.
- credentials
Google
Cloud Apigee V1Credential Response[] Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- id string
The provider-assigned unique ID for this managed resource.
- last
Modified stringAt Time the developer app was modified in milliseconds since epoch.
- created_
at str Time the developer app was created in milliseconds since epoch.
- credentials
Sequence[Google
Cloud Apigee V1Credential Response] Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- id str
The provider-assigned unique ID for this managed resource.
- last_
modified_ strat Time the developer app was modified in milliseconds since epoch.
- created
At String Time the developer app was created in milliseconds since epoch.
- credentials List<Property Map>
Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt Time the developer app was modified in milliseconds since epoch.
Supporting Types
GoogleCloudApigeeV1ApiProductRefResponse
- Apiproduct string
Name of the API product.
- Status string
Status of the API product. Valid values are
approved
orrevoked
.
- Apiproduct string
Name of the API product.
- Status string
Status of the API product. Valid values are
approved
orrevoked
.
- apiproduct String
Name of the API product.
- status String
Status of the API product. Valid values are
approved
orrevoked
.
- apiproduct string
Name of the API product.
- status string
Status of the API product. Valid values are
approved
orrevoked
.
- apiproduct str
Name of the API product.
- status str
Status of the API product. Valid values are
approved
orrevoked
.
- apiproduct String
Name of the API product.
- status String
Status of the API product. Valid values are
approved
orrevoked
.
GoogleCloudApigeeV1Attribute
GoogleCloudApigeeV1AttributeResponse
GoogleCloudApigeeV1CredentialResponse
- Api
Products List<Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Api Product Ref Response> List of API products this credential can be used for.
- Attributes
List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Attribute Response> List of attributes associated with this credential.
- Consumer
Key string Consumer key.
- Consumer
Secret string Secret key.
- Expires
At string Time the credential will expire in milliseconds since epoch.
- Issued
At string Time the credential was issued in milliseconds since epoch.
- Scopes List<string>
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- Status string
Status of the credential. Valid values include
approved
orrevoked
.
- Api
Products []GoogleCloud Apigee V1Api Product Ref Response List of API products this credential can be used for.
- Attributes
[]Google
Cloud Apigee V1Attribute Response List of attributes associated with this credential.
- Consumer
Key string Consumer key.
- Consumer
Secret string Secret key.
- Expires
At string Time the credential will expire in milliseconds since epoch.
- Issued
At string Time the credential was issued in milliseconds since epoch.
- Scopes []string
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- Status string
Status of the credential. Valid values include
approved
orrevoked
.
- api
Products List<GoogleCloud Apigee V1Api Product Ref Response> List of API products this credential can be used for.
- attributes
List<Google
Cloud Apigee V1Attribute Response> List of attributes associated with this credential.
- consumer
Key String Consumer key.
- consumer
Secret String Secret key.
- expires
At String Time the credential will expire in milliseconds since epoch.
- issued
At String Time the credential was issued in milliseconds since epoch.
- scopes List<String>
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- status String
Status of the credential. Valid values include
approved
orrevoked
.
- api
Products GoogleCloud Apigee V1Api Product Ref Response[] List of API products this credential can be used for.
- attributes
Google
Cloud Apigee V1Attribute Response[] List of attributes associated with this credential.
- consumer
Key string Consumer key.
- consumer
Secret string Secret key.
- expires
At string Time the credential will expire in milliseconds since epoch.
- issued
At string Time the credential was issued in milliseconds since epoch.
- scopes string[]
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- status string
Status of the credential. Valid values include
approved
orrevoked
.
- api_
products Sequence[GoogleCloud Apigee V1Api Product Ref Response] List of API products this credential can be used for.
- attributes
Sequence[Google
Cloud Apigee V1Attribute Response] List of attributes associated with this credential.
- consumer_
key str Consumer key.
- consumer_
secret str Secret key.
- expires_
at str Time the credential will expire in milliseconds since epoch.
- issued_
at str Time the credential was issued in milliseconds since epoch.
- scopes Sequence[str]
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- status str
Status of the credential. Valid values include
approved
orrevoked
.
- api
Products List<Property Map> List of API products this credential can be used for.
- attributes List<Property Map>
List of attributes associated with this credential.
- consumer
Key String Consumer key.
- consumer
Secret String Secret key.
- expires
At String Time the credential will expire in milliseconds since epoch.
- issued
At String Time the credential was issued in milliseconds since epoch.
- scopes List<String>
List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
- status String
Status of the credential. Valid values include
approved
orrevoked
.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0