apigeeOrganization.go.md

apigeeOrganization Submodule

Constructs

ApigeeOrganization

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

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.NewApigeeOrganization(scope Construct, id *string, config ApigeeOrganizationConfig) ApigeeOrganization

Name	Type	Description
scope	github.com/aws/constructs-go/constructs/v10.Construct	The scope in which to define this construct.
id	*string	The scoped construct ID.
config	ApigeeOrganizationConfig	No description.

---

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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

func ToString() *string

Returns a string representation of this construct.

AddOverride

func AddOverride(path *string, value interface{})

path^Required

• Type: *string

---

value^Required

• Type: interface{}

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func ResetOverrideLogicalId()

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

ToHclTerraform

func ToHclTerraform() interface{}

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget

func AddMoveTarget(moveTarget *string)

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

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

HasResourceMove

func HasResourceMove() interface{}

ImportFrom

func ImportFrom(id *string, provider TerraformProvider)

id^Required

• Type: *string

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

InterpolationForAttribute

func InterpolationForAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

MoveFromId

func MoveFromId(id *string)

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

func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

---

MoveToId

func MoveToId(id *string)

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

func PutProperties(value ApigeeOrganizationProperties)

value^Required

• Type: ApigeeOrganizationProperties

---

PutTimeouts

func PutTimeouts(value ApigeeOrganizationTimeouts)

value^Required

• Type: ApigeeOrganizationTimeouts

---

ResetAnalyticsRegion

func ResetAnalyticsRegion()

ResetApiConsumerDataEncryptionKeyName

func ResetApiConsumerDataEncryptionKeyName()

ResetApiConsumerDataLocation

func ResetApiConsumerDataLocation()

ResetAuthorizedNetwork

func ResetAuthorizedNetwork()

ResetBillingType

func ResetBillingType()

ResetControlPlaneEncryptionKeyName

func ResetControlPlaneEncryptionKeyName()

ResetDescription

func ResetDescription()

ResetDisableVpcPeering

func ResetDisableVpcPeering()

ResetDisplayName

func ResetDisplayName()

ResetId

func ResetId()

ResetProperties

func ResetProperties()

ResetRetention

func ResetRetention()

ResetRuntimeDatabaseEncryptionKeyName

func ResetRuntimeDatabaseEncryptionKeyName()

ResetRuntimeType

func ResetRuntimeType()

ResetTimeouts

func ResetTimeouts()

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 "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.ApigeeOrganization_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

---

IsTerraformElement

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.ApigeeOrganization_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

---

IsTerraformResource

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.ApigeeOrganization_IsTerraformResource(x interface{}) *bool

x^Required

• Type: interface{}

---

GenerateConfigForImport

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.ApigeeOrganization_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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.6.0/docs/resources/apigee_organization#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	github.com/aws/constructs-go/constructs/v10.Node	The tree node.
CdktfStack	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack	No description.
Fqn	*string	No description.
FriendlyUniqueId	*string	No description.
TerraformMetaArguments	*map[string]interface{}	No description.
TerraformResourceType	*string	No description.
TerraformGeneratorMetadata	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]*string	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	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	interface{}	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	interface{}	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	interface{}	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

func Node() Node

• Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

---

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

---

Fqn^Required

func Fqn() *string

• Type: *string

---

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

---

TerraformMetaArguments^Required

func TerraformMetaArguments() *map[string]interface{}

• Type: *map[string]interface{}

---

TerraformResourceType^Required

func TerraformResourceType() *string

• Type: *string

---

TerraformGeneratorMetadata^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

func Connection() interface{}

• Type: interface{}

---

Count^Optional

func Count() interface{}

• Type: interface{}

---

DependsOn^Optional

func DependsOn() *[]*string

• Type: *[]*string

---

ForEach^Optional

func ForEach() ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

func Lifecycle() TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

func Provider() TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

func Provisioners() *[]interface{}

• Type: *[]interface{}

---

ApigeeProjectId^Required

func ApigeeProjectId() *string

• Type: *string

---

CaCertificate^Required

func CaCertificate() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Properties^Required

func Properties() ApigeeOrganizationPropertiesOutputReference

• Type: ApigeeOrganizationPropertiesOutputReference

---

SubscriptionType^Required

func SubscriptionType() *string

• Type: *string

---

Timeouts^Required

func Timeouts() ApigeeOrganizationTimeoutsOutputReference

• Type: ApigeeOrganizationTimeoutsOutputReference

---

AnalyticsRegionInput^Optional

func AnalyticsRegionInput() *string

• Type: *string

---

ApiConsumerDataEncryptionKeyNameInput^Optional

func ApiConsumerDataEncryptionKeyNameInput() *string

• Type: *string

---

ApiConsumerDataLocationInput^Optional

func ApiConsumerDataLocationInput() *string

• Type: *string

---

