gcp.apigee.Organization
Explore with Pulumi AI
An Organization
is the top-level container in Apigee.
To get more information about Organization, see:
- API documentation
- How-to Guides
Example Usage
Apigee Organization Cloud Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const current = gcp.organizations.getClientConfig({});
const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
name: "apigee-range",
purpose: "VPC_PEERING",
addressType: "INTERNAL",
prefixLength: 16,
network: apigeeNetwork.id,
});
const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
network: apigeeNetwork.id,
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [apigeeRange.name],
});
const org = new gcp.apigee.Organization("org", {
analyticsRegion: "us-central1",
projectId: current.then(current => current.project),
authorizedNetwork: apigeeNetwork.id,
}, {
dependsOn: [apigeeVpcConnection],
});
import pulumi
import pulumi_gcp as gcp
current = gcp.organizations.get_client_config()
apigee_network = gcp.compute.Network("apigee_network", name="apigee-network")
apigee_range = gcp.compute.GlobalAddress("apigee_range",
name="apigee-range",
purpose="VPC_PEERING",
address_type="INTERNAL",
prefix_length=16,
network=apigee_network.id)
apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
network=apigee_network.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[apigee_range.name])
org = gcp.apigee.Organization("org",
analytics_region="us-central1",
project_id=current.project,
authorized_network=apigee_network.id,
opts = pulumi.ResourceOptions(depends_on=[apigee_vpc_connection]))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v8/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, map[string]interface{}{}, nil)
if err != nil {
return err
}
apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
Name: pulumi.String("apigee-network"),
})
if err != nil {
return err
}
apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
Name: pulumi.String("apigee-range"),
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, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
Network: apigeeNetwork.ID(),
Service: pulumi.String("servicenetworking.googleapis.com"),
ReservedPeeringRanges: pulumi.StringArray{
apigeeRange.Name,
},
})
if err != nil {
return err
}
_, err = apigee.NewOrganization(ctx, "org", &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
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var current = Gcp.Organizations.GetClientConfig.Invoke();
var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
{
Name = "apigee-network",
});
var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
{
Name = "apigee-range",
Purpose = "VPC_PEERING",
AddressType = "INTERNAL",
PrefixLength = 16,
Network = apigeeNetwork.Id,
});
var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
{
Network = apigeeNetwork.Id,
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges = new[]
{
apigeeRange.Name,
},
});
var org = new Gcp.Apigee.Organization("org", new()
{
AnalyticsRegion = "us-central1",
ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
AuthorizedNetwork = apigeeNetwork.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeVpcConnection,
},
});
});
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.NetworkArgs;
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", NetworkArgs.builder()
.name("apigee-network")
.build());
var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
.name("apigee-range")
.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());
}
}
resources:
apigeeNetwork:
type: gcp:compute:Network
name: apigee_network
properties:
name: apigee-network
apigeeRange:
type: gcp:compute:GlobalAddress
name: apigee_range
properties:
name: apigee-range
purpose: VPC_PEERING
addressType: INTERNAL
prefixLength: 16
network: ${apigeeNetwork.id}
apigeeVpcConnection:
type: gcp:servicenetworking:Connection
name: apigee_vpc_connection
properties:
network: ${apigeeNetwork.id}
service: servicenetworking.googleapis.com
reservedPeeringRanges:
- ${apigeeRange.name}
org:
type: gcp:apigee:Organization
properties:
analyticsRegion: us-central1
projectId: ${current.project}
authorizedNetwork: ${apigeeNetwork.id}
options:
dependson:
- ${apigeeVpcConnection}
variables:
current:
fn::invoke:
Function: gcp:organizations:getClientConfig
Arguments: {}
Apigee Organization Cloud Basic Disable Vpc Peering
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const current = gcp.organizations.getClientConfig({});
const org = new gcp.apigee.Organization("org", {
description: "Terraform-provisioned basic Apigee Org without VPC Peering.",
analyticsRegion: "us-central1",
projectId: current.then(current => current.project),
disableVpcPeering: true,
});
import pulumi
import pulumi_gcp as gcp
current = gcp.organizations.get_client_config()
org = gcp.apigee.Organization("org",
description="Terraform-provisioned basic Apigee Org without VPC Peering.",
analytics_region="us-central1",
project_id=current.project,
disable_vpc_peering=True)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := organizations.GetClientConfig(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
_, err = apigee.NewOrganization(ctx, "org", &apigee.OrganizationArgs{
Description: pulumi.String("Terraform-provisioned basic Apigee Org without VPC Peering."),
AnalyticsRegion: pulumi.String("us-central1"),
ProjectId: pulumi.String(current.Project),
DisableVpcPeering: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var current = Gcp.Organizations.GetClientConfig.Invoke();
var org = new Gcp.Apigee.Organization("org", new()
{
Description = "Terraform-provisioned basic Apigee Org without VPC Peering.",
AnalyticsRegion = "us-central1",
ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
DisableVpcPeering = true,
});
});
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());
}
}
resources:
org:
type: gcp:apigee:Organization
properties:
description: Terraform-provisioned basic Apigee Org without VPC Peering.
analyticsRegion: us-central1
projectId: ${current.project}
disableVpcPeering: true
variables:
current:
fn::invoke:
Function: gcp:organizations:getClientConfig
Arguments: {}
Apigee Organization Cloud Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const current = gcp.organizations.getClientConfig({});
const apigeeNetwork = new gcp.compute.Network("apigee_network", {name: "apigee-network"});
const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
name: "apigee-range",
purpose: "VPC_PEERING",
addressType: "INTERNAL",
prefixLength: 16,
network: apigeeNetwork.id,
});
const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
network: apigeeNetwork.id,
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [apigeeRange.name],
});
const apigeeKeyring = new gcp.kms.KeyRing("apigee_keyring", {
name: "apigee-keyring",
location: "us-central1",
});
const apigeeKey = new gcp.kms.CryptoKey("apigee_key", {
name: "apigee-key",
keyRing: apigeeKeyring.id,
});
const apigeeSa = new gcp.projects.ServiceIdentity("apigee_sa", {
project: project.projectId,
service: apigee.service,
});
const apigeeSaKeyuser = new gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser", {
cryptoKeyId: apigeeKey.id,
role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
member: apigeeSa.member,
});
const org = new gcp.apigee.Organization("org", {
analyticsRegion: "us-central1",
displayName: "apigee-org",
description: "Auto-provisioned Apigee Org.",
projectId: current.then(current => current.project),
authorizedNetwork: apigeeNetwork.id,
runtimeDatabaseEncryptionKeyName: apigeeKey.id,
}, {
dependsOn: [
apigeeVpcConnection,
apigeeSaKeyuser,
],
});
import pulumi
import pulumi_gcp as gcp
current = gcp.organizations.get_client_config()
apigee_network = gcp.compute.Network("apigee_network", name="apigee-network")
apigee_range = gcp.compute.GlobalAddress("apigee_range",
name="apigee-range",
purpose="VPC_PEERING",
address_type="INTERNAL",
prefix_length=16,
network=apigee_network.id)
apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
network=apigee_network.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[apigee_range.name])
apigee_keyring = gcp.kms.KeyRing("apigee_keyring",
name="apigee-keyring",
location="us-central1")
apigee_key = gcp.kms.CryptoKey("apigee_key",
name="apigee-key",
key_ring=apigee_keyring.id)
apigee_sa = gcp.projects.ServiceIdentity("apigee_sa",
project=project["projectId"],
service=apigee["service"])
apigee_sa_keyuser = gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser",
crypto_key_id=apigee_key.id,
role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
member=apigee_sa.member)
org = gcp.apigee.Organization("org",
analytics_region="us-central1",
display_name="apigee-org",
description="Auto-provisioned Apigee Org.",
project_id=current.project,
authorized_network=apigee_network.id,
runtime_database_encryption_key_name=apigee_key.id,
opts = pulumi.ResourceOptions(depends_on=[
apigee_vpc_connection,
apigee_sa_keyuser,
]))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
"github.com/pulumi/pulumi-gcp/sdk/v8/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, map[string]interface{}{}, nil)
if err != nil {
return err
}
apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
Name: pulumi.String("apigee-network"),
})
if err != nil {
return err
}
apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
Name: pulumi.String("apigee-range"),
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, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
Network: apigeeNetwork.ID(),
Service: pulumi.String("servicenetworking.googleapis.com"),
ReservedPeeringRanges: pulumi.StringArray{
apigeeRange.Name,
},
})
if err != nil {
return err
}
apigeeKeyring, err := kms.NewKeyRing(ctx, "apigee_keyring", &kms.KeyRingArgs{
Name: pulumi.String("apigee-keyring"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
apigeeKey, err := kms.NewCryptoKey(ctx, "apigee_key", &kms.CryptoKeyArgs{
Name: pulumi.String("apigee-key"),
KeyRing: apigeeKeyring.ID(),
})
if err != nil {
return err
}
apigeeSa, err := projects.NewServiceIdentity(ctx, "apigee_sa", &projects.ServiceIdentityArgs{
Project: pulumi.Any(project.ProjectId),
Service: pulumi.Any(apigee.Service),
})
if err != nil {
return err
}
apigeeSaKeyuser, err := kms.NewCryptoKeyIAMMember(ctx, "apigee_sa_keyuser", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: apigeeKey.ID(),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
Member: apigeeSa.Member,
})
if err != nil {
return err
}
_, err = apigee.NewOrganization(ctx, "org", &apigee.OrganizationArgs{
AnalyticsRegion: pulumi.String("us-central1"),
DisplayName: pulumi.String("apigee-org"),
Description: pulumi.String("Auto-provisioned Apigee Org."),
ProjectId: pulumi.String(current.Project),
AuthorizedNetwork: apigeeNetwork.ID(),
RuntimeDatabaseEncryptionKeyName: apigeeKey.ID(),
}, pulumi.DependsOn([]pulumi.Resource{
apigeeVpcConnection,
apigeeSaKeyuser,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var current = Gcp.Organizations.GetClientConfig.Invoke();
var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
{
Name = "apigee-network",
});
var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
{
Name = "apigee-range",
Purpose = "VPC_PEERING",
AddressType = "INTERNAL",
PrefixLength = 16,
Network = apigeeNetwork.Id,
});
var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
{
Network = apigeeNetwork.Id,
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges = new[]
{
apigeeRange.Name,
},
});
var apigeeKeyring = new Gcp.Kms.KeyRing("apigee_keyring", new()
{
Name = "apigee-keyring",
Location = "us-central1",
});
var apigeeKey = new Gcp.Kms.CryptoKey("apigee_key", new()
{
Name = "apigee-key",
KeyRing = apigeeKeyring.Id,
});
var apigeeSa = new Gcp.Projects.ServiceIdentity("apigee_sa", new()
{
Project = project.ProjectId,
Service = apigee.Service,
});
var apigeeSaKeyuser = new Gcp.Kms.CryptoKeyIAMMember("apigee_sa_keyuser", new()
{
CryptoKeyId = apigeeKey.Id,
Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
Member = apigeeSa.Member,
});
var org = new Gcp.Apigee.Organization("org", new()
{
AnalyticsRegion = "us-central1",
DisplayName = "apigee-org",
Description = "Auto-provisioned Apigee Org.",
ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
AuthorizedNetwork = apigeeNetwork.Id,
RuntimeDatabaseEncryptionKeyName = apigeeKey.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeVpcConnection,
apigeeSaKeyuser,
},
});
});
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.NetworkArgs;
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.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
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", NetworkArgs.builder()
.name("apigee-network")
.build());
var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
.name("apigee-range")
.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()
.name("apigee-keyring")
.location("us-central1")
.build());
var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()
.name("apigee-key")
.keyRing(apigeeKeyring.id())
.build());
var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()
.project(project.projectId())
.service(apigee.service())
.build());
var apigeeSaKeyuser = new CryptoKeyIAMMember("apigeeSaKeyuser", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId(apigeeKey.id())
.role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
.member(apigeeSa.member())
.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());
}
}
resources:
apigeeNetwork:
type: gcp:compute:Network
name: apigee_network
properties:
name: apigee-network
apigeeRange:
type: gcp:compute:GlobalAddress
name: apigee_range
properties:
name: apigee-range
purpose: VPC_PEERING
addressType: INTERNAL
prefixLength: 16
network: ${apigeeNetwork.id}
apigeeVpcConnection:
type: gcp:servicenetworking:Connection
name: apigee_vpc_connection
properties:
network: ${apigeeNetwork.id}
service: servicenetworking.googleapis.com
reservedPeeringRanges:
- ${apigeeRange.name}
apigeeKeyring:
type: gcp:kms:KeyRing
name: apigee_keyring
properties:
name: apigee-keyring
location: us-central1
apigeeKey:
type: gcp:kms:CryptoKey
name: apigee_key
properties:
name: apigee-key
keyRing: ${apigeeKeyring.id}
apigeeSa:
type: gcp:projects:ServiceIdentity
name: apigee_sa
properties:
project: ${project.projectId}
service: ${apigee.service}
apigeeSaKeyuser:
type: gcp:kms:CryptoKeyIAMMember
name: apigee_sa_keyuser
properties:
cryptoKeyId: ${apigeeKey.id}
role: roles/cloudkms.cryptoKeyEncrypterDecrypter
member: ${apigeeSa.member}
org:
type: gcp:apigee:Organization
properties:
analyticsRegion: us-central1
displayName: apigee-org
description: Auto-provisioned Apigee Org.
projectId: ${current.project}
authorizedNetwork: ${apigeeNetwork.id}
runtimeDatabaseEncryptionKeyName: ${apigeeKey.id}
options:
dependson:
- ${apigeeVpcConnection}
- ${apigeeSaKeyuser}
variables:
current:
fn::invoke:
Function: gcp:organizations:getClientConfig
Arguments: {}
Apigee Organization Cloud Full Disable Vpc Peering
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const current = gcp.organizations.getClientConfig({});
const apigeeKeyring = new gcp.kms.KeyRing("apigee_keyring", {
name: "apigee-keyring",
location: "us-central1",
});
const apigeeKey = new gcp.kms.CryptoKey("apigee_key", {
name: "apigee-key",
keyRing: apigeeKeyring.id,
});
const apigeeSa = new gcp.projects.ServiceIdentity("apigee_sa", {
project: project.projectId,
service: apigee.service,
});
const apigeeSaKeyuser = new gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser", {
cryptoKeyId: apigeeKey.id,
role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
member: apigeeSa.member,
});
const org = new gcp.apigee.Organization("org", {
analyticsRegion: "us-central1",
displayName: "apigee-org",
description: "Terraform-provisioned Apigee Org without VPC Peering.",
projectId: current.then(current => current.project),
disableVpcPeering: true,
runtimeDatabaseEncryptionKeyName: apigeeKey.id,
}, {
dependsOn: [apigeeSaKeyuser],
});
import pulumi
import pulumi_gcp as gcp
current = gcp.organizations.get_client_config()
apigee_keyring = gcp.kms.KeyRing("apigee_keyring",
name="apigee-keyring",
location="us-central1")
apigee_key = gcp.kms.CryptoKey("apigee_key",
name="apigee-key",
key_ring=apigee_keyring.id)
apigee_sa = gcp.projects.ServiceIdentity("apigee_sa",
project=project["projectId"],
service=apigee["service"])
apigee_sa_keyuser = gcp.kms.CryptoKeyIAMMember("apigee_sa_keyuser",
crypto_key_id=apigee_key.id,
role="roles/cloudkms.cryptoKeyEncrypterDecrypter",
member=apigee_sa.member)
org = gcp.apigee.Organization("org",
analytics_region="us-central1",
display_name="apigee-org",
description="Terraform-provisioned Apigee Org without VPC Peering.",
project_id=current.project,
disable_vpc_peering=True,
runtime_database_encryption_key_name=apigee_key.id,
opts = pulumi.ResourceOptions(depends_on=[apigee_sa_keyuser]))
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/kms"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := organizations.GetClientConfig(ctx, map[string]interface{}{}, nil)
if err != nil {
return err
}
apigeeKeyring, err := kms.NewKeyRing(ctx, "apigee_keyring", &kms.KeyRingArgs{
Name: pulumi.String("apigee-keyring"),
Location: pulumi.String("us-central1"),
})
if err != nil {
return err
}
apigeeKey, err := kms.NewCryptoKey(ctx, "apigee_key", &kms.CryptoKeyArgs{
Name: pulumi.String("apigee-key"),
KeyRing: apigeeKeyring.ID(),
})
if err != nil {
return err
}
apigeeSa, err := projects.NewServiceIdentity(ctx, "apigee_sa", &projects.ServiceIdentityArgs{
Project: pulumi.Any(project.ProjectId),
Service: pulumi.Any(apigee.Service),
})
if err != nil {
return err
}
apigeeSaKeyuser, err := kms.NewCryptoKeyIAMMember(ctx, "apigee_sa_keyuser", &kms.CryptoKeyIAMMemberArgs{
CryptoKeyId: apigeeKey.ID(),
Role: pulumi.String("roles/cloudkms.cryptoKeyEncrypterDecrypter"),
Member: apigeeSa.Member,
})
if err != nil {
return err
}
_, err = apigee.NewOrganization(ctx, "org", &apigee.OrganizationArgs{
AnalyticsRegion: pulumi.String("us-central1"),
DisplayName: pulumi.String("apigee-org"),
Description: pulumi.String("Terraform-provisioned Apigee Org without VPC Peering."),
ProjectId: pulumi.String(current.Project),
DisableVpcPeering: pulumi.Bool(true),
RuntimeDatabaseEncryptionKeyName: apigeeKey.ID(),
}, pulumi.DependsOn([]pulumi.Resource{
apigeeSaKeyuser,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var current = Gcp.Organizations.GetClientConfig.Invoke();
var apigeeKeyring = new Gcp.Kms.KeyRing("apigee_keyring", new()
{
Name = "apigee-keyring",
Location = "us-central1",
});
var apigeeKey = new Gcp.Kms.CryptoKey("apigee_key", new()
{
Name = "apigee-key",
KeyRing = apigeeKeyring.Id,
});
var apigeeSa = new Gcp.Projects.ServiceIdentity("apigee_sa", new()
{
Project = project.ProjectId,
Service = apigee.Service,
});
var apigeeSaKeyuser = new Gcp.Kms.CryptoKeyIAMMember("apigee_sa_keyuser", new()
{
CryptoKeyId = apigeeKey.Id,
Role = "roles/cloudkms.cryptoKeyEncrypterDecrypter",
Member = apigeeSa.Member,
});
var org = new Gcp.Apigee.Organization("org", new()
{
AnalyticsRegion = "us-central1",
DisplayName = "apigee-org",
Description = "Terraform-provisioned Apigee Org without VPC Peering.",
ProjectId = current.Apply(getClientConfigResult => getClientConfigResult.Project),
DisableVpcPeering = true,
RuntimeDatabaseEncryptionKeyName = apigeeKey.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeSaKeyuser,
},
});
});
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.CryptoKeyIAMMember;
import com.pulumi.gcp.kms.CryptoKeyIAMMemberArgs;
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()
.name("apigee-keyring")
.location("us-central1")
.build());
var apigeeKey = new CryptoKey("apigeeKey", CryptoKeyArgs.builder()
.name("apigee-key")
.keyRing(apigeeKeyring.id())
.build());
var apigeeSa = new ServiceIdentity("apigeeSa", ServiceIdentityArgs.builder()
.project(project.projectId())
.service(apigee.service())
.build());
var apigeeSaKeyuser = new CryptoKeyIAMMember("apigeeSaKeyuser", CryptoKeyIAMMemberArgs.builder()
.cryptoKeyId(apigeeKey.id())
.role("roles/cloudkms.cryptoKeyEncrypterDecrypter")
.member(apigeeSa.member())
.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());
}
}
resources:
apigeeKeyring:
type: gcp:kms:KeyRing
name: apigee_keyring
properties:
name: apigee-keyring
location: us-central1
apigeeKey:
type: gcp:kms:CryptoKey
name: apigee_key
properties:
name: apigee-key
keyRing: ${apigeeKeyring.id}
apigeeSa:
type: gcp:projects:ServiceIdentity
name: apigee_sa
properties:
project: ${project.projectId}
service: ${apigee.service}
apigeeSaKeyuser:
type: gcp:kms:CryptoKeyIAMMember
name: apigee_sa_keyuser
properties:
cryptoKeyId: ${apigeeKey.id}
role: roles/cloudkms.cryptoKeyEncrypterDecrypter
member: ${apigeeSa.member}
org:
type: gcp:apigee:Organization
properties:
analyticsRegion: us-central1
displayName: apigee-org
description: Terraform-provisioned Apigee Org without VPC Peering.
projectId: ${current.project}
disableVpcPeering: true
runtimeDatabaseEncryptionKeyName: ${apigeeKey.id}
options:
dependson:
- ${apigeeSaKeyuser}
variables:
current:
fn::invoke:
Function: gcp:organizations:getClientConfig
Arguments: {}
Create Organization Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Organization(name: string, args: OrganizationArgs, opts?: CustomResourceOptions);
@overload
def Organization(resource_name: str,
args: OrganizationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Organization(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
authorized_network: Optional[str] = None,
api_consumer_data_location: Optional[str] = None,
analytics_region: Optional[str] = None,
billing_type: Optional[str] = None,
control_plane_encryption_key_name: Optional[str] = None,
description: Optional[str] = None,
disable_vpc_peering: Optional[bool] = None,
display_name: Optional[str] = None,
api_consumer_data_encryption_key_name: Optional[str] = None,
properties: Optional[OrganizationPropertiesArgs] = None,
retention: Optional[str] = None,
runtime_database_encryption_key_name: Optional[str] = None,
runtime_type: Optional[str] = None)
func NewOrganization(ctx *Context, name string, args OrganizationArgs, opts ...ResourceOption) (*Organization, error)
public Organization(string name, OrganizationArgs args, CustomResourceOptions? opts = null)
public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)
type: gcp:apigee:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrganizationArgs
- 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 OrganizationArgs
- 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 OrganizationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var organizationResource = new Gcp.Apigee.Organization("organizationResource", new()
{
ProjectId = "string",
AuthorizedNetwork = "string",
ApiConsumerDataLocation = "string",
AnalyticsRegion = "string",
BillingType = "string",
ControlPlaneEncryptionKeyName = "string",
Description = "string",
DisableVpcPeering = false,
DisplayName = "string",
ApiConsumerDataEncryptionKeyName = "string",
Properties = new Gcp.Apigee.Inputs.OrganizationPropertiesArgs
{
Properties = new[]
{
new Gcp.Apigee.Inputs.OrganizationPropertiesPropertyArgs
{
Name = "string",
Value = "string",
},
},
},
Retention = "string",
RuntimeDatabaseEncryptionKeyName = "string",
RuntimeType = "string",
});
example, err := apigee.NewOrganization(ctx, "organizationResource", &apigee.OrganizationArgs{
ProjectId: pulumi.String("string"),
AuthorizedNetwork: pulumi.String("string"),
ApiConsumerDataLocation: pulumi.String("string"),
AnalyticsRegion: pulumi.String("string"),
BillingType: pulumi.String("string"),
ControlPlaneEncryptionKeyName: pulumi.String("string"),
Description: pulumi.String("string"),
DisableVpcPeering: pulumi.Bool(false),
DisplayName: pulumi.String("string"),
ApiConsumerDataEncryptionKeyName: pulumi.String("string"),
Properties: &apigee.OrganizationPropertiesArgs{
Properties: apigee.OrganizationPropertiesPropertyArray{
&apigee.OrganizationPropertiesPropertyArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Retention: pulumi.String("string"),
RuntimeDatabaseEncryptionKeyName: pulumi.String("string"),
RuntimeType: pulumi.String("string"),
})
var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
.projectId("string")
.authorizedNetwork("string")
.apiConsumerDataLocation("string")
.analyticsRegion("string")
.billingType("string")
.controlPlaneEncryptionKeyName("string")
.description("string")
.disableVpcPeering(false)
.displayName("string")
.apiConsumerDataEncryptionKeyName("string")
.properties(OrganizationPropertiesArgs.builder()
.properties(OrganizationPropertiesPropertyArgs.builder()
.name("string")
.value("string")
.build())
.build())
.retention("string")
.runtimeDatabaseEncryptionKeyName("string")
.runtimeType("string")
.build());
organization_resource = gcp.apigee.Organization("organizationResource",
project_id="string",
authorized_network="string",
api_consumer_data_location="string",
analytics_region="string",
billing_type="string",
control_plane_encryption_key_name="string",
description="string",
disable_vpc_peering=False,
display_name="string",
api_consumer_data_encryption_key_name="string",
properties={
"properties": [{
"name": "string",
"value": "string",
}],
},
retention="string",
runtime_database_encryption_key_name="string",
runtime_type="string")
const organizationResource = new gcp.apigee.Organization("organizationResource", {
projectId: "string",
authorizedNetwork: "string",
apiConsumerDataLocation: "string",
analyticsRegion: "string",
billingType: "string",
controlPlaneEncryptionKeyName: "string",
description: "string",
disableVpcPeering: false,
displayName: "string",
apiConsumerDataEncryptionKeyName: "string",
properties: {
properties: [{
name: "string",
value: "string",
}],
},
retention: "string",
runtimeDatabaseEncryptionKeyName: "string",
runtimeType: "string",
});
type: gcp:apigee:Organization
properties:
analyticsRegion: string
apiConsumerDataEncryptionKeyName: string
apiConsumerDataLocation: string
authorizedNetwork: string
billingType: string
controlPlaneEncryptionKeyName: string
description: string
disableVpcPeering: false
displayName: string
projectId: string
properties:
properties:
- name: string
value: string
retention: string
runtimeDatabaseEncryptionKeyName: string
runtimeType: string
Organization Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Organization resource accepts the following input properties:
- Project
Id string - The project ID associated with the Apigee organization.
- Analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- Api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- Api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- 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". - Billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- Control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- Description string
- Description of the Apigee organization.
- Disable
Vpc boolPeering - 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 totrue
. Valid only whenRuntimeType
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. - Display
Name string - The display name of the Apigee organization.
- Properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- Retention 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
. - Runtime
Database stringEncryption Key Name - 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
. - Runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
- Project
Id string - The project ID associated with the Apigee organization.
- Analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- Api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- Api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- 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". - Billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- Control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- Description string
- Description of the Apigee organization.
- Disable
Vpc boolPeering - 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 totrue
. Valid only whenRuntimeType
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. - Display
Name string - The display name of the Apigee organization.
- Properties
Organization
Properties Args - Properties defined in the Apigee organization profile. Structure is documented below.
- Retention 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
. - Runtime
Database stringEncryption Key Name - 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
. - Runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
- project
Id String - The project ID associated with the Apigee organization.
- analytics
Region String - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer StringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer StringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- 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". - billing
Type String - Billing type of the Apigee organization. See Apigee pricing.
- control
Plane StringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description String
- Description of the Apigee organization.
- disable
Vpc BooleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name String - The display name of the Apigee organization.
- properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database StringEncryption Key Name - 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
. - runtime
Type String - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
- project
Id string - The project ID associated with the Apigee organization.
- analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- 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". - billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description string
- Description of the Apigee organization.
- disable
Vpc booleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name string - The display name of the Apigee organization.
- properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database stringEncryption Key Name - 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
. - runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
- project_
id str - The project ID associated with the Apigee organization.
- analytics_
region str - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api_
consumer_ strdata_ encryption_ key_ name - Cloud KMS key name used for encrypting API consumer data.
- api_
consumer_ strdata_ location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- str
- 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". - billing_
type str - Billing type of the Apigee organization. See Apigee pricing.
- control_
plane_ strencryption_ key_ name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description str
- Description of the Apigee organization.
- disable_
vpc_ boolpeering - 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 totrue
. Valid only whenRuntimeType
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. - display_
name str - The display name of the Apigee organization.
- properties
Organization
Properties Args - Properties defined in the Apigee organization profile. Structure is documented below.
- retention str
- 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
. - runtime_
database_ strencryption_ key_ name - 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
. - runtime_
type str - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
- project
Id String - The project ID associated with the Apigee organization.
- analytics
Region String - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer StringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer StringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- 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". - billing
Type String - Billing type of the Apigee organization. See Apigee pricing.
- control
Plane StringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description String
- Description of the Apigee organization.
- disable
Vpc BooleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name String - The display name of the Apigee organization.
- properties Property Map
- Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database StringEncryption Key Name - 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
. - runtime
Type String - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
.
Outputs
All input properties are implicitly available as output properties. Additionally, the Organization resource produces the following output properties:
- Apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- Ca
Certificate 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Output only. Name of the Apigee organization.
- Subscription
Type 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).
- Apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- Ca
Certificate 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. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Output only. Name of the Apigee organization.
- Subscription
Type 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).
- apigee
Project StringId - Output only. Project ID of the Apigee Tenant Project.
- ca
Certificate 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. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- Output only. Name of the Apigee organization.
- subscription
Type 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).
- apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- ca
Certificate 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. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- Output only. Name of the Apigee organization.
- subscription
Type 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).
- apigee_
project_ strid - Output only. Project ID of the Apigee Tenant Project.
- ca_
certificate str - Output only. Base64-encoded public certificate for the root CA of the Apigee organization.
Valid only when
RuntimeType
is CLOUD. A base64-encoded string. - id str
- The provider-assigned unique ID for this managed resource.
- name str
- Output only. Name of the Apigee organization.
- subscription_
type str - 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).
- apigee
Project StringId - Output only. Project ID of the Apigee Tenant Project.
- ca
Certificate 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. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- Output only. Name of the Apigee organization.
- subscription
Type 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).
Look up Existing Organization Resource
Get an existing Organization 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?: OrganizationState, opts?: CustomResourceOptions): Organization
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
analytics_region: Optional[str] = None,
api_consumer_data_encryption_key_name: Optional[str] = None,
api_consumer_data_location: Optional[str] = None,
apigee_project_id: Optional[str] = None,
authorized_network: Optional[str] = None,
billing_type: Optional[str] = None,
ca_certificate: Optional[str] = None,
control_plane_encryption_key_name: Optional[str] = None,
description: Optional[str] = None,
disable_vpc_peering: Optional[bool] = None,
display_name: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
properties: Optional[OrganizationPropertiesArgs] = None,
retention: Optional[str] = None,
runtime_database_encryption_key_name: Optional[str] = None,
runtime_type: Optional[str] = None,
subscription_type: Optional[str] = None) -> Organization
func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
public static Organization get(String name, Output<String> id, OrganizationState 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.
- Analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- Api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- Api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- Apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- 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". - Billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- Ca
Certificate 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. - Control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- Description string
- Description of the Apigee organization.
- Disable
Vpc boolPeering - 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 totrue
. Valid only whenRuntimeType
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. - Display
Name string - The display name of the Apigee organization.
- Name string
- Output only. Name of the Apigee organization.
- Project
Id string - The project ID associated with the Apigee organization.
- Properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- Retention 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
. - Runtime
Database stringEncryption Key Name - 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
. - Runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - Subscription
Type 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).
- Analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- Api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- Api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- Apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- 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". - Billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- Ca
Certificate 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. - Control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- Description string
- Description of the Apigee organization.
- Disable
Vpc boolPeering - 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 totrue
. Valid only whenRuntimeType
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. - Display
Name string - The display name of the Apigee organization.
- Name string
- Output only. Name of the Apigee organization.
- Project
Id string - The project ID associated with the Apigee organization.
- Properties
Organization
Properties Args - Properties defined in the Apigee organization profile. Structure is documented below.
- Retention 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
. - Runtime
Database stringEncryption Key Name - 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
. - Runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - Subscription
Type 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).
- analytics
Region String - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer StringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer StringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- apigee
Project StringId - Output only. Project ID of the Apigee Tenant Project.
- 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". - billing
Type String - Billing type of the Apigee organization. See Apigee pricing.
- ca
Certificate 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. - control
Plane StringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description String
- Description of the Apigee organization.
- disable
Vpc BooleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name String - The display name of the Apigee organization.
- name String
- Output only. Name of the Apigee organization.
- project
Id String - The project ID associated with the Apigee organization.
- properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database StringEncryption Key Name - 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
. - runtime
Type String - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - subscription
Type 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).
- analytics
Region string - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer stringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer stringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- apigee
Project stringId - Output only. Project ID of the Apigee Tenant Project.
- 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". - billing
Type string - Billing type of the Apigee organization. See Apigee pricing.
- ca
Certificate 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. - control
Plane stringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description string
- Description of the Apigee organization.
- disable
Vpc booleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name string - The display name of the Apigee organization.
- name string
- Output only. Name of the Apigee organization.
- project
Id string - The project ID associated with the Apigee organization.
- properties
Organization
Properties - Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database stringEncryption Key Name - 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
. - runtime
Type string - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - subscription
Type 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).
- analytics_
region str - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api_
consumer_ strdata_ encryption_ key_ name - Cloud KMS key name used for encrypting API consumer data.
- api_
consumer_ strdata_ location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- apigee_
project_ strid - Output only. Project ID of the Apigee Tenant Project.
- str
- 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". - billing_
type str - Billing type of the Apigee organization. See Apigee pricing.
- ca_
certificate str - Output only. Base64-encoded public certificate for the root CA of the Apigee organization.
Valid only when
RuntimeType
is CLOUD. A base64-encoded string. - control_
plane_ strencryption_ key_ name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description str
- Description of the Apigee organization.
- disable_
vpc_ boolpeering - 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 totrue
. Valid only whenRuntimeType
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. - display_
name str - The display name of the Apigee organization.
- name str
- Output only. Name of the Apigee organization.
- project_
id str - The project ID associated with the Apigee organization.
- properties
Organization
Properties Args - Properties defined in the Apigee organization profile. Structure is documented below.
- retention str
- 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
. - runtime_
database_ strencryption_ key_ name - 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
. - runtime_
type str - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - subscription_
type str - 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).
- analytics
Region String - Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
- api
Consumer StringData Encryption Key Name - Cloud KMS key name used for encrypting API consumer data.
- api
Consumer StringData Location - This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.
- apigee
Project StringId - Output only. Project ID of the Apigee Tenant Project.
- 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". - billing
Type String - Billing type of the Apigee organization. See Apigee pricing.
- ca
Certificate 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. - control
Plane StringEncryption Key Name - Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU".
- description String
- Description of the Apigee organization.
- disable
Vpc BooleanPeering - 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 totrue
. Valid only whenRuntimeType
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. - display
Name String - The display name of the Apigee organization.
- name String
- Output only. Name of the Apigee organization.
- project
Id String - The project ID associated with the Apigee organization.
- properties Property Map
- Properties defined in the Apigee organization profile. Structure is documented below.
- retention 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
. - runtime
Database StringEncryption Key Name - 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
. - runtime
Type String - Runtime type of the Apigee organization based on the Apigee subscription purchased.
Default value is
CLOUD
. Possible values are:CLOUD
,HYBRID
. - subscription
Type 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).
Supporting Types
OrganizationProperties, OrganizationPropertiesArgs
- Properties
List<Organization
Properties Property> - List of all properties in the object. Structure is documented below.
- Properties
[]Organization
Properties Property - List of all properties in the object. Structure is documented below.
- properties
List<Organization
Properties Property> - List of all properties in the object. Structure is documented below.
- properties
Organization
Properties Property[] - List of all properties in the object. Structure is documented below.
- properties
Sequence[Organization
Properties Property] - List of all properties in the object. Structure is documented below.
- properties List<Property Map>
- List of all properties in the object. Structure is documented below.
OrganizationPropertiesProperty, OrganizationPropertiesPropertyArgs
Import
Organization can be imported using any of these accepted formats:
organizations/{{name}}
{{name}}
When using the pulumi import
command, Organization can be imported using one of the formats above. For example:
$ pulumi import gcp:apigee/organization:Organization default organizations/{{name}}
$ pulumi import gcp:apigee/organization:Organization default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.