apigeeOrganization.python.md

apigeeOrganization Submodule

Constructs

ApigeeOrganization

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

Initializers

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganization(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  project_id: str,
  analytics_region: str = None,
  api_consumer_data_encryption_key_name: str = None,
  api_consumer_data_location: str = None,
  authorized_network: str = None,
  billing_type: str = None,
  control_plane_encryption_key_name: str = None,
  description: str = None,
  disable_vpc_peering: typing.Union[bool, IResolvable] = None,
  display_name: str = None,
  id: str = None,
  properties: ApigeeOrganizationProperties = None,
  retention: str = None,
  runtime_database_encryption_key_name: str = None,
  runtime_type: str = None,
  timeouts: ApigeeOrganizationTimeouts = None
)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	str	The scoped construct ID.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
project_id	str	The project ID associated with the Apigee organization.
analytics_region	str	Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
api_consumer_data_encryption_key_name	str	Cloud KMS key name used for encrypting API consumer data.
api_consumer_data_location	str	This field is needed only for customers using non-default data residency regions.
authorized_network	str	Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
billing_type	str	Billing type of the Apigee organization. See Apigee pricing.
control_plane_encryption_key_name	str	Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
description	str	Description of the Apigee organization.
disable_vpc_peering	typing.Union[bool, cdktf.IResolvable]	Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
display_name	str	The display name of the Apigee organization.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_organization#id ApigeeOrganization#id}.
properties	ApigeeOrganizationProperties	properties block.
retention	str	Optional.
runtime_database_encryption_key_name	str	Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
runtime_type	str	Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].
timeouts	ApigeeOrganizationTimeouts	timeouts block.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

connection^Optional

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

• Type: cdktf.TerraformProvider

---

provisioners^Optional

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

project_id^Required

• Type: str

The project ID associated with the Apigee organization.

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

---

analytics_region^Optional

• Type: str

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

---

api_consumer_data_encryption_key_name^Optional

• Type: str

Cloud KMS key name used for encrypting API consumer data.

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

---

api_consumer_data_location^Optional

• Type: str

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

---

authorized_network^Optional

• Type: str

Compute Engine network used for Service Networking to be peered with Apigee runtime instances.

See Getting started with the Service Networking API. Valid only when 'RuntimeType' is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default".

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

---

billing_type^Optional

• Type: str

Billing type of the Apigee organization. See Apigee pricing.

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

---

control_plane_encryption_key_name^Optional

• Type: str

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

---

description^Optional

• Type: str

Description of the Apigee organization.

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

---

disable_vpc_peering^Optional

• Type: typing.Union[bool, 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.14.1/docs/resources/apigee_organization#disable_vpc_peering ApigeeOrganization#disable_vpc_peering}

---

display_name^Optional

• Type: str

The display name of the Apigee organization.

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

---

id^Optional

• Type: str

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

• Type: ApigeeOrganizationProperties

properties block.

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

---

retention^Optional

• Type: str

Optional.

This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. Default value: "DELETION_RETENTION_UNSPECIFIED" Possible values: ["DELETION_RETENTION_UNSPECIFIED", "MINIMUM"]

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

---

runtime_database_encryption_key_name^Optional

• Type: str

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

---

runtime_type^Optional

• Type: str

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

---

timeouts^Optional

• Type: ApigeeOrganizationTimeouts

timeouts block.

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

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
add_override	No description.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id	Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform	No description.
to_metadata	No description.
to_terraform	Adds this resource to the terraform JSON output.
add_move_target	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
has_resource_move	No description.
import_from	No description.
interpolation_for_attribute	No description.
move_from_id	Move the resource corresponding to "id" to this resource.
move_to	Moves this resource to the target resource given by moveTarget.
move_to_id	Moves this resource to the resource corresponding to "id".
put_properties	No description.
put_timeouts	No description.
reset_analytics_region	No description.
reset_api_consumer_data_encryption_key_name	No description.
reset_api_consumer_data_location	No description.
reset_authorized_network	No description.
reset_billing_type	No description.
reset_control_plane_encryption_key_name	No description.
reset_description	No description.
reset_disable_vpc_peering	No description.
reset_display_name	No description.
reset_id	No description.
reset_properties	No description.
reset_retention	No description.
reset_runtime_database_encryption_key_name	No description.
reset_runtime_type	No description.
reset_timeouts	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

path^Required

• Type: str

---

value^Required

• Type: typing.Any

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

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

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

reset_override_logical_id

def reset_override_logical_id() -> None

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

to_hcl_terraform

def to_hcl_terraform() -> typing.Any

to_metadata

def to_metadata() -> typing.Any

to_terraform

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target

def add_move_target(
  move_target: str
) -> None

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

move_target^Required

• Type: str

The string move target that will correspond to this resource.

---

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

has_resource_move

def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]

import_from

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

id^Required

• Type: str

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolation_for_attribute

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

move_from_id

def move_from_id(
  id: str
) -> None

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: str

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

---

move_to

def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_target^Required

• Type: str

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

---

index^Optional

• Type: typing.Union[str, typing.Union[int, float]]

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

---

move_to_id

def move_to_id(
  id: str
) -> None

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

id^Required

• Type: str

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

---

put_properties

def put_properties(
  property: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]] = None
) -> None

property^Optional

• Type: typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

property block.

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

---

put_timeouts

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

create^Optional

• Type: str

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

---

delete^Optional

• Type: str

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

---

update^Optional

• Type: str

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

---

reset_analytics_region

def reset_analytics_region() -> None

reset_api_consumer_data_encryption_key_name

def reset_api_consumer_data_encryption_key_name() -> None

reset_api_consumer_data_location

def reset_api_consumer_data_location() -> None

reset_authorized_network

def reset_authorized_network() -> None

reset_billing_type

def reset_billing_type() -> None

reset_control_plane_encryption_key_name

def reset_control_plane_encryption_key_name() -> None

reset_description

def reset_description() -> None

reset_disable_vpc_peering

def reset_disable_vpc_peering() -> None

reset_display_name

def reset_display_name() -> None

reset_id

def reset_id() -> None

reset_properties

def reset_properties() -> None

reset_retention

def reset_retention() -> None

reset_runtime_database_encryption_key_name

def reset_runtime_database_encryption_key_name() -> None

reset_runtime_type

def reset_runtime_type() -> None

reset_timeouts

def reset_timeouts() -> None

Static Functions

Name	Description
is_construct	Checks if x is a construct.
is_terraform_element	No description.
is_terraform_resource	No description.
generate_config_for_import	Generates CDKTF code for importing a ApigeeOrganization resource upon running "cdktf plan ".

---