AuthorizedNetworkInput^Optional

func AuthorizedNetworkInput() *string

• Type: *string

---

BillingTypeInput^Optional

func BillingTypeInput() *string

• Type: *string

---

ControlPlaneEncryptionKeyNameInput^Optional

func ControlPlaneEncryptionKeyNameInput() *string

• Type: *string

---

DescriptionInput^Optional

func DescriptionInput() *string

• Type: *string

---

DisableVpcPeeringInput^Optional

func DisableVpcPeeringInput() interface{}

• Type: interface{}

---

DisplayNameInput^Optional

func DisplayNameInput() *string

• Type: *string

---

IdInput^Optional

func IdInput() *string

• Type: *string

---

ProjectIdInput^Optional

func ProjectIdInput() *string

• Type: *string

---

PropertiesInput^Optional

func PropertiesInput() ApigeeOrganizationProperties

• Type: ApigeeOrganizationProperties

---

RetentionInput^Optional

func RetentionInput() *string

• Type: *string

---

RuntimeDatabaseEncryptionKeyNameInput^Optional

func RuntimeDatabaseEncryptionKeyNameInput() *string

• Type: *string

---

RuntimeTypeInput^Optional

func RuntimeTypeInput() *string

• Type: *string

---

TimeoutsInput^Optional

func TimeoutsInput() interface{}

• Type: interface{}

---

AnalyticsRegion^Required

func AnalyticsRegion() *string

• Type: *string

---

ApiConsumerDataEncryptionKeyName^Required

func ApiConsumerDataEncryptionKeyName() *string

• Type: *string

---

ApiConsumerDataLocation^Required

func ApiConsumerDataLocation() *string

• Type: *string

---

AuthorizedNetwork^Required

func AuthorizedNetwork() *string

• Type: *string

---

BillingType^Required

func BillingType() *string

• Type: *string

---

ControlPlaneEncryptionKeyName^Required

func ControlPlaneEncryptionKeyName() *string

• Type: *string

---

Description^Required

func Description() *string

• Type: *string

---

DisableVpcPeering^Required

func DisableVpcPeering() interface{}

• Type: interface{}

---

DisplayName^Required

func DisplayName() *string

• Type: *string

---

Id^Required

func Id() *string

• Type: *string

---

ProjectId^Required

func ProjectId() *string

• Type: *string

---

Retention^Required

func Retention() *string

• Type: *string

---

RuntimeDatabaseEncryptionKeyName^Required

func RuntimeDatabaseEncryptionKeyName() *string

• Type: *string

---

RuntimeType^Required

func RuntimeType() *string

• Type: *string

---

Constants

Name	Type	Description
TfResourceType	*string	No description.

---

TfResourceType^Required

func TfResourceType() *string

• Type: *string

---

Structs

ApigeeOrganizationConfig

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

&apigeeorganization.ApigeeOrganizationConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	ProjectId: *string,
	AnalyticsRegion: *string,
	ApiConsumerDataEncryptionKeyName: *string,
	ApiConsumerDataLocation: *string,
	AuthorizedNetwork: *string,
	BillingType: *string,
	ControlPlaneEncryptionKeyName: *string,
	Description: *string,
	DisableVpcPeering: interface{},
	DisplayName: *string,
	Id: *string,
	Properties: github.com/cdktf/cdktf-provider-google-go/google/v14.apigeeOrganization.ApigeeOrganizationProperties,
	Retention: *string,
	RuntimeDatabaseEncryptionKeyName: *string,
	RuntimeType: *string,
	Timeouts: github.com/cdktf/cdktf-provider-google-go/google/v14.apigeeOrganization.ApigeeOrganizationTimeouts,
}

Properties

Name	Type	Description
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	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	interface{}	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.6.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

Connection interface{}

• Type: interface{}

---

Count^Optional

Count interface{}

• Type: interface{}

---

DependsOn^Optional

DependsOn *[]ITerraformDependable

• Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

---

ForEach^Optional

ForEach ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

Lifecycle TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

Provider TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

Provisioners *[]interface{}

• Type: *[]interface{}

---

ProjectId^Required

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.6.0/docs/resources/apigee_organization#project_id ApigeeOrganization#project_id}

---

AnalyticsRegion^Optional

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.6.0/docs/resources/apigee_organization#analytics_region ApigeeOrganization#analytics_region}

---

ApiConsumerDataEncryptionKeyName^Optional

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.6.0/docs/resources/apigee_organization#api_consumer_data_encryption_key_name ApigeeOrganization#api_consumer_data_encryption_key_name}

---

ApiConsumerDataLocation^Optional

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.6.0/docs/resources/apigee_organization#api_consumer_data_location ApigeeOrganization#api_consumer_data_location}

---

AuthorizedNetwork^Optional

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.6.0/docs/resources/apigee_organization#authorized_network ApigeeOrganization#authorized_network}

