apigeeOrganization.typescript.md

apigeeOrganization Submodule

Constructs

ApigeeOrganization

Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization google_apigee_organization}.

Initializers

import { apigeeOrganization } from '@cdktf/provider-google'

new apigeeOrganization.ApigeeOrganization(scope: Construct, id: string, config: ApigeeOrganizationConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ApigeeOrganizationConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ApigeeOrganizationConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putProperties	No description.
putTimeouts	No description.
resetAnalyticsRegion	No description.
resetApiConsumerDataEncryptionKeyName	No description.
resetApiConsumerDataLocation	No description.
resetAuthorizedNetwork	No description.
resetBillingType	No description.
resetControlPlaneEncryptionKeyName	No description.
resetDescription	No description.
resetDisableVpcPeering	No description.
resetDisplayName	No description.
resetId	No description.
resetProperties	No description.
resetRetention	No description.
resetRuntimeDatabaseEncryptionKeyName	No description.
resetRuntimeType	No description.
resetTimeouts	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putProperties

public putProperties(value: ApigeeOrganizationProperties): void

value^Required

• Type: ApigeeOrganizationProperties

---

putTimeouts

public putTimeouts(value: ApigeeOrganizationTimeouts): void

value^Required

• Type: ApigeeOrganizationTimeouts

---

resetAnalyticsRegion

public resetAnalyticsRegion(): void

resetApiConsumerDataEncryptionKeyName

public resetApiConsumerDataEncryptionKeyName(): void

resetApiConsumerDataLocation

public resetApiConsumerDataLocation(): void

resetAuthorizedNetwork

public resetAuthorizedNetwork(): void

resetBillingType

public resetBillingType(): void

resetControlPlaneEncryptionKeyName

public resetControlPlaneEncryptionKeyName(): void

resetDescription

public resetDescription(): void

resetDisableVpcPeering

public resetDisableVpcPeering(): void

resetDisplayName

public resetDisplayName(): void

resetId

public resetId(): void

resetProperties

public resetProperties(): void

resetRetention

public resetRetention(): void

resetRuntimeDatabaseEncryptionKeyName

public resetRuntimeDatabaseEncryptionKeyName(): void

resetRuntimeType

public resetRuntimeType(): void

resetTimeouts

public resetTimeouts(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a ApigeeOrganization resource upon running "cdktf plan ".

---

isConstruct

import { apigeeOrganization } from '@cdktf/provider-google'

apigeeOrganization.ApigeeOrganization.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { apigeeOrganization } from '@cdktf/provider-google'

apigeeOrganization.ApigeeOrganization.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { apigeeOrganization } from '@cdktf/provider-google'

apigeeOrganization.ApigeeOrganization.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { apigeeOrganization } from '@cdktf/provider-google'

apigeeOrganization.ApigeeOrganization.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ApigeeOrganization resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the ApigeeOrganization to import.

---

importFromId^Required

• Type: string

The id of the existing ApigeeOrganization that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ApigeeOrganization to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
apigeeProjectId	string	No description.
caCertificate	string	No description.
name	string	No description.
properties	ApigeeOrganizationPropertiesOutputReference	No description.
subscriptionType	string	No description.
timeouts	ApigeeOrganizationTimeoutsOutputReference	No description.
analyticsRegionInput	string	No description.
apiConsumerDataEncryptionKeyNameInput	string	No description.
apiConsumerDataLocationInput	string	No description.
authorizedNetworkInput	string	No description.
billingTypeInput	string	No description.
controlPlaneEncryptionKeyNameInput	string	No description.
descriptionInput	string	No description.
disableVpcPeeringInput	boolean | cdktf.IResolvable	No description.
displayNameInput	string	No description.
idInput	string	No description.
projectIdInput	string	No description.
propertiesInput	ApigeeOrganizationProperties	No description.
retentionInput	string	No description.
runtimeDatabaseEncryptionKeyNameInput	string	No description.
runtimeTypeInput	string	No description.
timeoutsInput	cdktf.IResolvable | ApigeeOrganizationTimeouts	No description.
analyticsRegion	string	No description.
apiConsumerDataEncryptionKeyName	string	No description.
apiConsumerDataLocation	string	No description.
authorizedNetwork	string	No description.
billingType	string	No description.
controlPlaneEncryptionKeyName	string	No description.
description	string	No description.
disableVpcPeering	boolean | cdktf.IResolvable	No description.
displayName	string	No description.
id	string	No description.
projectId	string	No description.
retention	string	No description.
runtimeDatabaseEncryptionKeyName	string	No description.
runtimeType	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

apigeeProjectId^Required

public readonly apigeeProjectId: string;

• Type: string

---

caCertificate^Required

public readonly caCertificate: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

properties^Required

public readonly properties: ApigeeOrganizationPropertiesOutputReference;

• Type: ApigeeOrganizationPropertiesOutputReference

---

subscriptionType^Required

public readonly subscriptionType: string;

• Type: string

---

timeouts^Required

public readonly timeouts: ApigeeOrganizationTimeoutsOutputReference;

• Type: ApigeeOrganizationTimeoutsOutputReference

---

analyticsRegionInput^Optional

public readonly analyticsRegionInput: string;

• Type: string

---

apiConsumerDataEncryptionKeyNameInput^Optional

public readonly apiConsumerDataEncryptionKeyNameInput: string;

• Type: string

---

apiConsumerDataLocationInput^Optional

public readonly apiConsumerDataLocationInput: string;

• Type: string

---

authorizedNetworkInput^Optional

public readonly authorizedNetworkInput: string;

• Type: string

---

billingTypeInput^Optional

public readonly billingTypeInput: string;

• Type: string

---

controlPlaneEncryptionKeyNameInput^Optional

public readonly controlPlaneEncryptionKeyNameInput: string;

• Type: string

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

disableVpcPeeringInput^Optional

public readonly disableVpcPeeringInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

displayNameInput^Optional

public readonly displayNameInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

propertiesInput^Optional

public readonly propertiesInput: ApigeeOrganizationProperties;

• Type: ApigeeOrganizationProperties

---

retentionInput^Optional

public readonly retentionInput: string;

• Type: string

---

runtimeDatabaseEncryptionKeyNameInput^Optional

public readonly runtimeDatabaseEncryptionKeyNameInput: string;

• Type: string

---

runtimeTypeInput^Optional

public readonly runtimeTypeInput: string;

• Type: string

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | ApigeeOrganizationTimeouts;

• Type: cdktf.IResolvable | ApigeeOrganizationTimeouts

---

analyticsRegion^Required

public readonly analyticsRegion: string;

• Type: string

---

apiConsumerDataEncryptionKeyName^Required

public readonly apiConsumerDataEncryptionKeyName: string;

• Type: string

---

apiConsumerDataLocation^Required

public readonly apiConsumerDataLocation: string;

• Type: string

---

authorizedNetwork^Required

public readonly authorizedNetwork: string;

• Type: string

---

billingType^Required

public readonly billingType: string;

• Type: string

---

controlPlaneEncryptionKeyName^Required

public readonly controlPlaneEncryptionKeyName: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

disableVpcPeering^Required

public readonly disableVpcPeering: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

displayName^Required

public readonly displayName: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

projectId^Required

public readonly projectId: string;

• Type: string

---

retention^Required

public readonly retention: string;

• Type: string

---

runtimeDatabaseEncryptionKeyName^Required

public readonly runtimeDatabaseEncryptionKeyName: string;

• Type: string

---

runtimeType^Required

public readonly runtimeType: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApigeeOrganizationConfig

Initializer

import { apigeeOrganization } from '@cdktf/provider-google'

const apigeeOrganizationConfig: apigeeOrganization.ApigeeOrganizationConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
projectId	string	The project ID associated with the Apigee organization.
analyticsRegion	string	Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
apiConsumerDataEncryptionKeyName	string	Cloud KMS key name used for encrypting API consumer data.
apiConsumerDataLocation	string	This field is needed only for customers using non-default data residency regions.
authorizedNetwork	string	Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
billingType	string	Billing type of the Apigee organization. See Apigee pricing.
controlPlaneEncryptionKeyName	string	Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
description	string	Description of the Apigee organization.
disableVpcPeering	boolean | cdktf.IResolvable	Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
displayName	string	The display name of the Apigee organization.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#id ApigeeOrganization#id}.
properties	ApigeeOrganizationProperties	properties block.
retention	string	Optional.
runtimeDatabaseEncryptionKeyName	string	Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
runtimeType	string	Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].
timeouts	ApigeeOrganizationTimeouts	timeouts block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

projectId^Required

public readonly projectId: string;

• Type: string

The project ID associated with the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#project_id ApigeeOrganization#project_id}

---

analyticsRegion^Optional

public readonly analyticsRegion: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#analytics_region ApigeeOrganization#analytics_region}

---

apiConsumerDataEncryptionKeyName^Optional

public readonly apiConsumerDataEncryptionKeyName: string;

• Type: string

Cloud KMS key name used for encrypting API consumer data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#api_consumer_data_encryption_key_name ApigeeOrganization#api_consumer_data_encryption_key_name}

---

apiConsumerDataLocation^Optional

public readonly apiConsumerDataLocation: string;

• Type: string

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#api_consumer_data_location ApigeeOrganization#api_consumer_data_location}

---

authorizedNetwork^Optional

public readonly authorizedNetwork: string;

• Type: 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".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#authorized_network ApigeeOrganization#authorized_network}

---

billingType^Optional

public readonly billingType: string;

• Type: string

Billing type of the Apigee organization. See Apigee pricing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#billing_type ApigeeOrganization#billing_type}

---

controlPlaneEncryptionKeyName^Optional

public readonly controlPlaneEncryptionKeyName: string;

• Type: string

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#control_plane_encryption_key_name ApigeeOrganization#control_plane_encryption_key_name}

---

description^Optional

public readonly description: string;

• Type: string

Description of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#description ApigeeOrganization#description}

---

disableVpcPeering^Optional

public readonly disableVpcPeering: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.

Required if an 'authorizedNetwork' on the consumer project is not provided, in which case the flag should be set to 'true'. Valid only when 'RuntimeType' is set to CLOUD. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#disable_vpc_peering ApigeeOrganization#disable_vpc_peering}

---

displayName^Optional

public readonly displayName: string;

• Type: string

The display name of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#display_name ApigeeOrganization#display_name}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#id ApigeeOrganization#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

properties^Optional

public readonly properties: ApigeeOrganizationProperties;

• Type: ApigeeOrganizationProperties

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#properties ApigeeOrganization#properties}

---

retention^Optional

public readonly retention: string;

• Type: 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: "DELETION_RETENTION_UNSPECIFIED" Possible values: ["DELETION_RETENTION_UNSPECIFIED", "MINIMUM"]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#retention ApigeeOrganization#retention}

---

runtimeDatabaseEncryptionKeyName^Optional

public readonly runtimeDatabaseEncryptionKeyName: string;

• Type: string

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.

Update is not allowed after the organization is created. If not specified, a Google-Managed encryption key will be used. Valid only when 'RuntimeType' is CLOUD. For example: 'projects/foo/locations/us/keyRings/bar/cryptoKeys/baz'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#runtime_database_encryption_key_name ApigeeOrganization#runtime_database_encryption_key_name}

---

runtimeType^Optional

public readonly runtimeType: string;

• Type: string

Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#runtime_type ApigeeOrganization#runtime_type}

---

timeouts^Optional

public readonly timeouts: ApigeeOrganizationTimeouts;

• Type: ApigeeOrganizationTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#timeouts ApigeeOrganization#timeouts}

---

ApigeeOrganizationProperties

Initializer

import { apigeeOrganization } from '@cdktf/provider-google'

const apigeeOrganizationProperties: apigeeOrganization.ApigeeOrganizationProperties = { ... }

Properties

Name	Type	Description
property	cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]	property block.

