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

Organization

class Organization : KotlinCustomResource

An Organization is the top-level container in Apigee. To get more information about Organization, see:

API documentation
How-to Guides

Creating an API organization

Example Usage

Apigee Organization Cloud 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.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 org = new Organization("org", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeVpcConnection)
                .build());
    }
}

Apigee Organization Cloud Basic Disable Vpc Peering

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.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
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 org = new Organization("org", OrganizationArgs.builder()
            .description("Terraform-provisioned basic Apigee Org without VPC Peering.")
            .analyticsRegion("us-central1")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .disableVpcPeering(true)
            .build());
    }
}

Apigee Organization Cloud Full

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.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.projects.ServiceIdentity;
import com.pulumi.gcp.projects.ServiceIdentityArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
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 apigeeKeyring = new KeyRing("apigeeKeyring", KeyRingArgs.builder()
            .location("us-central1")
            .build());
        var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()
            .keyRing(apigeeKeyring.id())
            .build());
        var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()
            .project(google_project.project().project_id())
            .service(google_project_service.apigee().service())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apigeeSaKeyuser = new CryptoKeyIAMBinding("apigeeSaKeyuser", CryptoKeyIAMBindingArgs.builder()
            .cryptoKeyId(apigeeKey.id())
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .members(apigeeSa.email().applyValue(email -> String.format("serviceAccount:%s", email)))
            .build());
        var org = new Organization("org", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .displayName("apigee-org")
            .description("Auto-provisioned Apigee Org.")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .authorizedNetwork(apigeeNetwork.id())
            .runtimeDatabaseEncryptionKeyName(apigeeKey.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(
                    apigeeVpcConnection,
                    apigeeSaKeyuser)
                .build());
    }
}

Apigee Organization Cloud Full Disable Vpc Peering

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.kms.KeyRing;
import com.pulumi.gcp.kms.KeyRingArgs;
import com.pulumi.gcp.kms.CryptoKey;
import com.pulumi.gcp.kms.CryptoKeyArgs;
import com.pulumi.gcp.projects.ServiceIdentity;
import com.pulumi.gcp.projects.ServiceIdentityArgs;
import com.pulumi.gcp.kms.CryptoKeyIAMBinding;
import com.pulumi.gcp.kms.CryptoKeyIAMBindingArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
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 apigeeKeyring = new KeyRing("apigeeKeyring", KeyRingArgs.builder()
            .location("us-central1")
            .build());
        var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()
            .keyRing(apigeeKeyring.id())
            .build());
        var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()
            .project(google_project.project().project_id())
            .service(google_project_service.apigee().service())
            .build(), CustomResourceOptions.builder()
                .provider(google_beta)
                .build());
        var apigeeSaKeyuser = new CryptoKeyIAMBinding("apigeeSaKeyuser", CryptoKeyIAMBindingArgs.builder()
            .cryptoKeyId(apigeeKey.id())
            .role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
            .members(apigeeSa.email().applyValue(email -> String.format("serviceAccount:%s", email)))
            .build());
        var org = new Organization("org", OrganizationArgs.builder()
            .analyticsRegion("us-central1")
            .displayName("apigee-org")
            .description("Terraform-provisioned Apigee Org without VPC Peering.")
            .projectId(current.applyValue(getClientConfigResult -> getClientConfigResult.project()))
            .disableVpcPeering(true)
            .runtimeDatabaseEncryptionKeyName(apigeeKey.id())
            .build(), CustomResourceOptions.builder()
                .dependsOn(apigeeSaKeyuser)
                .build());
    }
}

Import

Organization can be imported using any of these accepted formats

$ pulumi import gcp:apigee/organization:Organization default organizations/{{name}}

$ pulumi import gcp:apigee/organization:Organization default {{name}}

Properties

analyticsRegion

val analyticsRegion: Output<String>?

Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.

apigeeProjectId

val apigeeProjectId: Output<String>

Output only. Project ID of the Apigee Tenant Project.

authorizedNetwork

val authorizedNetwork: Output<String>?

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default".

billingType

val billingType: Output<String>

Billing type of the Apigee organization. See Apigee pricing.

caCertificate

val caCertificate: Output<String>

Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD. A base64-encoded string.

description

val description: Output<String>?

Description of the Apigee organization.

disableVpcPeering

val disableVpcPeering: Output<Boolean>?

Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances.

displayName

val displayName: Output<String>?

The display name of the Apigee organization.

val id: Output<String>

name

val name: Output<String>

Name of the property.

projectId

val projectId: Output<String>

The project ID associated with the Apigee organization.

properties

val properties: Output<OrganizationProperties>

Properties defined in the Apigee organization profile. Structure is documented below.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

retention

val retention: Output<String>?

Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. Default value is DELETION_RETENTION_UNSPECIFIED. Possible values are: DELETION_RETENTION_UNSPECIFIED, MINIMUM.

runtimeDatabaseEncryptionKeyName

val runtimeDatabaseEncryptionKeyName: Output<String>?

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified, a Google-Managed encryption key will be used. Valid only when RuntimeType is CLOUD. For example: projects/foo/locations/us/keyRings/bar/cryptoKeys/baz.

runtimeType

val runtimeType: Output<String>?

Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value is CLOUD. Possible values are: CLOUD, HYBRID.

subscriptionType

val subscriptionType: Output<String>

Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased).

urn

val urn: Output<String>