---

BillingType^Optional

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.6.0/docs/resources/apigee_organization#billing_type ApigeeOrganization#billing_type}

---

ControlPlaneEncryptionKeyName^Optional

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.6.0/docs/resources/apigee_organization#control_plane_encryption_key_name ApigeeOrganization#control_plane_encryption_key_name}

---

Description^Optional

Description *string

• Type: *string

Description of the Apigee organization.

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

---

DisableVpcPeering^Optional

DisableVpcPeering interface{}

• Type: interface{}

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.6.0/docs/resources/apigee_organization#disable_vpc_peering ApigeeOrganization#disable_vpc_peering}

---

DisplayName^Optional

DisplayName *string

• Type: *string

The display name of the Apigee organization.

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

---

Id^Optional

Id *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.6.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

Properties ApigeeOrganizationProperties

• Type: ApigeeOrganizationProperties

properties block.

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

---

Retention^Optional

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.6.0/docs/resources/apigee_organization#retention ApigeeOrganization#retention}

---

RuntimeDatabaseEncryptionKeyName^Optional

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.6.0/docs/resources/apigee_organization#runtime_database_encryption_key_name ApigeeOrganization#runtime_database_encryption_key_name}

---

RuntimeType^Optional

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.6.0/docs/resources/apigee_organization#runtime_type ApigeeOrganization#runtime_type}

---

Timeouts^Optional

Timeouts ApigeeOrganizationTimeouts

• Type: ApigeeOrganizationTimeouts

timeouts block.

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

---

ApigeeOrganizationProperties

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

&apigeeorganization.ApigeeOrganizationProperties {
	Property: interface{},
}

Properties

Name	Type	Description
Property	interface{}	property block.

---

Property^Optional

Property interface{}

• Type: interface{}

property block.

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

---

ApigeeOrganizationPropertiesProperty

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

&apigeeorganization.ApigeeOrganizationPropertiesProperty {
	Name: *string,
	Value: *string,
}

Properties

Name	Type	Description
Name	*string	Name of the property.
Value	*string	Value of the property.

---

Name^Optional

Name *string

• Type: *string

Name of the property.

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

---

Value^Optional

Value *string

• Type: *string

Value of the property.

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

---

ApigeeOrganizationTimeouts

Initializer

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

&apigeeorganization.ApigeeOrganizationTimeouts {
	Create: *string,
	Delete: *string,
	Update: *string,
}

Properties

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

---

Create^Optional

Create *string

• Type: *string

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

---

Delete^Optional

Delete *string

• Type: *string

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

---

Update^Optional

Update *string

• Type: *string

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

---

Classes

ApigeeOrganizationPropertiesOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.NewApigeeOrganizationPropertiesOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) ApigeeOrganizationPropertiesOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

PutProperty

func PutProperty(value interface{})

value^Required

• Type: interface{}

---

ResetProperty

func ResetProperty()

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	interface{}	No description.
InternalValue	ApigeeOrganizationProperties	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

Property^Required

func Property() ApigeeOrganizationPropertiesPropertyList

• Type: ApigeeOrganizationPropertiesPropertyList

---

PropertyInput^Optional

func PropertyInput() interface{}

• Type: interface{}

---

InternalValue^Optional

func InternalValue() ApigeeOrganizationProperties

• Type: ApigeeOrganizationProperties

---

ApigeeOrganizationPropertiesPropertyList

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.NewApigeeOrganizationPropertiesPropertyList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ApigeeOrganizationPropertiesPropertyList

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
wrapsSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: *bool

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

func 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

func ComputeFqn() *string

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get

func Get(index *f64) ApigeeOrganizationPropertiesPropertyOutputReference

index^Required

• Type: *f64

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

ApigeeOrganizationPropertiesPropertyOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.NewApigeeOrganizationPropertiesPropertyOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) ApigeeOrganizationPropertiesPropertyOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
complexObjectIndex	*f64	the index of this item in the list.
complexObjectIsFromSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: *f64

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: *bool

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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetName

func ResetName()

ResetValue

func ResetValue()

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

ValueInput^Optional

func ValueInput() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Value^Required

func Value() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

ApigeeOrganizationTimeoutsOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-google-go/google/v14/apigeeorganization"

apigeeorganization.NewApigeeOrganizationTimeoutsOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string) ApigeeOrganizationTimeoutsOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate

func ResetCreate()

ResetDelete

func ResetDelete()

ResetUpdate

func ResetUpdate()

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

CreateInput^Optional

func CreateInput() *string

• Type: *string

---

DeleteInput^Optional

func DeleteInput() *string

• Type: *string

---

UpdateInput^Optional

func UpdateInput() *string

• Type: *string

---

Create^Required

func Create() *string

• Type: *string

---

Delete^Required

func Delete() *string

• Type: *string

---

Update^Required

func Update() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---