pulumi-gcp-kotlin/com.pulumi.gcp.apigee.kotlin/Environment

Environment

class Environment : KotlinCustomResource

An Environment in Apigee. To get more information about Environment, see:

API documentation
How-to Guides

Creating an environment

Example Usage

Apigee Environment Basic

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.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");
        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 env = new Environment("env", EnvironmentArgs.builder()
            .description("Apigee Environment")
            .displayName("environment-1")
            .orgId(apigeeOrg.id())
            .build());
    }
}

Import

Environment can be imported using any of these accepted formats* {{org_id}}/environments/{{name}} * {{org_id}}/{{name}} In Terraform v1.5.0 and later, use an import block to import Environment using one of the formats above. For exampletf import { id = "{{org_id}}/environments/{{name}}" to = google_apigee_environment.default }

$ pulumi import gcp:apigee/environment:Environment When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Environment can be imported using one of the formats above. For example

$ pulumi import gcp:apigee/environment:Environment default {{org_id}}/environments/{{name}}

$ pulumi import gcp:apigee/environment:Environment default {{org_id}}/{{name}}

Properties

apiProxyType

val apiProxyType: Output<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

val deploymentType: Output<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

val description: Output<String>?

Description of the environment.

displayName

val displayName: Output<String>?

Display name of the environment.

val id: Output<String>

name

val name: Output<String>

The resource ID of the environment.

nodeConfig

val nodeConfig: Output<EnvironmentNodeConfig>

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId

val orgId: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

type

val type: Output<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.

urn

val urn: Output<String>