---

property^Optional

public readonly property: IResolvable | ApigeeOrganizationPropertiesProperty[];

• Type: cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]

property block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#property ApigeeOrganization#property}

---

ApigeeOrganizationPropertiesProperty

Initializer

import { apigeeOrganization } from '@cdktf/provider-google'

const apigeeOrganizationPropertiesProperty: apigeeOrganization.ApigeeOrganizationPropertiesProperty = { ... }

Properties

Name	Type	Description
name	string	Name of the property.
value	string	Value of the property.

---

name^Optional

public readonly name: string;

• Type: string

Name of the property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#name ApigeeOrganization#name}

---

value^Optional

public readonly value: string;

• Type: string

Value of the property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#value ApigeeOrganization#value}

---

ApigeeOrganizationTimeouts

Initializer

import { apigeeOrganization } from '@cdktf/provider-google'

const apigeeOrganizationTimeouts: apigeeOrganization.ApigeeOrganizationTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#create ApigeeOrganization#create}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#delete ApigeeOrganization#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#update ApigeeOrganization#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#create ApigeeOrganization#create}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#delete ApigeeOrganization#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.15.0/docs/resources/apigee_organization#update ApigeeOrganization#update}.

---

Classes

ApigeeOrganizationPropertiesOutputReference

Initializers