is_construct

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganization.is_construct(
  x: typing.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: typing.Any

Any object.

---

is_terraform_element

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganization.is_terraform_element(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

is_terraform_resource

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganization.is_terraform_resource(
  x: typing.Any
)

x^Required

• Type: typing.Any

---

generate_config_for_import

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganization.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

---

import_to_id^Required

• Type: str

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

---

import_from_id^Required

• Type: str

The id of the existing ApigeeOrganization that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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.
cdktf_stack	cdktf.TerraformStack	No description.
fqn	str	No description.
friendly_unique_id	str	No description.
terraform_meta_arguments	typing.Mapping[typing.Any]	No description.
terraform_resource_type	str	No description.
terraform_generator_metadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[str]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
apigee_project_id	str	No description.
ca_certificate	str	No description.
name	str	No description.
properties	ApigeeOrganizationPropertiesOutputReference	No description.
subscription_type	str	No description.
timeouts	ApigeeOrganizationTimeoutsOutputReference	No description.
analytics_region_input	str	No description.
api_consumer_data_encryption_key_name_input	str	No description.
api_consumer_data_location_input	str	No description.
authorized_network_input	str	No description.
billing_type_input	str	No description.
control_plane_encryption_key_name_input	str	No description.
description_input	str	No description.
disable_vpc_peering_input	typing.Union[bool, cdktf.IResolvable]	No description.
display_name_input	str	No description.
id_input	str	No description.
project_id_input	str	No description.
properties_input	ApigeeOrganizationProperties	No description.
retention_input	str	No description.
runtime_database_encryption_key_name_input	str	No description.
runtime_type_input	str	No description.
timeouts_input	typing.Union[cdktf.IResolvable, ApigeeOrganizationTimeouts]	No description.
analytics_region	str	No description.
api_consumer_data_encryption_key_name	str	No description.
api_consumer_data_location	str	No description.
authorized_network	str	No description.
billing_type	str	No description.
control_plane_encryption_key_name	str	No description.
description	str	No description.
disable_vpc_peering	typing.Union[bool, cdktf.IResolvable]	No description.
display_name	str	No description.
id	str	No description.
project_id	str	No description.
retention	str	No description.
runtime_database_encryption_key_name	str	No description.
runtime_type	str	No description.

---

node^Required

node: Node

• Type: constructs.Node

The tree node.

---

cdktf_stack^Required

cdktf_stack: TerraformStack

• Type: cdktf.TerraformStack

---

fqn^Required

fqn: str

• Type: str

---

friendly_unique_id^Required

friendly_unique_id: str

• Type: str

---

terraform_meta_arguments^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

• Type: typing.Mapping[typing.Any]

---

terraform_resource_type^Required

terraform_resource_type: str

• Type: str

---

terraform_generator_metadata^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[str]

• Type: typing.List[str]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

apigee_project_id^Required

apigee_project_id: str

• Type: str

---

ca_certificate^Required

ca_certificate: str

• Type: str

---

name^Required

name: str

• Type: str

---

properties^Required

properties: ApigeeOrganizationPropertiesOutputReference

• Type: ApigeeOrganizationPropertiesOutputReference

---

subscription_type^Required

subscription_type: str

• Type: str

---

timeouts^Required

timeouts: ApigeeOrganizationTimeoutsOutputReference

• Type: ApigeeOrganizationTimeoutsOutputReference

---

analytics_region_input^Optional

analytics_region_input: str

• Type: str

---

api_consumer_data_encryption_key_name_input^Optional

api_consumer_data_encryption_key_name_input: str

• Type: str

---

api_consumer_data_location_input^Optional

api_consumer_data_location_input: str

• Type: str

---

authorized_network_input^Optional

authorized_network_input: str

• Type: str

---

billing_type_input^Optional

billing_type_input: str

• Type: str

---

control_plane_encryption_key_name_input^Optional

control_plane_encryption_key_name_input: str

• Type: str

---

description_input^Optional

description_input: str

• Type: str

---

disable_vpc_peering_input^Optional

disable_vpc_peering_input: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, cdktf.IResolvable]

---

display_name_input^Optional

display_name_input: str

• Type: str

---

id_input^Optional

id_input: str

• Type: str

---

project_id_input^Optional

project_id_input: str

• Type: str

---

properties_input^Optional

properties_input: ApigeeOrganizationProperties

• Type: ApigeeOrganizationProperties

---

retention_input^Optional

retention_input: str

• Type: str

---

runtime_database_encryption_key_name_input^Optional

runtime_database_encryption_key_name_input: str

• Type: str

---

runtime_type_input^Optional

runtime_type_input: str

• Type: str

---

timeouts_input^Optional

timeouts_input: typing.Union[IResolvable, ApigeeOrganizationTimeouts]

• Type: typing.Union[cdktf.IResolvable, ApigeeOrganizationTimeouts]

---

analytics_region^Required

analytics_region: str

• Type: str

---

api_consumer_data_encryption_key_name^Required

api_consumer_data_encryption_key_name: str

• Type: str

---

api_consumer_data_location^Required

api_consumer_data_location: str

• Type: str

---

authorized_network^Required

authorized_network: str

• Type: str

---

billing_type^Required

billing_type: str

• Type: str

---

control_plane_encryption_key_name^Required

control_plane_encryption_key_name: str

• Type: str

---

description^Required

description: str

• Type: str

---

disable_vpc_peering^Required

disable_vpc_peering: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, cdktf.IResolvable]

---

display_name^Required

display_name: str

• Type: str

---

id^Required

id: str

• Type: str

---

project_id^Required

project_id: str

• Type: str

---

retention^Required

retention: str

• Type: str

---

runtime_database_encryption_key_name^Required

runtime_database_encryption_key_name: str

• Type: str

---

runtime_type^Required

runtime_type: str

• Type: str

---

Constants

Name	Type	Description
tfResourceType	str	No description.

---

tfResourceType^Required

tfResourceType: str

• Type: str

---

Structs

ApigeeOrganizationConfig

Initializer

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  project_id: str,
  analytics_region: str = None,
  api_consumer_data_encryption_key_name: str = None,
  api_consumer_data_location: str = None,
  authorized_network: str = None,
  billing_type: str = None,
  control_plane_encryption_key_name: str = None,
  description: str = None,
  disable_vpc_peering: typing.Union[bool, IResolvable] = None,
  display_name: str = None,
  id: str = None,
  properties: ApigeeOrganizationProperties = None,
  retention: str = None,
  runtime_database_encryption_key_name: str = None,
  runtime_type: str = None,
  timeouts: ApigeeOrganizationTimeouts = None
)

Properties

Name	Type	Description
connection	typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]	No description.
count	typing.Union[typing.Union[int, float], cdktf.TerraformCount]	No description.
depends_on	typing.List[cdktf.ITerraformDependable]	No description.
for_each	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]	No description.
project_id	str	The project ID associated with the Apigee organization.
analytics_region	str	Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
api_consumer_data_encryption_key_name	str	Cloud KMS key name used for encrypting API consumer data.
api_consumer_data_location	str	This field is needed only for customers using non-default data residency regions.
authorized_network	str	Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
billing_type	str	Billing type of the Apigee organization. See Apigee pricing.
control_plane_encryption_key_name	str	Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
description	str	Description of the Apigee organization.
disable_vpc_peering	typing.Union[bool, cdktf.IResolvable]	Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
display_name	str	The display name of the Apigee organization.
id	str	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_organization#id ApigeeOrganization#id}.
properties	ApigeeOrganizationProperties	properties block.
retention	str	Optional.
runtime_database_encryption_key_name	str	Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
runtime_type	str	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: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]

• Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]

---

count^Optional

count: typing.Union[typing.Union[int, float], TerraformCount]

• Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]

---

depends_on^Optional

depends_on: typing.List[ITerraformDependable]

• Type: typing.List[cdktf.ITerraformDependable]

---

for_each^Optional

for_each: ITerraformIterator

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

lifecycle: TerraformResourceLifecycle

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

provider: TerraformProvider

• Type: cdktf.TerraformProvider

---

provisioners^Optional

provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]

• Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]

---

project_id^Required

project_id: str

• Type: str

The project ID associated with the Apigee organization.

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

---

analytics_region^Optional

analytics_region: str

• Type: str

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

---

api_consumer_data_encryption_key_name^Optional

api_consumer_data_encryption_key_name: str

• Type: str

Cloud KMS key name used for encrypting API consumer data.

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

---

api_consumer_data_location^Optional

api_consumer_data_location: str

• Type: str

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

---

authorized_network^Optional

authorized_network: str

• Type: str

Compute Engine network used for Service Networking to be peered with Apigee runtime instances.

See Getting started with the Service Networking API. Valid only when 'RuntimeType' is set to CLOUD. The value can be updated only when there are no runtime instances. For example: "default".

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

---

billing_type^Optional

billing_type: str

• Type: str

Billing type of the Apigee organization. See Apigee pricing.

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

---

control_plane_encryption_key_name^Optional

control_plane_encryption_key_name: str

• Type: str

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

---

description^Optional

description: str

• Type: str

Description of the Apigee organization.

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

---

disable_vpc_peering^Optional

disable_vpc_peering: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, 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.14.1/docs/resources/apigee_organization#disable_vpc_peering ApigeeOrganization#disable_vpc_peering}

---

display_name^Optional

display_name: str

• Type: str

The display name of the Apigee organization.

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

---

id^Optional

id: str

• Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/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.14.1/docs/resources/apigee_organization#properties ApigeeOrganization#properties}

---

retention^Optional

retention: str

• Type: str

Optional.

This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. Default value: "DELETION_RETENTION_UNSPECIFIED" Possible values: ["DELETION_RETENTION_UNSPECIFIED", "MINIMUM"]

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

---

runtime_database_encryption_key_name^Optional

runtime_database_encryption_key_name: str

• Type: str

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

---

runtime_type^Optional

runtime_type: str

• Type: str

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

---

ApigeeOrganizationProperties

Initializer

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationProperties(
  property: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]] = None
)

Properties

Name	Type	Description
property	typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]	property block.

---

property^Optional

property: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

• Type: typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

property block.

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

---

ApigeeOrganizationPropertiesProperty

Initializer

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationPropertiesProperty(
  name: str = None,
  value: str = None
)

Properties

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

---

name^Optional

name: str

• Type: str

Name of the property.

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

---

value^Optional

value: str

• Type: str

Value of the property.

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

---

ApigeeOrganizationTimeouts

Initializer

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

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

---

create^Optional

create: str

• Type: str

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

---

delete^Optional

delete: str

• Type: str

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

---

update^Optional

update: str

• Type: str

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

---

Classes

ApigeeOrganizationPropertiesOutputReference

Initializers

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationPropertiesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
put_property	No description.
reset_property	No description.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

put_property

def put_property(
  value: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]
) -> None

value^Required

• Type: typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

---

reset_property

def reset_property() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
property	ApigeeOrganizationPropertiesPropertyList	No description.
property_input	typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]	No description.
internal_value	ApigeeOrganizationProperties	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

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

fqn: str

• Type: str

---

property^Required

property: ApigeeOrganizationPropertiesPropertyList

• Type: ApigeeOrganizationPropertiesPropertyList

---

property_input^Optional

property_input: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

• Type: typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

---

internal_value^Optional

internal_value: ApigeeOrganizationProperties

• Type: ApigeeOrganizationProperties

---

ApigeeOrganizationPropertiesPropertyList

Initializers

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationPropertiesPropertyList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.
wraps_set	bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

wraps_set^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
all_with_map_key	Creating an iterator for this complex list.
compute_fqn	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
get	No description.

---

all_with_map_key

def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

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

map_key_attribute_name^Required

• Type: str

---

compute_fqn

def compute_fqn() -> str

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

def get(
  index: typing.Union[int, float]
) -> ApigeeOrganizationPropertiesPropertyOutputReference

index^Required

• Type: typing.Union[int, float]

the index of the item to return.

---

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
internal_value	typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

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

fqn: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

• Type: typing.Union[cdktf.IResolvable, typing.List[ApigeeOrganizationPropertiesProperty]]

---

ApigeeOrganizationPropertiesPropertyOutputReference

Initializers

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationPropertiesPropertyOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.
complex_object_index	typing.Union[int, float]	the index of this item in the list.
complex_object_is_from_set	bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

complex_object_index^Required

• Type: typing.Union[int, float]

the index of this item in the list.

---

complex_object_is_from_set^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
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
reset_name	No description.
reset_value	No description.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_name

def reset_name() -> None

reset_value

def reset_value() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
name_input	str	No description.
value_input	str	No description.
name	str	No description.
value	str	No description.
internal_value	typing.Union[cdktf.IResolvable, ApigeeOrganizationPropertiesProperty]	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

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

fqn: str

• Type: str

---

name_input^Optional

name_input: str

• Type: str

---

value_input^Optional

value_input: str

• Type: str

---

name^Required

name: str

• Type: str

---

value^Required

value: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, ApigeeOrganizationPropertiesProperty]

• Type: typing.Union[cdktf.IResolvable, ApigeeOrganizationPropertiesProperty]

---

ApigeeOrganizationTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google import apigee_organization

apigeeOrganization.ApigeeOrganizationTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
terraform_resource	cdktf.IInterpolatingParent	The parent resource.
terraform_attribute	str	The attribute on the parent resource this class is referencing.

---

terraform_resource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraform_attribute^Required

• Type: str

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
compute_fqn	No description.
get_any_map_attribute	No description.
get_boolean_attribute	No description.
get_boolean_map_attribute	No description.
get_list_attribute	No description.
get_number_attribute	No description.
get_number_list_attribute	No description.
get_number_map_attribute	No description.
get_string_attribute	No description.
get_string_map_attribute	No description.
interpolation_for_attribute	No description.
resolve	Produce the Token's value at resolution time.
to_string	Return a string representation of this resolvable object.
reset_create	No description.
reset_delete	No description.
reset_update	No description.

---

compute_fqn

def compute_fqn() -> str

get_any_map_attribute

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

terraform_attribute^Required

• Type: str

---

get_boolean_attribute

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

terraform_attribute^Required

• Type: str

---

get_boolean_map_attribute

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

terraform_attribute^Required

• Type: str

---

get_list_attribute

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

terraform_attribute^Required

• Type: str

---

get_number_attribute

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

terraform_attribute^Required

• Type: str

---

get_number_list_attribute

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_number_map_attribute

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

terraform_attribute^Required

• Type: str

---

get_string_attribute

def get_string_attribute(
  terraform_attribute: str
) -> str

terraform_attribute^Required

• Type: str

---

get_string_map_attribute

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

terraform_attribute^Required

• Type: str

---

interpolation_for_attribute

def interpolation_for_attribute(
  property: str
) -> IResolvable

property^Required

• Type: str

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

to_string

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_create

def reset_create() -> None

reset_delete

def reset_delete() -> None

reset_update

def reset_update() -> None

Properties

Name	Type	Description
creation_stack	typing.List[str]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	str	No description.
create_input	str	No description.
delete_input	str	No description.
update_input	str	No description.
create	str	No description.
delete	str	No description.
update	str	No description.
internal_value	typing.Union[cdktf.IResolvable, ApigeeOrganizationTimeouts]	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

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

fqn: str

• Type: str

---

create_input^Optional

create_input: str

• Type: str

---

delete_input^Optional

delete_input: str

• Type: str

---

update_input^Optional

update_input: str

• Type: str

---

create^Required

create: str

• Type: str

---

delete^Required

delete: str

• Type: str

---

update^Required

update: str

• Type: str

---

internal_value^Optional

internal_value: typing.Union[IResolvable, ApigeeOrganizationTimeouts]

• Type: typing.Union[cdktf.IResolvable, ApigeeOrganizationTimeouts]

---