Google Cloud (GCP) Classic
Environment
An Environment
in Apigee.
To get more information about Environment, see:
- API documentation
- How-to Guides
Example Usage
Apigee Environment Basic
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var current = Output.Create(Gcp.Organizations.GetClientConfig.InvokeAsync());
var apigeeNetwork = new Gcp.Compute.Network("apigeeNetwork", new Gcp.Compute.NetworkArgs
{
});
var apigeeRange = new Gcp.Compute.GlobalAddress("apigeeRange", new Gcp.Compute.GlobalAddressArgs
{
Purpose = "VPC_PEERING",
AddressType = "INTERNAL",
PrefixLength = 16,
Network = apigeeNetwork.Id,
});
var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigeeVpcConnection", new Gcp.ServiceNetworking.ConnectionArgs
{
Network = apigeeNetwork.Id,
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges =
{
apigeeRange.Name,
},
});
var apigeeOrg = new Gcp.Apigee.Organization("apigeeOrg", new Gcp.Apigee.OrganizationArgs
{
AnalyticsRegion = "us-central1",
ProjectId = current.Apply(current => current.Project),
AuthorizedNetwork = apigeeNetwork.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeVpcConnection,
},
});
var env = new Gcp.Apigee.Environment("env", new Gcp.Apigee.EnvironmentArgs
{
Description = "Apigee Environment",
DisplayName = "environment-1",
OrgId = apigeeOrg.Id,
});
}
}
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v6/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, nil, nil)
if err != nil {
return err
}
apigeeNetwork, err := compute.NewNetwork(ctx, "apigeeNetwork", nil)
if err != nil {
return err
}
apigeeRange, err := compute.NewGlobalAddress(ctx, "apigeeRange", &compute.GlobalAddressArgs{
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, "apigeeVpcConnection", &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, "apigeeOrg", &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{
Description: pulumi.String("Apigee Environment"),
DisplayName: pulumi.String("environment-1"),
OrgId: apigeeOrg.ID(),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import com.pulumi.resources.CustomResourceOptions;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var current = Output.of(OrganizationsFunctions.getClientConfig());
var apigeeNetwork = new Network("apigeeNetwork");
var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
.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.apply(getClientConfigResult -> getClientConfigResult.project()))
.authorizedNetwork(apigeeNetwork.id())
.build(), CustomResourceOptions.builder()
.dependsOn(apigeeVpcConnection)
.build());
var env = new Environment("env", EnvironmentArgs.builder()
.description("Apigee Environment")
.displayName("environment-1")
.orgId(apigeeOrg.id())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
current = gcp.organizations.get_client_config()
apigee_network = gcp.compute.Network("apigeeNetwork")
apigee_range = gcp.compute.GlobalAddress("apigeeRange",
purpose="VPC_PEERING",
address_type="INTERNAL",
prefix_length=16,
network=apigee_network.id)
apigee_vpc_connection = gcp.servicenetworking.Connection("apigeeVpcConnection",
network=apigee_network.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[apigee_range.name])
apigee_org = gcp.apigee.Organization("apigeeOrg",
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",
description="Apigee Environment",
display_name="environment-1",
org_id=apigee_org.id)
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const current = gcp.organizations.getClientConfig({});
const apigeeNetwork = new gcp.compute.Network("apigeeNetwork", {});
const apigeeRange = new gcp.compute.GlobalAddress("apigeeRange", {
purpose: "VPC_PEERING",
addressType: "INTERNAL",
prefixLength: 16,
network: apigeeNetwork.id,
});
const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigeeVpcConnection", {
network: apigeeNetwork.id,
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [apigeeRange.name],
});
const apigeeOrg = new gcp.apigee.Organization("apigeeOrg", {
analyticsRegion: "us-central1",
projectId: current.then(current => current.project),
authorizedNetwork: apigeeNetwork.id,
}, {
dependsOn: [apigeeVpcConnection],
});
const env = new gcp.apigee.Environment("env", {
description: "Apigee Environment",
displayName: "environment-1",
orgId: apigeeOrg.id,
});
resources:
apigeeNetwork:
type: gcp:compute:Network
apigeeRange:
type: gcp:compute:GlobalAddress
properties:
purpose: VPC_PEERING
addressType: INTERNAL
prefixLength: 16
network: ${apigeeNetwork.id}
apigeeVpcConnection:
type: gcp:servicenetworking:Connection
properties:
network: ${apigeeNetwork.id}
service: servicenetworking.googleapis.com
reservedPeeringRanges:
- ${apigeeRange.name}
apigeeOrg:
type: gcp:apigee:Organization
properties:
analyticsRegion: us-central1
projectId: ${current.project}
authorizedNetwork: ${apigeeNetwork.id}
options:
dependson:
- ${apigeeVpcConnection}
env:
type: gcp:apigee:Environment
properties:
description: Apigee Environment
displayName: environment-1
orgId: ${apigeeOrg.id}
variables:
current:
Fn::Invoke:
Function: gcp:organizations:getClientConfig
Arguments: {}
Create a Environment Resource
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: 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,
name: Optional[str] = None,
org_id: Optional[str] = None)
@overload
def Environment(resource_name: str,
args: EnvironmentArgs,
opts: Optional[ResourceOptions] = 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.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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
The Environment resource accepts the following input properties:
- Org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- Api
Proxy stringType 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
, andCONFIGURABLE
.- Deployment
Type 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
, andARCHIVE
.- Description string
Description of the environment.
- Display
Name string Display name of the environment.
- Name string
The resource ID of the environment.
- Org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- Api
Proxy stringType 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
, andCONFIGURABLE
.- Deployment
Type 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
, andARCHIVE
.- Description string
Description of the environment.
- Display
Name string Display name of the environment.
- Name string
The resource ID of the environment.
- org
Id String The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- api
Proxy StringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description String
Description of the environment.
- display
Name String Display name of the environment.
- name String
The resource ID of the environment.
- org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- api
Proxy stringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description string
Description of the environment.
- display
Name string Display name of the environment.
- name string
The resource ID of the environment.
- org_
id str The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- api_
proxy_ strtype 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
, andCONFIGURABLE
.- deployment_
type 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
, andARCHIVE
.- description str
Description of the environment.
- display_
name str Display name of the environment.
- name str
The resource ID of the environment.
- org
Id String The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.- api
Proxy StringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description String
Description of the environment.
- display
Name String Display name of the environment.
- name String
The resource ID of the environment.
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 an 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,
name: Optional[str] = None,
org_id: 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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Api
Proxy stringType 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
, andCONFIGURABLE
.- Deployment
Type 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
, andARCHIVE
.- Description string
Description of the environment.
- Display
Name string Display name of the environment.
- Name string
The resource ID of the environment.
- Org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
- Api
Proxy stringType 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
, andCONFIGURABLE
.- Deployment
Type 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
, andARCHIVE
.- Description string
Description of the environment.
- Display
Name string Display name of the environment.
- Name string
The resource ID of the environment.
- Org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
- api
Proxy StringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description String
Description of the environment.
- display
Name String Display name of the environment.
- name String
The resource ID of the environment.
- org
Id String The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
- api
Proxy stringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description string
Description of the environment.
- display
Name string Display name of the environment.
- name string
The resource ID of the environment.
- org
Id string The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
- api_
proxy_ strtype 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
, andCONFIGURABLE
.- deployment_
type 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
, andARCHIVE
.- description str
Description of the environment.
- display_
name str Display name of the environment.
- name str
The resource ID of the environment.
- org_
id str The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
- api
Proxy StringType 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
, andCONFIGURABLE
.- deployment
Type 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
, andARCHIVE
.- description String
Description of the environment.
- display
Name String Display name of the environment.
- name String
The resource ID of the environment.
- org
Id String The Apigee Organization associated with the Apigee environment, in the format
organizations/{{org_name}}
.
Import
Environment can be imported using any of these accepted formats
$ pulumi import gcp:apigee/environment:Environment default {{org_id}}/environments/{{name}}
$ pulumi import gcp:apigee/environment:Environment default {{org_id}}/{{name}}
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.