ApigeeOrganization

Stay organized with collections Save and categorize content based on your preferences.
Property Value
Google Cloud Service Name Apigee
Google Cloud Service Documentation /apigee/docs/
Google Cloud REST Resource Name organizations
Google Cloud REST Resource Documentation /apigee/docs/reference/apis/apigee/rest/v1/organizations
Config Connector Resource Short Names gcpapigeeorganization
gcpapigeeorganizations
apigeeorganization
Config Connector Service Name apigee.googleapis.com
Config Connector Resource Fully Qualified Name apigeeorganizations.apigee.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Annotations

Fields
cnrm.cloud.google.com/state-into-spec

Spec

Schema

addonsConfig:
  advancedApiOpsConfig:
    enabled: boolean
  monetizationConfig:
    enabled: boolean
analyticsRegion: string
authorizedNetworkRef:
  external: string
  name: string
  namespace: string
description: string
displayName: string
projectRef:
  external: string
  name: string
  namespace: string
properties:
  string: string
resourceID: string
runtimeDatabaseEncryptionKeyRef:
  external: string
  name: string
  namespace: string
runtimeType: string
Fields

addonsConfig

Optional

object

Addon configurations of the Apigee organization.

addonsConfig.advancedApiOpsConfig

Optional

object

Configuration for the Advanced API Ops add-on.

addonsConfig.advancedApiOpsConfig.enabled

Optional

boolean

Flag that specifies whether the Advanced API Ops add-on is enabled.

addonsConfig.monetizationConfig

Optional

object

Configuration for the Monetization add-on.

addonsConfig.monetizationConfig.enabled

Optional

boolean

Flag that specifies whether the Monetization add-on is enabled.

analyticsRegion

Required

string

Immutable. Required. Primary GCP region for analytics data storage. For valid values, see (https://cloud.google.com/apigee/docs/api-platform/get-started/create-org).

authorizedNetworkRef

Optional

object

authorizedNetworkRef.external

Optional

string

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See (https://cloud.google.com/vpc/docs/shared-vpc). To use a shared VPC network, use the following format: `projects/{host-project-id}/{region}/networks/{network-name}`. For example: `projects/my-sharedvpc-host/global/networks/mynetwork` **Note:** Not supported for Apigee hybrid. Allowed value: The Google Cloud resource name of a `ComputeNetwork` resource (format: `projects/{{project}}/global/networks/{{name}}`).

authorizedNetworkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

authorizedNetworkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

description

Optional

string

Description of the Apigee organization.

displayName

Optional

string

Display name for the Apigee organization.

projectRef

Required

object

Immutable. The Project that this resource belongs to.

projectRef.external

Optional

string

Required. Name of the GCP project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/ Authorization requires the following IAM permission on the specified resource parent: apigee.organizations.create Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

properties

Optional

map (key: string, value: string)

Properties defined in the Apigee organization profile.

resourceID

Optional

string

Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.

runtimeDatabaseEncryptionKeyRef

Optional

object

runtimeDatabaseEncryptionKeyRef.external

Optional

string

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when (#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** Not supported for Apigee hybrid. Allowed value: The Google Cloud resource name of a `KMSCryptoKey` resource (format: `{{selfLink}}`).

runtimeDatabaseEncryptionKeyRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

runtimeDatabaseEncryptionKeyRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

runtimeType

Required

string

Immutable. Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. Possible values: RUNTIME_TYPE_UNSPECIFIED, CLOUD, HYBRID

Status

Schema

billingType: string
caCertificate: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: integer
environments:
- string
expiresAt: integer
lastModifiedAt: integer
observedGeneration: integer
projectId: string
state: string
subscriptionType: string
Fields
billingType

string

Output only. Billing type of the Apigee organization. See (https://cloud.google.com/apigee/pricing). Possible values: BILLING_TYPE_UNSPECIFIED, SUBSCRIPTION, EVALUATION

caCertificate

string

Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when (#RuntimeType) is `CLOUD`.

conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions[]

object

conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions[].message

string

Human-readable message indicating details about last transition.

conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions[].type

string

Type is the type of the condition.

createdAt

integer

Output only. Time that the Apigee organization was created in milliseconds since epoch.

environments

list (string)

Output only. List of environments in the Apigee organization.

environments[]

string

expiresAt

integer

Output only. Time that the Apigee organization is scheduled for deletion.

lastModifiedAt

integer

Output only. Time that the Apigee organization was last modified in milliseconds since epoch.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

projectId

string

Output only. Project ID associated with the Apigee organization.

state

string

Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use. Possible values: SNAPSHOT_STATE_UNSPECIFIED, MISSING, OK_DOCSTORE, OK_SUBMITTED, OK_EXTERNAL, DELETED

subscriptionType

string

Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See (https://cloud.google.com/apigee/pricing/). Possible values: SUBSCRIPTION_TYPE_UNSPECIFIED, PAID, TRIAL

Sample YAML(s)

Typical Use Case

# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: apigee.cnrm.cloud.google.com/v1beta1
kind: ApigeeOrganization
metadata:
  name: apigeeorganization-sample
spec:
  projectRef:
    # Replace ${PROJECT_ID?} with your project ID
    external: "projects/${PROJECT_ID?}"
  displayName: "basic-organization"
  description: "A sample organization"
  properties:
    features.mart.connect.enabled: "false"
    features.hybrid.enabled: "true"
  analyticsRegion: "us-west1"
  authorizedNetworkRef:
    name: "apigeeorganization-dep"
  runtimeType: "CLOUD"
  addonsConfig:
    advancedApiOpsConfig:
      enabled: true
    integrationConfig:
      enabled: false
    monetizationConfig:
      enabled: false
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: "apigeeorganization-dep"
spec:
  autoCreateSubnetworks: false
  description: A sample authorized network for an apigee organization