@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
200 lines • 7.92 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.AppGroup = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* An `AppGroup` in Apigee.
*
* To get more information about AppGroup, see:
*
* * [API documentation](https://cloud.google.com/apigee/docs/reference/apis/apigee/rest/v1/organizations.appgroups)
* * How-to Guides
* * [Organizing client app ownership](https://cloud.google.com/apigee/docs/api-platform/publish/organizing-client-app-ownership)
*
* ## Example Usage
*
* ### Apigee App Group Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const current = gcp.organizations.getClientConfig({});
* const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
* const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
* name: "apigee-range",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 16,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* }, {
* dependsOn: [apigeeVpcConnection],
* });
* const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
* name: "instance",
* location: "us-central1",
* orgId: apigeeOrg.id,
* peeringCidrRange: "SLASH_22",
* });
* const apigeeAppGroup = new gcp.apigee.AppGroup("apigee_app_group", {
* name: "my-app-group",
* displayName: "Test app group",
* channelId: "storefront",
* channelUri: "https://my-dev-portal.org/groups/my-group",
* status: "active",
* orgId: apigeeOrg.id,
* }, {
* dependsOn: [apigeeInstance],
* });
* ```
* ### Apigee App Group With Attributes
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const current = gcp.organizations.getClientConfig({});
* const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
* const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
* name: "apigee-range",
* purpose: "VPC_PEERING",
* addressType: "INTERNAL",
* prefixLength: 16,
* network: apigeeNetwork.id,
* });
* const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
* network: apigeeNetwork.id,
* service: "servicenetworking.googleapis.com",
* reservedPeeringRanges: [apigeeRange.name],
* });
* const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
* analyticsRegion: "us-central1",
* projectId: current.then(current => current.project),
* authorizedNetwork: apigeeNetwork.id,
* }, {
* dependsOn: [apigeeVpcConnection],
* });
* const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
* name: "instance",
* location: "us-central1",
* orgId: apigeeOrg.id,
* peeringCidrRange: "SLASH_22",
* });
* const apigeeAppGroup = new gcp.apigee.AppGroup("apigee_app_group", {
* name: "my-app-group",
* displayName: "Test app group",
* channelId: "storefront",
* channelUri: "https://my-dev-portal.org/groups/my-group",
* status: "active",
* orgId: apigeeOrg.id,
* attributes: [
* {
* name: "business_unit",
* value: "HR",
* },
* {
* name: "department",
* value: "payroll",
* },
* ],
* }, {
* dependsOn: [apigeeInstance],
* });
* ```
*
* ## Import
*
* AppGroup can be imported using any of these accepted formats:
*
* * `{{org_id}}/appgroups/{{name}}`
*
* * `{{org_id}}/{{name}}`
*
* When using the `pulumi import` command, AppGroup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:apigee/appGroup:AppGroup default {{org_id}}/appgroups/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:apigee/appGroup:AppGroup default {{org_id}}/{{name}}
* ```
*/
class AppGroup extends pulumi.CustomResource {
/**
* Get an existing AppGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new AppGroup(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of AppGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === AppGroup.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["appGroupId"] = state ? state.appGroupId : undefined;
resourceInputs["attributes"] = state ? state.attributes : undefined;
resourceInputs["channelId"] = state ? state.channelId : undefined;
resourceInputs["channelUri"] = state ? state.channelUri : undefined;
resourceInputs["createdAt"] = state ? state.createdAt : undefined;
resourceInputs["displayName"] = state ? state.displayName : undefined;
resourceInputs["lastModifiedAt"] = state ? state.lastModifiedAt : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["orgId"] = state ? state.orgId : undefined;
resourceInputs["organization"] = state ? state.organization : undefined;
resourceInputs["status"] = state ? state.status : undefined;
}
else {
const args = argsOrState;
if ((!args || args.orgId === undefined) && !opts.urn) {
throw new Error("Missing required property 'orgId'");
}
resourceInputs["attributes"] = args ? args.attributes : undefined;
resourceInputs["channelId"] = args ? args.channelId : undefined;
resourceInputs["channelUri"] = args ? args.channelUri : undefined;
resourceInputs["displayName"] = args ? args.displayName : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["orgId"] = args ? args.orgId : undefined;
resourceInputs["status"] = args ? args.status : undefined;
resourceInputs["appGroupId"] = undefined /*out*/;
resourceInputs["createdAt"] = undefined /*out*/;
resourceInputs["lastModifiedAt"] = undefined /*out*/;
resourceInputs["organization"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(AppGroup.__pulumiType, name, resourceInputs, opts);
}
}
exports.AppGroup = AppGroup;
/** @internal */
AppGroup.__pulumiType = 'gcp:apigee/appGroup:AppGroup';
//# sourceMappingURL=appGroup.js.map