Organization class

Creates an Apigee organization. See Create an Apigee organization. Auto-naming is currently not supported for this resource.

Constructors

Organization(String name, {OrganizationArgs? args, CustomResourceOptions? options})

Creates a new Organization. name The Pulumi resource name. args Arguments used to configure this Organization. The set of arguments for Organization. options Resource options controlling this resource's behavior.

Properties

addonsConfig ↔ Output<GoogleCloudApigeeV1AddonsConfigResponse>

Addon configurations of the Apigee organization.

late, final

analyticsRegion ↔ Output<String>

DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization.

late, final

apiConsumerDataEncryptionKeyName ↔ Output<String>

Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType is EVALUATION or the region is not US/EU, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

late, final

apiConsumerDataLocation ↔ Output<String>

This field is needed only for customers with control plane in US or EU. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.

late, final

apigeeProjectId ↔ Output<String>

Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee.

late, final

attributes ↔ Output<List<String>>

Not used by Apigee.

late, final

authorizedNetwork ↔ Output<String>

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. 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.

late, final

billingType ↔ Output<String>

Billing type of the Apigee organization. See Apigee pricing.

late, final

caCertificate ↔ Output<String>

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

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

controlPlaneEncryptionKeyName ↔ Output<String>

Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*

late, final

createdAt ↔ Output<String>

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

late, final

customerName ↔ Output<String>

Not used by Apigee.

late, final

description ↔ Output<String>

Description of the Apigee organization.

late, final

disableVpcPeering ↔ Output<bool>

Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.

late, final

displayName ↔ Output<String>

Display name for the Apigee organization. Unused, but reserved for future use.

late, final

environments ↔ Output<List<String>>

List of environments in the Apigee organization.

late, final

expiresAt ↔ Output<String>

Time that the Apigee organization is scheduled for deletion.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

lastModifiedAt ↔ Output<String>

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

late, final

name ↔ Output<String>

Name of the Apigee organization.

late, final

parent ↔ Output<String>

Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/

late, final

portalDisabled ↔ Output<bool>

Configuration for the Portals settings.

late, final

project ↔ Output<String>

Project ID associated with the Apigee organization.

late, final

properties ↔ Output<GoogleCloudApigeeV1PropertiesResponse>

Properties defined in the Apigee organization profile.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeDatabaseEncryptionKeyName ↔ Output<String>

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. Required when RuntimeType is CLOUD. If not specified 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.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

runtimeType_ ↔ Output<String>

Runtime type of the Apigee organization based on the Apigee subscription purchased.

late, final

state ↔ Output<String>

State of the organization. Values other than ACTIVE means the resource is not ready to use.

late, final

subscriptionPlan ↔ Output<String>

Subscription plan that the customer has purchased. Output only.

late, final

subscriptionType ↔ Output<String>

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 Apigee pricing.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String>

Not used by Apigee.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited