Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. EnvGroup
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.apigee.EnvGroup

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

An Environment group in Apigee.

To get more information about Envgroup, see:

Example Usage

Apigee Environment Group Basic

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 envGrp = new gcp.apigee.EnvGroup("env_grp", {
    name: "my-envgroup",
    hostnames: ["abc.foo.com"],
    orgId: apigeeOrg.id,
});
Copy
import pulumi
import pulumi_gcp as gcp

current = gcp.organizations.get_client_config()
apigee_network = gcp.compute.Network("apigee_network", name="apigee-network")
apigee_range = gcp.compute.GlobalAddress("apigee_range",
    name="apigee-range",
    purpose="VPC_PEERING",
    address_type="INTERNAL",
    prefix_length=16,
    network=apigee_network.id)
apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
    network=apigee_network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[apigee_range.name])
apigee_org = gcp.apigee.Organization("apigee_org",
    analytics_region="us-central1",
    project_id=current.project,
    authorized_network=apigee_network.id,
    opts = pulumi.ResourceOptions(depends_on=[apigee_vpc_connection]))
env_grp = gcp.apigee.EnvGroup("env_grp",
    name="my-envgroup",
    hostnames=["abc.foo.com"],
    org_id=apigee_org.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := organizations.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
			Name: pulumi.String("apigee-network"),
		})
		if err != nil {
			return err
		}
		apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
			Name:         pulumi.String("apigee-range"),
			Purpose:      pulumi.String("VPC_PEERING"),
			AddressType:  pulumi.String("INTERNAL"),
			PrefixLength: pulumi.Int(16),
			Network:      apigeeNetwork.ID(),
		})
		if err != nil {
			return err
		}
		apigeeVpcConnection, err := servicenetworking.NewConnection(ctx, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
			Network: apigeeNetwork.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				apigeeRange.Name,
			},
		})
		if err != nil {
			return err
		}
		apigeeOrg, err := apigee.NewOrganization(ctx, "apigee_org", &apigee.OrganizationArgs{
			AnalyticsRegion:   pulumi.String("us-central1"),
			ProjectId:         pulumi.String(current.Project),
			AuthorizedNetwork: apigeeNetwork.ID(),
		}, pulumi.DependsOn([]pulumi.Resource{
			apigeeVpcConnection,
		}))
		if err != nil {
			return err
		}
		_, err = apigee.NewEnvGroup(ctx, "env_grp", &apigee.EnvGroupArgs{
			Name: pulumi.String("my-envgroup"),
			Hostnames: pulumi.StringArray{
				pulumi.String("abc.foo.com"),
			},
			OrgId: apigeeOrg.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var current = Gcp.Organizations.GetClientConfig.Invoke();

    var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
    {
        Name = "apigee-network",
    });

    var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
    {
        Name = "apigee-range",
        Purpose = "VPC_PEERING",
        AddressType = "INTERNAL",
        PrefixLength = 16,
        Network = apigeeNetwork.Id,
    });

    var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
    {
        Network = apigeeNetwork.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            apigeeRange.Name,
        },
    });

    var apigeeOrg = new Gcp.Apigee.Organization("apigee_org", new()
    {
        AnalyticsRegion = "us-central1",
        ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
        AuthorizedNetwork = apigeeNetwork.Id,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            apigeeVpcConnection,
        },
    });

    var envGrp = new Gcp.Apigee.EnvGroup("env_grp", new()
    {
        Name = "my-envgroup",
        Hostnames = new[]
        {
            "abc.foo.com",
        },
        OrgId = apigeeOrg.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.EnvGroup;
import com.pulumi.gcp.apigee.EnvGroupArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = OrganizationsFunctions.getClientConfig(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

        var apigeeNetwork = new Network("apigeeNetwork", NetworkArgs.builder()
            .name("apigee-network")
            .build());

        var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
            .name("apigee-range")
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(16)
            .network(apigeeNetwork.id())
            .build());

        var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
            .network(apigeeNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(apigeeRange.name())
            .build());

        var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .projectId(current.project())
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());

        var envGrp = new EnvGroup("envGrp", EnvGroupArgs.builder()
            .name("my-envgroup")
            .hostnames("abc.foo.com")
            .orgId(apigeeOrg.id())
            .build());

    }
}
Copy
resources:
  apigeeNetwork:
    type: gcp:compute:Network
    name: apigee_network
    properties:
      name: apigee-network
  apigeeRange:
    type: gcp:compute:GlobalAddress
    name: apigee_range
    properties:
      name: apigee-range
      purpose: VPC_PEERING
      addressType: INTERNAL
      prefixLength: 16
      network: ${apigeeNetwork.id}
  apigeeVpcConnection:
    type: gcp:servicenetworking:Connection
    name: apigee_vpc_connection
    properties:
      network: ${apigeeNetwork.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${apigeeRange.name}
  apigeeOrg:
    type: gcp:apigee:Organization
    name: apigee_org
    properties:
      analyticsRegion: us-central1
      projectId: ${current.project}
      authorizedNetwork: ${apigeeNetwork.id}
    options:
      dependsOn:
        - ${apigeeVpcConnection}
  envGrp:
    type: gcp:apigee:EnvGroup
    name: env_grp
    properties:
      name: my-envgroup
      hostnames:
        - abc.foo.com
      orgId: ${apigeeOrg.id}
variables:
  current:
    fn::invoke:
      function: gcp:organizations:getClientConfig
      arguments: {}
Copy

Create EnvGroup Resource

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

Constructor syntax

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

@overload
def EnvGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             org_id: Optional[str] = None,
             hostnames: Optional[Sequence[str]] = None,
             name: Optional[str] = None)