import { apigeeOrganization } from '@cdktf/provider-google'

new apigeeOrganization.ApigeeOrganizationPropertiesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
putProperty	No description.
resetProperty	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putProperty

public putProperty(value: IResolvable | ApigeeOrganizationPropertiesProperty[]): void

value^Required

• Type: cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]

---

resetProperty

public resetProperty(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
property	ApigeeOrganizationPropertiesPropertyList	No description.
propertyInput	cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]	No description.
internalValue	ApigeeOrganizationProperties	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

property^Required

public readonly property: ApigeeOrganizationPropertiesPropertyList;

• Type: ApigeeOrganizationPropertiesPropertyList

---

propertyInput^Optional

public readonly propertyInput: IResolvable | ApigeeOrganizationPropertiesProperty[];

• Type: cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]

---

internalValue^Optional

public readonly internalValue: ApigeeOrganizationProperties;

• Type: ApigeeOrganizationProperties

---

ApigeeOrganizationPropertiesPropertyList

Initializers

import { apigeeOrganization } from '@cdktf/provider-google'

new apigeeOrganization.ApigeeOrganizationPropertiesPropertyList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ApigeeOrganizationPropertiesPropertyOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApigeeOrganizationPropertiesProperty[];

• Type: cdktf.IResolvable | ApigeeOrganizationPropertiesProperty[]

---

ApigeeOrganizationPropertiesPropertyOutputReference

Initializers

import { apigeeOrganization } from '@cdktf/provider-google'

new apigeeOrganization.ApigeeOrganizationPropertiesPropertyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetName	No description.
resetValue	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetName

public resetName(): void

resetValue

public resetValue(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
nameInput	string	No description.
valueInput	string	No description.
name	string	No description.
value	string	No description.
internalValue	cdktf.IResolvable | ApigeeOrganizationPropertiesProperty	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

valueInput^Optional

public readonly valueInput: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

value^Required

public readonly value: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApigeeOrganizationPropertiesProperty;

• Type: cdktf.IResolvable | ApigeeOrganizationPropertiesProperty

---

ApigeeOrganizationTimeoutsOutputReference

Initializers

import { apigeeOrganization } from '@cdktf/provider-google'

new apigeeOrganization.ApigeeOrganizationTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | ApigeeOrganizationTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApigeeOrganizationTimeouts;

• Type: cdktf.IResolvable | ApigeeOrganizationTimeouts

---