Google Cloud Native v0.32.0, Nov 29 23

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.AppGroupApp

Explore with Pulumi AI

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

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

Creates an app and associates it with an AppGroup. This API associates the AppGroup 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. Auto-naming is currently not supported for this resource.

Create AppGroupApp Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AppGroupApp(name: string, args: AppGroupAppArgs, opts?: CustomResourceOptions);

@overload
def AppGroupApp(resource_name: str,
                args: AppGroupAppArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AppGroupApp(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                appgroup_id: Optional[str] = None,
                organization_id: Optional[str] = None,
                api_products: Optional[Sequence[str]] = None,
                app_group: Optional[str] = None,
                app_id: Optional[str] = None,
                attributes: Optional[Sequence[GoogleCloudApigeeV1AttributeArgs]] = None,
                callback_url: Optional[str] = None,
                key_expires_in: Optional[str] = None,
                name: Optional[str] = None,
                scopes: Optional[Sequence[str]] = None,
                status: Optional[str] = None)

func NewAppGroupApp(ctx *Context, name string, args AppGroupAppArgs, opts ...ResourceOption) (*AppGroupApp, error)

public AppGroupApp(string name, AppGroupAppArgs args, CustomResourceOptions? opts = null)

public AppGroupApp(String name, AppGroupAppArgs args)
public AppGroupApp(String name, AppGroupAppArgs args, CustomResourceOptions options)

type: google-native:apigee/v1:AppGroupApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

name string: The unique name of the resource.
args AppGroupAppArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AppGroupAppArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

var appGroupAppResource = new GoogleNative.Apigee.V1.AppGroupApp("appGroupAppResource", new()
{
    AppgroupId = "string",
    OrganizationId = "string",
    ApiProducts = new[]
    {
        "string",
    },
    AppGroup = "string",
    AppId = "string",
    Attributes = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1AttributeArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    CallbackUrl = "string",
    KeyExpiresIn = "string",
    Name = "string",
    Scopes = new[]
    {
        "string",
    },
    Status = "string",
});

example, err := apigee.NewAppGroupApp(ctx, "appGroupAppResource", &apigee.AppGroupAppArgs{
AppgroupId: pulumi.String("string"),
OrganizationId: pulumi.String("string"),
ApiProducts: pulumi.StringArray{
pulumi.String("string"),
},
AppGroup: pulumi.String("string"),
AppId: pulumi.String("string"),
Attributes: apigee.GoogleCloudApigeeV1AttributeArray{
&apigee.GoogleCloudApigeeV1AttributeArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
CallbackUrl: pulumi.String("string"),
KeyExpiresIn: pulumi.String("string"),
Name: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
Status: pulumi.String("string"),
})

var appGroupAppResource = new AppGroupApp("appGroupAppResource", AppGroupAppArgs.builder()        
    .appgroupId("string")
    .organizationId("string")
    .apiProducts("string")
    .appGroup("string")
    .appId("string")
    .attributes(GoogleCloudApigeeV1AttributeArgs.builder()
        .name("string")
        .value("string")
        .build())
    .callbackUrl("string")
    .keyExpiresIn("string")
    .name("string")
    .scopes("string")
    .status("string")
    .build());

app_group_app_resource = google_native.apigee.v1.AppGroupApp("appGroupAppResource",
    appgroup_id="string",
    organization_id="string",
    api_products=["string"],
    app_group="string",
    app_id="string",
    attributes=[google_native.apigee.v1.GoogleCloudApigeeV1AttributeArgs(
        name="string",
        value="string",
    )],
    callback_url="string",
    key_expires_in="string",
    name="string",
    scopes=["string"],
    status="string")

const appGroupAppResource = new google_native.apigee.v1.AppGroupApp("appGroupAppResource", {
    appgroupId: "string",
    organizationId: "string",
    apiProducts: ["string"],
    appGroup: "string",
    appId: "string",
    attributes: [{
        name: "string",
        value: "string",
    }],
    callbackUrl: "string",
    keyExpiresIn: "string",
    name: "string",
    scopes: ["string"],
    status: "string",
});

type: google-native:apigee/v1:AppGroupApp
properties:
    apiProducts:
        - string
    appGroup: string
    appId: string
    appgroupId: string
    attributes:
        - name: string
          value: string
    callbackUrl: string
    keyExpiresIn: string
    name: string
    organizationId: string
    scopes:
        - string
    status: string

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

AppgroupId string
OrganizationId string
ApiProducts List<string>: List of API products associated with the AppGroup app.
AppGroup string: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
AppId string: Immutable. ID of the AppGroup app.
Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Attribute>: List of attributes for the AppGroup app.
CallbackUrl string: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
KeyExpiresIn string: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
Scopes List<string>: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
Status string: Status of the App. Valid values include approved or revoked.

AppgroupId string
OrganizationId string
ApiProducts []string: List of API products associated with the AppGroup app.
AppGroup string: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
AppId string: Immutable. ID of the AppGroup app.
Attributes []GoogleCloudApigeeV1AttributeArgs: List of attributes for the AppGroup app.
CallbackUrl string: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
KeyExpiresIn string: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
Scopes []string: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
Status string: Status of the App. Valid values include approved or revoked.

appgroupId String
organizationId String
apiProducts List<String>: List of API products associated with the AppGroup app.
appGroup String: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
appId String: Immutable. ID of the AppGroup app.
attributes List<GoogleCloudApigeeV1Attribute>: List of attributes for the AppGroup app.
callbackUrl String: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
keyExpiresIn String: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
scopes List<String>: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status String: Status of the App. Valid values include approved or revoked.

appgroupId string
organizationId string
apiProducts string[]: List of API products associated with the AppGroup app.
appGroup string: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
appId string: Immutable. ID of the AppGroup app.
attributes GoogleCloudApigeeV1Attribute[]: List of attributes for the AppGroup app.
callbackUrl string: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
keyExpiresIn string: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
scopes string[]: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status string: Status of the App. Valid values include approved or revoked.

appgroup_id str
organization_id str
api_products Sequence[str]: List of API products associated with the AppGroup app.
app_group str: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
app_id str: Immutable. ID of the AppGroup app.
attributes Sequence[GoogleCloudApigeeV1AttributeArgs]: List of attributes for the AppGroup app.
callback_url str: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
key_expires_in str: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
scopes Sequence[str]: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status str: Status of the App. Valid values include approved or revoked.

appgroupId String
organizationId String
apiProducts List<String>: List of API products associated with the AppGroup app.
appGroup String: Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
appId String: Immutable. ID of the AppGroup app.
attributes List<Property Map>: List of attributes for the AppGroup app.
callbackUrl String: Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
keyExpiresIn String: Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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: Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
scopes List<String>: Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status String: Status of the App. Valid values include approved or revoked.

Outputs

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

CreatedAt string: Time the AppGroup app was created in milliseconds since epoch.
Credentials List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1CredentialResponse>: Set of credentials for the AppGroup 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 AppGroup app was modified in milliseconds since epoch.

CreatedAt string: Time the AppGroup app was created in milliseconds since epoch.
Credentials []GoogleCloudApigeeV1CredentialResponse: Set of credentials for the AppGroup 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 AppGroup app was modified in milliseconds since epoch.

createdAt String: Time the AppGroup app was created in milliseconds since epoch.
credentials List<GoogleCloudApigeeV1CredentialResponse>: Set of credentials for the AppGroup 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 AppGroup app was modified in milliseconds since epoch.

createdAt string: Time the AppGroup app was created in milliseconds since epoch.
credentials GoogleCloudApigeeV1CredentialResponse[]: Set of credentials for the AppGroup 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 AppGroup app was modified in milliseconds since epoch.

created_at str: Time the AppGroup app was created in milliseconds since epoch.
credentials Sequence[GoogleCloudApigeeV1CredentialResponse]: Set of credentials for the AppGroup 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 AppGroup app was modified in milliseconds since epoch.

createdAt String: Time the AppGroup app was created in milliseconds since epoch.
credentials List<Property Map>: Set of credentials for the AppGroup 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 AppGroup 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 Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.apigee/v1.AppGroupApp

On this page

On this page

Create AppGroupApp Resource

Constructor syntax

Parameters

Example

AppGroupApp Resource Properties

Inputs

Outputs

Supporting Types

GoogleCloudApigeeV1ApiProductRefResponse, GoogleCloudApigeeV1ApiProductRefResponseArgs

GoogleCloudApigeeV1Attribute, GoogleCloudApigeeV1AttributeArgs

GoogleCloudApigeeV1AttributeResponse, GoogleCloudApigeeV1AttributeResponseArgs

GoogleCloudApigeeV1CredentialResponse, GoogleCloudApigeeV1CredentialResponseArgs

Package Details

On this page

On this page