Skip to content

Latest commit

 

History

History
3109 lines (1937 loc) · 162 KB

googleApigeeOrganization.java.md

File metadata and controls

3109 lines (1937 loc) · 162 KB
Raw

googleApigeeOrganization Submodule

Constructs

GoogleApigeeOrganization

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

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganization;

GoogleApigeeOrganization.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .projectId(java.lang.String)
//  .analyticsRegion(java.lang.String)
//  .apiConsumerDataEncryptionKeyName(java.lang.String)
//  .apiConsumerDataLocation(java.lang.String)
//  .authorizedNetwork(java.lang.String)
//  .billingType(java.lang.String)
//  .controlPlaneEncryptionKeyName(java.lang.String)
//  .description(java.lang.String)
//  .disableVpcPeering(java.lang.Boolean)
//  .disableVpcPeering(IResolvable)
//  .displayName(java.lang.String)
//  .id(java.lang.String)
//  .properties(GoogleApigeeOrganizationProperties)
//  .retention(java.lang.String)
//  .runtimeDatabaseEncryptionKeyName(java.lang.String)
//  .runtimeType(java.lang.String)
//  .timeouts(GoogleApigeeOrganizationTimeouts)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
projectId java.lang.String The project ID associated with the Apigee organization.
analyticsRegion java.lang.String Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
apiConsumerDataEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting API consumer data.
apiConsumerDataLocation java.lang.String This field is needed only for customers using non-default data residency regions.
authorizedNetwork java.lang.String Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
billingType java.lang.String Billing type of the Apigee organization. See Apigee pricing.
controlPlaneEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
description java.lang.String Description of the Apigee organization.
disableVpcPeering java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
displayName java.lang.String The display name of the Apigee organization.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#id GoogleApigeeOrganization#id}.
properties GoogleApigeeOrganizationProperties properties block.
retention java.lang.String Optional.
runtimeDatabaseEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
runtimeType java.lang.String Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].
timeouts GoogleApigeeOrganizationTimeouts timeouts block.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
projectIdRequired
  • Type: java.lang.String

The project ID associated with the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#project_id GoogleApigeeOrganization#project_id}

analyticsRegionOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#analytics_region GoogleApigeeOrganization#analytics_region}

apiConsumerDataEncryptionKeyNameOptional
  • Type: java.lang.String

Cloud KMS key name used for encrypting API consumer data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#api_consumer_data_encryption_key_name GoogleApigeeOrganization#api_consumer_data_encryption_key_name}

apiConsumerDataLocationOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#api_consumer_data_location GoogleApigeeOrganization#api_consumer_data_location}

authorizedNetworkOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#authorized_network GoogleApigeeOrganization#authorized_network}

billingTypeOptional
  • Type: java.lang.String

Billing type of the Apigee organization. See Apigee pricing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#billing_type GoogleApigeeOrganization#billing_type}

controlPlaneEncryptionKeyNameOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#control_plane_encryption_key_name GoogleApigeeOrganization#control_plane_encryption_key_name}

descriptionOptional
  • Type: java.lang.String

Description of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#description GoogleApigeeOrganization#description}

disableVpcPeeringOptional
  • Type: java.lang.Boolean OR com.hashicorp.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-beta/6.14.1/docs/resources/google_apigee_organization#disable_vpc_peering GoogleApigeeOrganization#disable_vpc_peering}

displayNameOptional
  • Type: java.lang.String

The display name of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#display_name GoogleApigeeOrganization#display_name}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#id GoogleApigeeOrganization#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.

propertiesOptional

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#properties GoogleApigeeOrganization#properties}

retentionOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#retention GoogleApigeeOrganization#retention}

runtimeDatabaseEncryptionKeyNameOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#runtime_database_encryption_key_name GoogleApigeeOrganization#runtime_database_encryption_key_name}

runtimeTypeOptional
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#runtime_type GoogleApigeeOrganization#runtime_type}

timeoutsOptional

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#timeouts GoogleApigeeOrganization#timeouts}

Methods

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

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putProperties 
public void putProperties(GoogleApigeeOrganizationProperties value)
valueRequired
putTimeouts 
public void putTimeouts(GoogleApigeeOrganizationTimeouts value)
valueRequired
resetAnalyticsRegion 
public void resetAnalyticsRegion()
resetApiConsumerDataEncryptionKeyName 
public void resetApiConsumerDataEncryptionKeyName()
resetApiConsumerDataLocation 
public void resetApiConsumerDataLocation()
resetAuthorizedNetwork 
public void resetAuthorizedNetwork()
resetBillingType 
public void resetBillingType()
resetControlPlaneEncryptionKeyName 
public void resetControlPlaneEncryptionKeyName()
resetDescription 
public void resetDescription()
resetDisableVpcPeering 
public void resetDisableVpcPeering()
resetDisplayName 
public void resetDisplayName()
resetId 
public void resetId()
resetProperties 
public void resetProperties()
resetRetention 
public void resetRetention()
resetRuntimeDatabaseEncryptionKeyName 
public void resetRuntimeDatabaseEncryptionKeyName()
resetRuntimeType 
public void resetRuntimeType()
resetTimeouts 
public void 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 GoogleApigeeOrganization resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganization;

GoogleApigeeOrganization.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganization;

GoogleApigeeOrganization.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganization;

GoogleApigeeOrganization.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganization;

GoogleApigeeOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GoogleApigeeOrganization.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing GoogleApigeeOrganization that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
apigeeProjectId java.lang.String No description.
caCertificate java.lang.String No description.
name java.lang.String No description.
properties GoogleApigeeOrganizationPropertiesOutputReference No description.
subscriptionType java.lang.String No description.
timeouts GoogleApigeeOrganizationTimeoutsOutputReference No description.
analyticsRegionInput java.lang.String No description.
apiConsumerDataEncryptionKeyNameInput java.lang.String No description.
apiConsumerDataLocationInput java.lang.String No description.
authorizedNetworkInput java.lang.String No description.
billingTypeInput java.lang.String No description.
controlPlaneEncryptionKeyNameInput java.lang.String No description.
descriptionInput java.lang.String No description.
disableVpcPeeringInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
displayNameInput java.lang.String No description.
idInput java.lang.String No description.
projectIdInput java.lang.String No description.
propertiesInput GoogleApigeeOrganizationProperties No description.
retentionInput java.lang.String No description.
runtimeDatabaseEncryptionKeyNameInput java.lang.String No description.
runtimeTypeInput java.lang.String No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR GoogleApigeeOrganizationTimeouts No description.
analyticsRegion java.lang.String No description.
apiConsumerDataEncryptionKeyName java.lang.String No description.
apiConsumerDataLocation java.lang.String No description.
authorizedNetwork java.lang.String No description.
billingType java.lang.String No description.
controlPlaneEncryptionKeyName java.lang.String No description.
description java.lang.String No description.
disableVpcPeering java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
displayName java.lang.String No description.
id java.lang.String No description.
projectId java.lang.String No description.
retention java.lang.String No description.
runtimeDatabaseEncryptionKeyName java.lang.String No description.
runtimeType java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
apigeeProjectIdRequired 
public java.lang.String getApigeeProjectId();
  • Type: java.lang.String
caCertificateRequired 
public java.lang.String getCaCertificate();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
propertiesRequired 
public GoogleApigeeOrganizationPropertiesOutputReference getProperties();
subscriptionTypeRequired 
public java.lang.String getSubscriptionType();
  • Type: java.lang.String
timeoutsRequired 
public GoogleApigeeOrganizationTimeoutsOutputReference getTimeouts();
analyticsRegionInputOptional 
public java.lang.String getAnalyticsRegionInput();
  • Type: java.lang.String
apiConsumerDataEncryptionKeyNameInputOptional 
public java.lang.String getApiConsumerDataEncryptionKeyNameInput();
  • Type: java.lang.String
apiConsumerDataLocationInputOptional 
public java.lang.String getApiConsumerDataLocationInput();
  • Type: java.lang.String
authorizedNetworkInputOptional 
public java.lang.String getAuthorizedNetworkInput();
  • Type: java.lang.String
billingTypeInputOptional 
public java.lang.String getBillingTypeInput();
  • Type: java.lang.String
controlPlaneEncryptionKeyNameInputOptional 
public java.lang.String getControlPlaneEncryptionKeyNameInput();
  • Type: java.lang.String
descriptionInputOptional 
public java.lang.String getDescriptionInput();
  • Type: java.lang.String
disableVpcPeeringInputOptional 
public java.lang.Object getDisableVpcPeeringInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
displayNameInputOptional 
public java.lang.String getDisplayNameInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
projectIdInputOptional 
public java.lang.String getProjectIdInput();
  • Type: java.lang.String
propertiesInputOptional 
public GoogleApigeeOrganizationProperties getPropertiesInput();
retentionInputOptional 
public java.lang.String getRetentionInput();
  • Type: java.lang.String
runtimeDatabaseEncryptionKeyNameInputOptional 
public java.lang.String getRuntimeDatabaseEncryptionKeyNameInput();
  • Type: java.lang.String
runtimeTypeInputOptional 
public java.lang.String getRuntimeTypeInput();
  • Type: java.lang.String
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
analyticsRegionRequired 
public java.lang.String getAnalyticsRegion();
  • Type: java.lang.String
apiConsumerDataEncryptionKeyNameRequired 
public java.lang.String getApiConsumerDataEncryptionKeyName();
  • Type: java.lang.String
apiConsumerDataLocationRequired 
public java.lang.String getApiConsumerDataLocation();
  • Type: java.lang.String
authorizedNetworkRequired 
public java.lang.String getAuthorizedNetwork();
  • Type: java.lang.String
billingTypeRequired 
public java.lang.String getBillingType();
  • Type: java.lang.String
controlPlaneEncryptionKeyNameRequired 
public java.lang.String getControlPlaneEncryptionKeyName();
  • Type: java.lang.String
descriptionRequired 
public java.lang.String getDescription();
  • Type: java.lang.String
disableVpcPeeringRequired 
public java.lang.Object getDisableVpcPeering();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
displayNameRequired 
public java.lang.String getDisplayName();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
projectIdRequired 
public java.lang.String getProjectId();
  • Type: java.lang.String
retentionRequired 
public java.lang.String getRetention();
  • Type: java.lang.String
runtimeDatabaseEncryptionKeyNameRequired 
public java.lang.String getRuntimeDatabaseEncryptionKeyName();
  • Type: java.lang.String
runtimeTypeRequired 
public java.lang.String getRuntimeType();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

GoogleApigeeOrganizationConfig

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationConfig;

GoogleApigeeOrganizationConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .projectId(java.lang.String)
//  .analyticsRegion(java.lang.String)
//  .apiConsumerDataEncryptionKeyName(java.lang.String)
//  .apiConsumerDataLocation(java.lang.String)
//  .authorizedNetwork(java.lang.String)
//  .billingType(java.lang.String)
//  .controlPlaneEncryptionKeyName(java.lang.String)
//  .description(java.lang.String)
//  .disableVpcPeering(java.lang.Boolean)
//  .disableVpcPeering(IResolvable)
//  .displayName(java.lang.String)
//  .id(java.lang.String)
//  .properties(GoogleApigeeOrganizationProperties)
//  .retention(java.lang.String)
//  .runtimeDatabaseEncryptionKeyName(java.lang.String)
//  .runtimeType(java.lang.String)
//  .timeouts(GoogleApigeeOrganizationTimeouts)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
projectId java.lang.String The project ID associated with the Apigee organization.
analyticsRegion java.lang.String Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
apiConsumerDataEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting API consumer data.
apiConsumerDataLocation java.lang.String This field is needed only for customers using non-default data residency regions.
authorizedNetwork java.lang.String Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
billingType java.lang.String Billing type of the Apigee organization. See Apigee pricing.
controlPlaneEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
description java.lang.String Description of the Apigee organization.
disableVpcPeering java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
displayName java.lang.String The display name of the Apigee organization.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#id GoogleApigeeOrganization#id}.
properties GoogleApigeeOrganizationProperties properties block.
retention java.lang.String Optional.
runtimeDatabaseEncryptionKeyName java.lang.String Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
runtimeType java.lang.String Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].
timeouts GoogleApigeeOrganizationTimeouts timeouts block.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
projectIdRequired 
public java.lang.String getProjectId();
  • Type: java.lang.String

The project ID associated with the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#project_id GoogleApigeeOrganization#project_id}

analyticsRegionOptional 
public java.lang.String getAnalyticsRegion();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#analytics_region GoogleApigeeOrganization#analytics_region}

apiConsumerDataEncryptionKeyNameOptional 
public java.lang.String getApiConsumerDataEncryptionKeyName();
  • Type: java.lang.String

Cloud KMS key name used for encrypting API consumer data.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#api_consumer_data_encryption_key_name GoogleApigeeOrganization#api_consumer_data_encryption_key_name}

apiConsumerDataLocationOptional 
public java.lang.String getApiConsumerDataLocation();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#api_consumer_data_location GoogleApigeeOrganization#api_consumer_data_location}

authorizedNetworkOptional 
public java.lang.String getAuthorizedNetwork();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#authorized_network GoogleApigeeOrganization#authorized_network}

billingTypeOptional 
public java.lang.String getBillingType();
  • Type: java.lang.String

Billing type of the Apigee organization. See Apigee pricing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#billing_type GoogleApigeeOrganization#billing_type}

controlPlaneEncryptionKeyNameOptional 
public java.lang.String getControlPlaneEncryptionKeyName();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#control_plane_encryption_key_name GoogleApigeeOrganization#control_plane_encryption_key_name}

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

Description of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#description GoogleApigeeOrganization#description}

disableVpcPeeringOptional 
public java.lang.Object getDisableVpcPeering();
  • Type: java.lang.Boolean OR com.hashicorp.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-beta/6.14.1/docs/resources/google_apigee_organization#disable_vpc_peering GoogleApigeeOrganization#disable_vpc_peering}

displayNameOptional 
public java.lang.String getDisplayName();
  • Type: java.lang.String

The display name of the Apigee organization.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#display_name GoogleApigeeOrganization#display_name}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#id GoogleApigeeOrganization#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.

propertiesOptional 
public GoogleApigeeOrganizationProperties getProperties();

properties block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#properties GoogleApigeeOrganization#properties}

retentionOptional 
public java.lang.String getRetention();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#retention GoogleApigeeOrganization#retention}

runtimeDatabaseEncryptionKeyNameOptional 
public java.lang.String getRuntimeDatabaseEncryptionKeyName();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#runtime_database_encryption_key_name GoogleApigeeOrganization#runtime_database_encryption_key_name}

runtimeTypeOptional 
public java.lang.String getRuntimeType();
  • Type: java.lang.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-beta/6.14.1/docs/resources/google_apigee_organization#runtime_type GoogleApigeeOrganization#runtime_type}

timeoutsOptional 
public GoogleApigeeOrganizationTimeouts getTimeouts();

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#timeouts GoogleApigeeOrganization#timeouts}

GoogleApigeeOrganizationProperties

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationProperties;

GoogleApigeeOrganizationProperties.builder()
//  .property(IResolvable)
//  .property(java.util.List<GoogleApigeeOrganizationPropertiesProperty>)
    .build();

Properties

Name Type Description
property com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleApigeeOrganizationPropertiesProperty> property block.
propertyOptional 
public java.lang.Object getProperty();

property block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#property GoogleApigeeOrganization#property}

GoogleApigeeOrganizationPropertiesProperty

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationPropertiesProperty;

GoogleApigeeOrganizationPropertiesProperty.builder()
//  .name(java.lang.String)
//  .value(java.lang.String)
    .build();

Properties

Name Type Description
name java.lang.String Name of the property.
value java.lang.String Value of the property.
nameOptional 
public java.lang.String getName();
  • Type: java.lang.String

Name of the property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#name GoogleApigeeOrganization#name}

valueOptional 
public java.lang.String getValue();
  • Type: java.lang.String

Value of the property.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#value GoogleApigeeOrganization#value}

GoogleApigeeOrganizationTimeouts

Initializer 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationTimeouts;

GoogleApigeeOrganizationTimeouts.builder()
//  .create(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#create GoogleApigeeOrganization#create}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#delete GoogleApigeeOrganization#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#update GoogleApigeeOrganization#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#create GoogleApigeeOrganization#create}.

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#delete GoogleApigeeOrganization#delete}.

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_apigee_organization#update GoogleApigeeOrganization#update}.

Classes

GoogleApigeeOrganizationPropertiesOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationPropertiesOutputReference;

new GoogleApigeeOrganizationPropertiesOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
putProperty No description.
resetProperty No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

putProperty 
public void putProperty(IResolvable OR java.util.List<GoogleApigeeOrganizationPropertiesProperty> value)
valueRequired
resetProperty 
public void resetProperty()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
property GoogleApigeeOrganizationPropertiesPropertyList No description.
propertyInput com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleApigeeOrganizationPropertiesProperty> No description.
internalValue GoogleApigeeOrganizationProperties No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
propertyRequired 
public GoogleApigeeOrganizationPropertiesPropertyList getProperty();
propertyInputOptional 
public java.lang.Object getPropertyInput();
internalValueOptional 
public GoogleApigeeOrganizationProperties getInternalValue();

GoogleApigeeOrganizationPropertiesPropertyList

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationPropertiesPropertyList;

new GoogleApigeeOrganizationPropertiesPropertyList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.Boolean

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

Methods

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

Creating an iterator for this complex list.

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

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public GoogleApigeeOrganizationPropertiesPropertyOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR java.util.List<GoogleApigeeOrganizationPropertiesProperty> No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

GoogleApigeeOrganizationPropertiesPropertyOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationPropertiesPropertyOutputReference;

new GoogleApigeeOrganizationPropertiesPropertyOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

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

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetName No description.
resetValue No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetName 
public void resetName()
resetValue 
public void resetValue()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
nameInput java.lang.String No description.
valueInput java.lang.String No description.
name java.lang.String No description.
value java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleApigeeOrganizationPropertiesProperty No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
valueInputOptional 
public java.lang.String getValueInput();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
valueRequired 
public java.lang.String getValue();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();

GoogleApigeeOrganizationTimeoutsOutputReference

Initializers 

import com.hashicorp.cdktf.providers.google_beta.google_apigee_organization.GoogleApigeeOrganizationTimeoutsOutputReference;

new GoogleApigeeOrganizationTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetCreate No description.
resetDelete No description.
resetUpdate No description.
computeFqn 
public java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDelete 
public void resetDelete()
resetUpdate 
public void resetUpdate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR GoogleApigeeOrganizationTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();