Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. apigee
  5. Environment
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.apigee.Environment

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

An Environment in Apigee.

To get more information about Environment, see:

Example Usage

Apigee Environment 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 env = new gcp.apigee.Environment("env", {
    name: "my-environment",
    description: "Apigee Environment",
    displayName: "environment-1",
    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 = gcp.apigee.Environment("env",
    name="my-environment",
    description="Apigee Environment",
    display_name="environment-1",
    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.NewEnvironment(ctx, "env", &apigee.EnvironmentArgs{
			Name:        pulumi.String("my-environment"),
			Description: pulumi.String("Apigee Environment"),
			DisplayName: pulumi.String("environment-1"),
			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 env = new Gcp.Apigee.Environment("env", new()
    {
        Name = "my-environment",
        Description = "Apigee Environment",
        DisplayName = "environment-1",
        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.Environment;
import com.pulumi.gcp.apigee.EnvironmentArgs;
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();

        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.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());

        var env = new Environment("env", EnvironmentArgs.builder()
            .name("my-environment")
            .description("Apigee Environment")
            .displayName("environment-1")
            .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}
  env:
    type: gcp:apigee:Environment
    properties:
      name: my-environment
      description: Apigee Environment
      displayName: environment-1
      orgId: ${apigeeOrg.id}
variables:
  current:
    fn::invoke:
      function: gcp:organizations:getClientConfig
      arguments: {}
Copy

Create Environment Resource

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

Constructor syntax

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

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                org_id: Optional[str] = None,
                api_proxy_type: Optional[str] = None,
                deployment_type: Optional[str] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                forward_proxy_uri: Optional[str] = None,
                name: Optional[str] = None,
                node_config: Optional[EnvironmentNodeConfigArgs] = None,
                properties: Optional[EnvironmentPropertiesArgs] = None,
                type: Optional[str] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: gcp:apigee:Environment
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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. EnvironmentArgs
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 environmentResource = new Gcp.Apigee.Environment("environmentResource", new()
{
    OrgId = "string",
    ApiProxyType = "string",
    DeploymentType = "string",
    Description = "string",
    DisplayName = "string",
    ForwardProxyUri = "string",
    Name = "string",
    NodeConfig = new Gcp.Apigee.Inputs.EnvironmentNodeConfigArgs
    {
        CurrentAggregateNodeCount = "string",
        MaxNodeCount = "string",
        MinNodeCount = "string",
    },
    Properties = new Gcp.Apigee.Inputs.EnvironmentPropertiesArgs
    {
        Properties = new[]
        {
            new Gcp.Apigee.Inputs.EnvironmentPropertiesPropertyArgs
            {
                Name = "string",
                Value = "string",
            },
        },
    },
    Type = "string",
});
Copy
example, err := apigee.NewEnvironment(ctx, "environmentResource", &apigee.EnvironmentArgs{
	OrgId:           pulumi.String("string"),
	ApiProxyType:    pulumi.String("string"),
	DeploymentType:  pulumi.String("string"),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	ForwardProxyUri: pulumi.String("string"),
	Name:            pulumi.String("string"),
	NodeConfig: &apigee.EnvironmentNodeConfigArgs{
		CurrentAggregateNodeCount: pulumi.String("string"),
		MaxNodeCount:              pulumi.String("string"),
		MinNodeCount:              pulumi.String("string"),
	},
	Properties: &apigee.EnvironmentPropertiesArgs{
		Properties: apigee.EnvironmentPropertiesPropertyArray{
			&apigee.EnvironmentPropertiesPropertyArgs{
				Name:  pulumi.String("string"),
				Value: pulumi.String("string"),
			},
		},
	},
	Type: pulumi.String("string"),
})
Copy
var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .orgId("string")
    .apiProxyType("string")
    .deploymentType("string")
    .description("string")
    .displayName("string")
    .forwardProxyUri("string")
    .name("string")
    .nodeConfig(EnvironmentNodeConfigArgs.builder()
        .currentAggregateNodeCount("string")
        .maxNodeCount("string")
        .minNodeCount("string")
        .build())
    .properties(EnvironmentPropertiesArgs.builder()
        .properties(EnvironmentPropertiesPropertyArgs.builder()
            .name("string")
            .value("string")
            .build())
        .build())
    .type("string")
    .build());
Copy
environment_resource = gcp.apigee.Environment("environmentResource",
    org_id="string",
    api_proxy_type="string",
    deployment_type="string",
    description="string",
    display_name="string",
    forward_proxy_uri="string",
    name="string",
    node_config={
        "current_aggregate_node_count": "string",
        "max_node_count": "string",
        "min_node_count": "string",
    },
    properties={
        "properties": [{
            "name": "string",
            "value": "string",
        }],
    },
    type="string")
Copy
const environmentResource = new gcp.apigee.Environment("environmentResource", {
    orgId: "string",
    apiProxyType: "string",
    deploymentType: "string",
    description: "string",
    displayName: "string",
    forwardProxyUri: "string",
    name: "string",
    nodeConfig: {
        currentAggregateNodeCount: "string",
        maxNodeCount: "string",
        minNodeCount: "string",
    },
    properties: {
        properties: [{
            name: "string",
            value: "string",
        }],
    },
    type: "string",
});
Copy
type: gcp:apigee:Environment
properties:
    apiProxyType: string
    deploymentType: string
    description: string
    displayName: string
    forwardProxyUri: string
    name: string
    nodeConfig:
        currentAggregateNodeCount: string
        maxNodeCount: string
        minNodeCount: string
    orgId: string
    properties:
        properties:
            - name: string
              value: string
    type: string
Copy

Environment 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 Environment 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, in the format organizations/{{org_name}}.

ApiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
DeploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
Description string
Description of the environment.
DisplayName string
Display name of the environment.
ForwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
Name Changes to this property will trigger replacement. string
The resource ID of the environment.
NodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
Properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
Type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
OrgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

ApiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
DeploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
Description string
Description of the environment.
DisplayName string
Display name of the environment.
ForwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
Name Changes to this property will trigger replacement. string
The resource ID of the environment.
NodeConfig EnvironmentNodeConfigArgs
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
Properties EnvironmentPropertiesArgs
Key-value pairs that may be used for customizing the environment. Structure is documented below.
Type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType Changes to this property will trigger replacement. String
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. String
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description String
Description of the environment.
displayName String
Display name of the environment.
forwardProxyUri String
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. String
The resource ID of the environment.
nodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type String
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
orgId
This property is required.
Changes to this property will trigger replacement.
string
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description string
Description of the environment.
displayName string
Display name of the environment.
forwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. string
The resource ID of the environment.
nodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
org_id
This property is required.
Changes to this property will trigger replacement.
str
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

api_proxy_type Changes to this property will trigger replacement. str
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deployment_type Changes to this property will trigger replacement. str
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description str
Description of the environment.
display_name str
Display name of the environment.
forward_proxy_uri str
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. str
The resource ID of the environment.
node_config EnvironmentNodeConfigArgs
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
properties EnvironmentPropertiesArgs
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type str
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
orgId
This property is required.
Changes to this property will trigger replacement.
String
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType Changes to this property will trigger replacement. String
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. String
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description String
Description of the environment.
displayName String
Display name of the environment.
forwardProxyUri String
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. String
The resource ID of the environment.
nodeConfig Property Map
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
properties Property Map
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type String
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment 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 Environment Resource

Get an existing Environment 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?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_proxy_type: Optional[str] = None,
        deployment_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        forward_proxy_uri: Optional[str] = None,
        name: Optional[str] = None,
        node_config: Optional[EnvironmentNodeConfigArgs] = None,
        org_id: Optional[str] = None,
        properties: Optional[EnvironmentPropertiesArgs] = None,
        type: Optional[str] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
resources:  _:    type: gcp:apigee:Environment    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:
ApiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
DeploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
Description string
Description of the environment.
DisplayName string
Display name of the environment.
ForwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
Name Changes to this property will trigger replacement. string
The resource ID of the environment.
NodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

Properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
Type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
ApiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
DeploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
Description string
Description of the environment.
DisplayName string
Display name of the environment.
ForwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
Name Changes to this property will trigger replacement. string
The resource ID of the environment.
NodeConfig EnvironmentNodeConfigArgs
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
OrgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

Properties EnvironmentPropertiesArgs
Key-value pairs that may be used for customizing the environment. Structure is documented below.
Type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
apiProxyType Changes to this property will trigger replacement. String
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. String
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description String
Description of the environment.
displayName String
Display name of the environment.
forwardProxyUri String
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. String
The resource ID of the environment.
nodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type String
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
apiProxyType Changes to this property will trigger replacement. string
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. string
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description string
Description of the environment.
displayName string
Display name of the environment.
forwardProxyUri string
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. string
The resource ID of the environment.
nodeConfig EnvironmentNodeConfig
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
orgId Changes to this property will trigger replacement. string
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

properties EnvironmentProperties
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type string
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
api_proxy_type Changes to this property will trigger replacement. str
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deployment_type Changes to this property will trigger replacement. str
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description str
Description of the environment.
display_name str
Display name of the environment.
forward_proxy_uri str
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. str
The resource ID of the environment.
node_config EnvironmentNodeConfigArgs
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
org_id Changes to this property will trigger replacement. str
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

properties EnvironmentPropertiesArgs
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type str
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
apiProxyType Changes to this property will trigger replacement. String
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
deploymentType Changes to this property will trigger replacement. String
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
description String
Description of the environment.
displayName String
Display name of the environment.
forwardProxyUri String
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
name Changes to this property will trigger replacement. String
The resource ID of the environment.
nodeConfig Property Map
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
orgId Changes to this property will trigger replacement. String
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

properties Property Map
Key-value pairs that may be used for customizing the environment. Structure is documented below.
type String
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.

Supporting Types

EnvironmentNodeConfig
, EnvironmentNodeConfigArgs

CurrentAggregateNodeCount string
(Output) The current total number of gateway nodes that each environment currently has across all instances.
MaxNodeCount string
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
MinNodeCount string
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
CurrentAggregateNodeCount string
(Output) The current total number of gateway nodes that each environment currently has across all instances.
MaxNodeCount string
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
MinNodeCount string
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
currentAggregateNodeCount String
(Output) The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount String
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount String
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
currentAggregateNodeCount string
(Output) The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount string
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount string
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
current_aggregate_node_count str
(Output) The current total number of gateway nodes that each environment currently has across all instances.
max_node_count str
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
min_node_count str
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
currentAggregateNodeCount String
(Output) The current total number of gateway nodes that each environment currently has across all instances.
maxNodeCount String
The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
minNodeCount String
The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.

EnvironmentProperties
, EnvironmentPropertiesArgs

Properties List<EnvironmentPropertiesProperty>
List of all properties in the object. Structure is documented below.
Properties []EnvironmentPropertiesProperty
List of all properties in the object. Structure is documented below.
properties List<EnvironmentPropertiesProperty>
List of all properties in the object. Structure is documented below.
properties EnvironmentPropertiesProperty[]
List of all properties in the object. Structure is documented below.
properties Sequence[EnvironmentPropertiesProperty]
List of all properties in the object. Structure is documented below.
properties List<Property Map>
List of all properties in the object. Structure is documented below.

EnvironmentPropertiesProperty
, EnvironmentPropertiesPropertyArgs

Name string
The property key.
Value string
The property value.
Name string
The property key.
Value string
The property value.
name String
The property key.
value String
The property value.
name string
The property key.
value string
The property value.
name str
The property key.
value str
The property value.
name String
The property key.
value String
The property value.

Import

Environment can be imported using any of these accepted formats:

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

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

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

$ pulumi import gcp:apigee/environment:Environment default {{org_id}}/environments/{{name}}
Copy
$ pulumi import gcp:apigee/environment:Environment 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.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp