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

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

google-native.apigee/v1.Appgroup

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

Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup’s state is set as active.

Create Appgroup Resource

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

Constructor syntax

new Appgroup(name: string, args: AppgroupArgs, opts?: CustomResourceOptions);
@overload
def Appgroup(resource_name: str,
             args: AppgroupArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Appgroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             organization_id: Optional[str] = None,
             attributes: Optional[Sequence[GoogleCloudApigeeV1AttributeArgs]] = None,
             channel_id: Optional[str] = None,
             channel_uri: Optional[str] = None,
             display_name: Optional[str] = None,
             name: Optional[str] = None,
             organization: Optional[str] = None)
func NewAppgroup(ctx *Context, name string, args AppgroupArgs, opts ...ResourceOption) (*Appgroup, error)
public Appgroup(string name, AppgroupArgs args, CustomResourceOptions? opts = null)
public Appgroup(String name, AppgroupArgs args)
public Appgroup(String name, AppgroupArgs args, CustomResourceOptions options)
type: google-native:apigee/v1:Appgroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. AppgroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. AppgroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. AppgroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. AppgroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AppgroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var appgroupResource = new GoogleNative.Apigee.V1.Appgroup("appgroupResource", new()
{
    OrganizationId = "string",
    Attributes = new[]
    {
        new GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1AttributeArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ChannelId = "string",
    ChannelUri = "string",
    DisplayName = "string",
    Name = "string",
    Organization = "string",
});
Copy
example, err := apigee.NewAppgroup(ctx, "appgroupResource", &apigee.AppgroupArgs{
	OrganizationId: pulumi.String("string"),
	Attributes: apigee.GoogleCloudApigeeV1AttributeArray{
		&apigee.GoogleCloudApigeeV1AttributeArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ChannelId:    pulumi.String("string"),
	ChannelUri:   pulumi.String("string"),
	DisplayName:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Organization: pulumi.String("string"),
})
Copy
var appgroupResource = new Appgroup("appgroupResource", AppgroupArgs.builder()
    .organizationId("string")
    .attributes(GoogleCloudApigeeV1AttributeArgs.builder()
        .name("string")
        .value("string")
        .build())
    .channelId("string")
    .channelUri("string")
    .displayName("string")
    .name("string")
    .organization("string")
    .build());
Copy
appgroup_resource = google_native.apigee.v1.Appgroup("appgroupResource",
    organization_id="string",
    attributes=[{
        "name": "string",
        "value": "string",
    }],
    channel_id="string",
    channel_uri="string",
    display_name="string",
    name="string",
    organization="string")
Copy
const appgroupResource = new google_native.apigee.v1.Appgroup("appgroupResource", {
    organizationId: "string",
    attributes: [{
        name: "string",
        value: "string",
    }],
    channelId: "string",
    channelUri: "string",
    displayName: "string",
    name: "string",
    organization: "string",
});
Copy
type: google-native:apigee/v1:Appgroup
properties:
    attributes:
        - name: string
          value: string
    channelId: string
    channelUri: string
    displayName: string
    name: string
    organization: string
    organizationId: string
Copy

Appgroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Appgroup resource accepts the following input properties:

OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Attributes List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1Attribute>
A list of attributes
ChannelId string
channel identifier identifies the owner maintaing this grouping.
ChannelUri string
A reference to the associated storefront/marketplace.
DisplayName string
app group name displayed in the UI
Name string
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
Organization string
Immutable. the org the app group is created
OrganizationId
This property is required.
Changes to this property will trigger replacement.
string
Attributes []GoogleCloudApigeeV1AttributeArgs
A list of attributes
ChannelId string
channel identifier identifies the owner maintaing this grouping.
ChannelUri string
A reference to the associated storefront/marketplace.
DisplayName string
app group name displayed in the UI
Name string
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
Organization string
Immutable. the org the app group is created
organizationId
This property is required.
Changes to this property will trigger replacement.
String
attributes List<GoogleCloudApigeeV1Attribute>
A list of attributes
channelId String
channel identifier identifies the owner maintaing this grouping.
channelUri String
A reference to the associated storefront/marketplace.
displayName String
app group name displayed in the UI
name String
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
organization String
Immutable. the org the app group is created
organizationId
This property is required.
Changes to this property will trigger replacement.
string
attributes GoogleCloudApigeeV1Attribute[]
A list of attributes
channelId string
channel identifier identifies the owner maintaing this grouping.
channelUri string
A reference to the associated storefront/marketplace.
displayName string
app group name displayed in the UI
name string
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
organization string
Immutable. the org the app group is created
organization_id
This property is required.
Changes to this property will trigger replacement.
str
attributes Sequence[GoogleCloudApigeeV1AttributeArgs]
A list of attributes
channel_id str
channel identifier identifies the owner maintaing this grouping.
channel_uri str
A reference to the associated storefront/marketplace.
display_name str
app group name displayed in the UI
name str
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
organization str
Immutable. the org the app group is created
organizationId
This property is required.
Changes to this property will trigger replacement.
String
attributes List<Property Map>
A list of attributes
channelId String
channel identifier identifies the owner maintaing this grouping.
channelUri String
A reference to the associated storefront/marketplace.
displayName String
app group name displayed in the UI
name String
Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
organization String
Immutable. the org the app group is created

Outputs

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

AppGroupId string
Internal identifier that cannot be edited
CreatedAt string
Created time as milliseconds since epoch.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedAt string
Modified time as milliseconds since epoch.
Status string
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.
AppGroupId string
Internal identifier that cannot be edited
CreatedAt string
Created time as milliseconds since epoch.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedAt string
Modified time as milliseconds since epoch.
Status string
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.
appGroupId String
Internal identifier that cannot be edited
createdAt String
Created time as milliseconds since epoch.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedAt String
Modified time as milliseconds since epoch.
status String
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.
appGroupId string
Internal identifier that cannot be edited
createdAt string
Created time as milliseconds since epoch.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedAt string
Modified time as milliseconds since epoch.
status string
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.
app_group_id str
Internal identifier that cannot be edited
created_at str
Created time as milliseconds since epoch.
id str
The provider-assigned unique ID for this managed resource.
last_modified_at str
Modified time as milliseconds since epoch.
status str
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.
appGroupId String
Internal identifier that cannot be edited
createdAt String
Created time as milliseconds since epoch.
id String
The provider-assigned unique ID for this managed resource.
lastModifiedAt String
Modified time as milliseconds since epoch.
status String
Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.

Supporting Types

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 This property is required. string
API key of the attribute.
Value This property is required. string
Value of the attribute.
Name This property is required. string
API key of the attribute.
Value This property is required. string
Value of the attribute.
name This property is required. String
API key of the attribute.
value This property is required. String
Value of the attribute.
name This property is required. string
API key of the attribute.
value This property is required. string
Value of the attribute.
name This property is required. str
API key of the attribute.
value This property is required. str
Value of the attribute.
name This property is required. String
API key of the attribute.
value This property is required. String
Value of the attribute.

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