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

OrganizationArgs

data class OrganizationArgs(val analyticsRegion: Output<String>? = null, val authorizedNetwork: Output<String>? = null, val billingType: Output<String>? = null, val description: Output<String>? = null, val disableVpcPeering: Output<Boolean>? = null, val displayName: Output<String>? = null, val projectId: Output<String>? = null, val properties: Output<OrganizationPropertiesArgs>? = null, val retention: Output<String>? = null, val runtimeDatabaseEncryptionKeyName: Output<String>? = null, val runtimeType: Output<String>? = null) : ConvertibleToJava<OrganizationArgs>

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

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());
    }
}
Content copied to clipboard

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());
    }
}
Content copied to clipboard

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());
    }
}
Content copied to clipboard

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());
    }
}
Content copied to clipboard

Import

Organization can be imported using any of these accepted formats

$ pulumi import gcp:apigee/organization:Organization default organizations/{{name}}
Content copied to clipboard
$ pulumi import gcp:apigee/organization:Organization default {{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(analyticsRegion: Output<String>? = null, authorizedNetwork: Output<String>? = null, billingType: Output<String>? = null, description: Output<String>? = null, disableVpcPeering: Output<Boolean>? = null, displayName: Output<String>? = null, projectId: Output<String>? = null, properties: Output<OrganizationPropertiesArgs>? = null, retention: Output<String>? = null, runtimeDatabaseEncryptionKeyName: Output<String>? = null, runtimeType: Output<String>? = null)

Properties

Link copied to clipboard
val analyticsRegion: Output<String>? = null

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

Link copied to clipboard
val authorizedNetwork: Output<String>? = null

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".

Link copied to clipboard
val billingType: Output<String>? = null

Billing type of the Apigee organization. See Apigee pricing.

Link copied to clipboard
val description: Output<String>? = null

Description of the Apigee organization.

Link copied to clipboard
val disableVpcPeering: Output<Boolean>? = null

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.

Link copied to clipboard
val displayName: Output<String>? = null

The display name of the Apigee organization.

Link copied to clipboard
val projectId: Output<String>? = null

The project ID associated with the Apigee organization.

Link copied to clipboard
val properties: Output<OrganizationPropertiesArgs>? = null

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

Link copied to clipboard
val retention: Output<String>? = null

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.

Link copied to clipboard
val runtimeDatabaseEncryptionKeyName: Output<String>? = null

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.

Link copied to clipboard
val runtimeType: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): OrganizationArgs