func NewEnvGroup(ctx *Context, name string, args EnvGroupArgs, opts ...ResourceOption) (*EnvGroup, error)
public EnvGroup(string name, EnvGroupArgs args, CustomResourceOptions? opts = null)
public EnvGroup(String name, EnvGroupArgs args)
public EnvGroup(String name, EnvGroupArgs args, CustomResourceOptions options)

type: gcp:apigee:EnvGroup
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. EnvGroupArgs
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. EnvGroupArgs
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. EnvGroupArgs
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. EnvGroupArgs
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. EnvGroupArgs
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 envGroupResource = new Gcp.Apigee.EnvGroup("envGroupResource", new()
{
    OrgId = "string",
    Hostnames = new[]
    {
        "string",
    },
    Name = "string",
});
Copy
example, err := apigee.NewEnvGroup(ctx, "envGroupResource", &apigee.EnvGroupArgs{
	OrgId: pulumi.String("string"),
	Hostnames: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})
Copy
var envGroupResource = new EnvGroup("envGroupResource", EnvGroupArgs.builder()
    .orgId("string")
    .hostnames("string")
    .name("string")
    .build());
Copy
env_group_resource = gcp.apigee.EnvGroup("envGroupResource",
    org_id="string",
    hostnames=["string"],
    name="string")
Copy
const envGroupResource = new gcp.apigee.EnvGroup("envGroupResource", {
    orgId: "string",
    hostnames: ["string"],
    name: "string",
});
Copy
type: gcp:apigee:EnvGroup
properties:
    hostnames:
        - string
    name: string
    orgId: string
Copy

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

OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Hostnames List<string>
Hostnames of the environment group.
Name Changes to this property will trigger replacement. string
The resource ID of the environment group.
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Hostnames []string
Hostnames of the environment group.
Name Changes to this property will trigger replacement. string
The resource ID of the environment group.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames List<String>
Hostnames of the environment group.
name Changes to this property will trigger replacement. String
The resource ID of the environment group.
orgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames string[]
Hostnames of the environment group.
name Changes to this property will trigger replacement. string
The resource ID of the environment group.
org_id
This property is required.
Changes to this property will trigger replacement.
str
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames Sequence[str]
Hostnames of the environment group.
name Changes to this property will trigger replacement. str
The resource ID of the environment group.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames List<String>
Hostnames of the environment group.
name Changes to this property will trigger replacement. String
The resource ID of the environment group.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EnvGroup Resource

Get an existing EnvGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvGroupState, opts?: CustomResourceOptions): EnvGroup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        hostnames: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None) -> EnvGroup
func GetEnvGroup(ctx *Context, name string, id IDInput, state *EnvGroupState, opts ...ResourceOption) (*EnvGroup, error)
public static EnvGroup Get(string name, Input<string> id, EnvGroupState? state, CustomResourceOptions? opts = null)
public static EnvGroup get(String name, Output<String> id, EnvGroupState state, CustomResourceOptions options)
resources:  _:    type: gcp:apigee:EnvGroup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Hostnames List<string>
Hostnames of the environment group.
Name Changes to this property will trigger replacement. string
The resource ID of the environment group.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Hostnames []string
Hostnames of the environment group.
Name Changes to this property will trigger replacement. string
The resource ID of the environment group.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames List<String>
Hostnames of the environment group.
name Changes to this property will trigger replacement. String
The resource ID of the environment group.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames string[]
Hostnames of the environment group.
name Changes to this property will trigger replacement. string
The resource ID of the environment group.
orgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames Sequence[str]
Hostnames of the environment group.
name Changes to this property will trigger replacement. str
The resource ID of the environment group.
org_id Changes to this property will trigger replacement. str
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames List<String>
Hostnames of the environment group.
name Changes to this property will trigger replacement. String
The resource ID of the environment group.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Import

Envgroup can be imported using any of these accepted formats:

  • {{org_id}}/envgroups/{{name}}

  • {{org_id}}/{{name}}

When using the pulumi import command, Envgroup can be imported using one of the formats above. For example:

$ pulumi import gcp:apigee/envGroup:EnvGroup default {{org_id}}/envgroups/{{name}}
Copy
$ pulumi import gcp:apigee/envGroup:EnvGroup default {{org_id}}/{{name}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp