1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. App

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

google-native.apigee/v1.App

Explore with Pulumi AI

google-native logo

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

    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)
    public App(String name, AppArgs args)
    public App(String name, AppArgs args, CustomResourceOptions options)
    
    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:

    DeveloperId string

    ID of the developer.

    OrganizationId string
    ApiProducts List<string>

    List of API products associated with the developer app.

    AppFamily string

    Developer app family.

    AppId string

    ID of the developer app.

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

    List of attributes for the developer app.

    CallbackUrl string

    Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.

    KeyExpiresIn string

    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 or revoked.

    DeveloperId string

    ID of the developer.

    OrganizationId string
    ApiProducts []string

    List of API products associated with the developer app.

    AppFamily string

    Developer app family.

    AppId string

    ID of the developer app.

    Attributes []GoogleCloudApigeeV1AttributeArgs

    List of attributes for the developer app.

    CallbackUrl string

    Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.

    KeyExpiresIn string

    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 or revoked.

    developerId String

    ID of the developer.

    organizationId String
    apiProducts List<String>

    List of API products associated with the developer app.

    appFamily String

    Developer app family.

    appId String

    ID of the developer app.

    attributes List<GoogleCloudApigeeV1Attribute>

    List of attributes for the developer app.

    callbackUrl String

    Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.

    keyExpiresIn String

    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 or revoked.

    developerId string

    ID of the developer.

    organizationId string
    apiProducts string[]

    List of API products associated with the developer app.

    appFamily string

    Developer app family.

    appId string

    ID of the developer app.

    attributes GoogleCloudApigeeV1Attribute[]

    List of attributes for the developer app.

    callbackUrl string

    Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.

    keyExpiresIn string

    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 or revoked.

    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[GoogleCloudApigeeV1AttributeArgs]

    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_in str

    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 or revoked.

    developerId String

    ID of the developer.

    organizationId String
    apiProducts List<String>

    List of API products associated with the developer app.

    appFamily String

    Developer app family.

    appId String

    ID of the developer app.

    attributes List<Property Map>

    List of attributes for the developer app.

    callbackUrl String

    Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.

    keyExpiresIn String

    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 or revoked.

    Outputs

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

    CreatedAt string

    Time the developer app was created in milliseconds since epoch.

    Credentials List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1CredentialResponse>

    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.

    LastModifiedAt string

    Time the developer app was modified in milliseconds since epoch.

    CreatedAt string

    Time the developer app was created in milliseconds since epoch.

    Credentials []GoogleCloudApigeeV1CredentialResponse

    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.

    LastModifiedAt string

    Time the developer app was modified in milliseconds since epoch.

    createdAt String

    Time the developer app was created in milliseconds since epoch.

    credentials List<GoogleCloudApigeeV1CredentialResponse>

    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.

    lastModifiedAt String

    Time the developer app was modified in milliseconds since epoch.

    createdAt string

    Time the developer app was created in milliseconds since epoch.

    credentials GoogleCloudApigeeV1CredentialResponse[]

    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.

    lastModifiedAt string

    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[GoogleCloudApigeeV1CredentialResponse]

    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_at str

    Time the developer app was modified in milliseconds since epoch.

    createdAt 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.

    lastModifiedAt String

    Time the developer app was modified in milliseconds since epoch.

    Supporting Types

    GoogleCloudApigeeV1ApiProductRefResponse, GoogleCloudApigeeV1ApiProductRefResponseArgs

    Apiproduct string

    Name of the API product.

    Status string

    Status of the API product. Valid values are approved or revoked.

    Apiproduct string

    Name of the API product.

    Status string

    Status of the API product. Valid values are approved or revoked.

    apiproduct String

    Name of the API product.

    status String

    Status of the API product. Valid values are approved or revoked.

    apiproduct string

    Name of the API product.

    status string

    Status of the API product. Valid values are approved or revoked.

    apiproduct str

    Name of the API product.

    status str

    Status of the API product. Valid values are approved or revoked.

    apiproduct String

    Name of the API product.

    status String

    Status of the API product. Valid values are approved or revoked.

    GoogleCloudApigeeV1Attribute, GoogleCloudApigeeV1AttributeArgs

    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, GoogleCloudApigeeV1AttributeResponseArgs

    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.

    GoogleCloudApigeeV1CredentialResponse, GoogleCloudApigeeV1CredentialResponseArgs

    ApiProducts List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ApiProductRefResponse>

    List of API products this credential can be used for.

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

    List of attributes associated with this credential.

    ConsumerKey string

    Consumer key.

    ConsumerSecret string

    Secret key.

    ExpiresAt string

    Time the credential will expire in milliseconds since epoch.

    IssuedAt 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 or revoked.

    ApiProducts []GoogleCloudApigeeV1ApiProductRefResponse

    List of API products this credential can be used for.

    Attributes []GoogleCloudApigeeV1AttributeResponse

    List of attributes associated with this credential.

    ConsumerKey string

    Consumer key.

    ConsumerSecret string

    Secret key.

    ExpiresAt string

    Time the credential will expire in milliseconds since epoch.

    IssuedAt 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 or revoked.

    apiProducts List<GoogleCloudApigeeV1ApiProductRefResponse>

    List of API products this credential can be used for.

    attributes List<GoogleCloudApigeeV1AttributeResponse>

    List of attributes associated with this credential.

    consumerKey String

    Consumer key.

    consumerSecret String

    Secret key.

    expiresAt String

    Time the credential will expire in milliseconds since epoch.

    issuedAt 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 or revoked.

    apiProducts GoogleCloudApigeeV1ApiProductRefResponse[]

    List of API products this credential can be used for.

    attributes GoogleCloudApigeeV1AttributeResponse[]

    List of attributes associated with this credential.

    consumerKey string

    Consumer key.

    consumerSecret string

    Secret key.

    expiresAt string

    Time the credential will expire in milliseconds since epoch.

    issuedAt 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 or revoked.

    api_products Sequence[GoogleCloudApigeeV1ApiProductRefResponse]

    List of API products this credential can be used for.

    attributes Sequence[GoogleCloudApigeeV1AttributeResponse]

    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 or revoked.

    apiProducts List<Property Map>

    List of API products this credential can be used for.

    attributes List<Property Map>

    List of attributes associated with this credential.

    consumerKey String

    Consumer key.

    consumerSecret String

    Secret key.

    expiresAt String

    Time the credential will expire in milliseconds since epoch.

    issuedAt 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 or revoked.

    Package Details

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

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

    Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi