Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.34.0 published on Wednesday, Aug 17, 2022 by Pulumi

EnvGroup

An Environment group in Apigee.

To get more information about Envgroup, see:

Example Usage

Apigee Environment Group Basic

using System.Collections.Generic;
using Pulumi;
using Gcp = Pulumi.Gcp;

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

    var apigeeNetwork = new Gcp.Compute.Network("apigeeNetwork");

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

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

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

    var envGrp = new Gcp.Apigee.EnvGroup("envGrp", new()
    {
        Hostnames = new[]
        {
            "abc.foo.com",
        },
        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.NewEnvGroup(ctx, "envGrp", &apigee.EnvGroupArgs{
			Hostnames: pulumi.StringArray{
				pulumi.String("abc.foo.com"),
			},
			OrgId: apigeeOrg.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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.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();

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

        var envGrp = new EnvGroup("envGrp", EnvGroupArgs.builder()        
            .hostnames("abc.foo.com")
            .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_grp = gcp.apigee.EnvGroup("envGrp",
    hostnames=["abc.foo.com"],
    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 envGrp = new gcp.apigee.EnvGroup("envGrp", {
    hostnames: ["abc.foo.com"],
    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}
  envGrp:
    type: gcp:apigee:EnvGroup
    properties:
      hostnames:
        - abc.foo.com
      orgId: ${apigeeOrg.id}
variables:
  current:
    Fn::Invoke:
      Function: gcp:organizations:getClientConfig
      Arguments: {}

Create a EnvGroup Resource

new EnvGroup(name: string, args: EnvGroupArgs, opts?: CustomResourceOptions);
@overload
def EnvGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             hostnames: Optional[Sequence[str]] = None,
             name: Optional[str] = None,
             org_id: Optional[str] = None)
@overload
def EnvGroup(resource_name: str,
             args: EnvGroupArgs,
             opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args EnvGroupArgs
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 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 string
The unique name of the resource.
args EnvGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The EnvGroup resource accepts the following input properties:

OrgId 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 string

The resource ID of the environment group.

OrgId string

The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Hostnames []string

Hostnames of the environment group.

Name string

The resource ID of the environment group.

orgId 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 String

The resource ID of the environment group.

orgId string

The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames string[]

Hostnames of the environment group.

name string

The resource ID of the environment group.

org_id 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 str

The resource ID of the environment group.

orgId 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 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 an 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)
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.
The following state arguments are supported:
Hostnames List<string>

Hostnames of the environment group.

Name string

The resource ID of the environment group.

OrgId string

The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

Hostnames []string

Hostnames of the environment group.

Name string

The resource ID of the environment group.

OrgId 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 String

The resource ID of the environment group.

orgId String

The Apigee Organization associated with the Apigee environment group, in the format organizations/{{org_name}}.

hostnames string[]

Hostnames of the environment group.

name string

The resource ID of the environment group.

orgId 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 str

The resource ID of the environment group.

org_id 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 String

The resource ID of the environment group.

orgId 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

 $ pulumi import gcp:apigee/envGroup:EnvGroup default {{org_id}}/envgroups/{{name}}
 $ pulumi import gcp:apigee/envGroup:EnvGroup 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.