Skip to content

Latest commit

 

History

History
2831 lines (1763 loc) · 125 KB

apigeeOrganization.csharp.md

File metadata and controls

2831 lines (1763 loc) · 125 KB

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

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganization(Construct Scope, string Id, ApigeeOrganizationConfig Config);
Name Type Description
Scope Constructs.Construct The scope in which to define this construct.
Id string The scoped construct ID.
Config ApigeeOrganizationConfig No description.

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


IdRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


ConfigRequired

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
private string ToString()

Returns a string representation of this construct.

AddOverride
private void AddOverride(string Path, object Value)
PathRequired
  • Type: string

ValueRequired
  • Type: object

OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.


ResetOverrideLogicalId
private void ResetOverrideLogicalId()

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

ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget
private void AddMoveTarget(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: string

The string move target that will correspond to this resource.


GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
IdRequired
  • Type: string

ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

MoveFromId
private void MoveFromId(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: string

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


MoveTo
private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTargetRequired
  • Type: string

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


IndexOptional
  • Type: object

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


MoveToId
private void MoveToId(string Id)

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

IdRequired
  • Type: string

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


PutProperties
private void PutProperties(ApigeeOrganizationProperties Value)
ValueRequired

PutTimeouts
private void PutTimeouts(ApigeeOrganizationTimeouts Value)
ValueRequired

ResetAnalyticsRegion
private void ResetAnalyticsRegion()
ResetApiConsumerDataEncryptionKeyName
private void ResetApiConsumerDataEncryptionKeyName()
ResetApiConsumerDataLocation
private void ResetApiConsumerDataLocation()
ResetAuthorizedNetwork
private void ResetAuthorizedNetwork()
ResetBillingType
private void ResetBillingType()
ResetControlPlaneEncryptionKeyName
private void ResetControlPlaneEncryptionKeyName()
ResetDescription
private void ResetDescription()
ResetDisableVpcPeering
private void ResetDisableVpcPeering()
ResetDisplayName
private void ResetDisplayName()
ResetId
private void ResetId()
ResetProperties
private void ResetProperties()
ResetRetention
private void ResetRetention()
ResetRuntimeDatabaseEncryptionKeyName
private void ResetRuntimeDatabaseEncryptionKeyName()
ResetRuntimeType
private void ResetRuntimeType()
ResetTimeouts
private 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 ApigeeOrganization resource upon running "cdktf plan ".

IsConstruct
using HashiCorp.Cdktf.Providers.Google;

ApigeeOrganization.IsConstruct(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: object

Any object.


IsTerraformElement
using HashiCorp.Cdktf.Providers.Google;

ApigeeOrganization.IsTerraformElement(object X);
XRequired
  • Type: object

IsTerraformResource
using HashiCorp.Cdktf.Providers.Google;

ApigeeOrganization.IsTerraformResource(object X);
XRequired
  • Type: object

GenerateConfigForImport
using HashiCorp.Cdktf.Providers.Google;

ApigeeOrganization.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

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

ScopeRequired
  • Type: Constructs.Construct

The scope in which to define this construct.


ImportToIdRequired
  • Type: string

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


ImportFromIdRequired
  • Type: string

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


ProviderOptional
  • Type: HashiCorp.Cdktf.TerraformProvider

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


Properties

Name Type Description
Node Constructs.Node The tree node.
CdktfStack HashiCorp.Cdktf.TerraformStack No description.
Fqn string No description.
FriendlyUniqueId string No description.
TerraformMetaArguments System.Collections.Generic.IDictionary<string, object> No description.
TerraformResourceType string No description.
TerraformGeneratorMetadata HashiCorp.Cdktf.TerraformProviderGeneratorMetadata No description.
Connection object No description.
Count object No description.
DependsOn string[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ApigeeProjectId string No description.
CaCertificate string No description.
Name string No description.
Properties ApigeeOrganizationPropertiesOutputReference No description.
SubscriptionType string No description.
Timeouts ApigeeOrganizationTimeoutsOutputReference No description.
AnalyticsRegionInput string No description.
ApiConsumerDataEncryptionKeyNameInput string No description.
ApiConsumerDataLocationInput string No description.
AuthorizedNetworkInput string No description.
BillingTypeInput string No description.
ControlPlaneEncryptionKeyNameInput string No description.
DescriptionInput string No description.
DisableVpcPeeringInput object No description.
DisplayNameInput string No description.
IdInput string No description.
ProjectIdInput string No description.
PropertiesInput ApigeeOrganizationProperties No description.
RetentionInput string No description.
RuntimeDatabaseEncryptionKeyNameInput string No description.
RuntimeTypeInput string No description.
TimeoutsInput object No description.
AnalyticsRegion string No description.
ApiConsumerDataEncryptionKeyName string No description.
ApiConsumerDataLocation string No description.
AuthorizedNetwork string No description.
BillingType string No description.
ControlPlaneEncryptionKeyName string No description.
Description string No description.
DisableVpcPeering object No description.
DisplayName string No description.
Id string No description.
ProjectId string No description.
Retention string No description.
RuntimeDatabaseEncryptionKeyName string No description.
RuntimeType string No description.

NodeRequired
public Node Node { get; }
  • Type: Constructs.Node

The tree node.


CdktfStackRequired
public TerraformStack CdktfStack { get; }
  • Type: HashiCorp.Cdktf.TerraformStack

FqnRequired
public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
  • Type: string

TerraformMetaArgumentsRequired
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
  • Type: System.Collections.Generic.IDictionary<string, object>

TerraformResourceTypeRequired
public string TerraformResourceType { get; }
  • Type: string

TerraformGeneratorMetadataOptional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
  • Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

ConnectionOptional
public object Connection { get; }
  • Type: object

CountOptional
public object Count { get; }
  • Type: object

DependsOnOptional
public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional
public ITerraformIterator ForEach { get; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; }
  • Type: object[]

ApigeeProjectIdRequired
public string ApigeeProjectId { get; }
  • Type: string

CaCertificateRequired
public string CaCertificate { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

PropertiesRequired
public ApigeeOrganizationPropertiesOutputReference Properties { get; }

SubscriptionTypeRequired
public string SubscriptionType { get; }
  • Type: string

TimeoutsRequired
public ApigeeOrganizationTimeoutsOutputReference Timeouts { get; }

AnalyticsRegionInputOptional
public string AnalyticsRegionInput { get; }
  • Type: string

ApiConsumerDataEncryptionKeyNameInputOptional
public string ApiConsumerDataEncryptionKeyNameInput { get; }
  • Type: string

ApiConsumerDataLocationInputOptional
public string ApiConsumerDataLocationInput { get; }
  • Type: string

AuthorizedNetworkInputOptional
public string AuthorizedNetworkInput { get; }
  • Type: string

BillingTypeInputOptional
public string BillingTypeInput { get; }
  • Type: string

ControlPlaneEncryptionKeyNameInputOptional
public string ControlPlaneEncryptionKeyNameInput { get; }
  • Type: string

DescriptionInputOptional
public string DescriptionInput { get; }
  • Type: string

DisableVpcPeeringInputOptional
public object DisableVpcPeeringInput { get; }
  • Type: object

DisplayNameInputOptional
public string DisplayNameInput { get; }
  • Type: string

IdInputOptional
public string IdInput { get; }
  • Type: string

ProjectIdInputOptional
public string ProjectIdInput { get; }
  • Type: string

PropertiesInputOptional
public ApigeeOrganizationProperties PropertiesInput { get; }

RetentionInputOptional
public string RetentionInput { get; }
  • Type: string

RuntimeDatabaseEncryptionKeyNameInputOptional
public string RuntimeDatabaseEncryptionKeyNameInput { get; }
  • Type: string

RuntimeTypeInputOptional
public string RuntimeTypeInput { get; }
  • Type: string

TimeoutsInputOptional
public object TimeoutsInput { get; }
  • Type: object

AnalyticsRegionRequired
public string AnalyticsRegion { get; }
  • Type: string

ApiConsumerDataEncryptionKeyNameRequired
public string ApiConsumerDataEncryptionKeyName { get; }
  • Type: string

ApiConsumerDataLocationRequired
public string ApiConsumerDataLocation { get; }
  • Type: string

AuthorizedNetworkRequired
public string AuthorizedNetwork { get; }
  • Type: string

BillingTypeRequired
public string BillingType { get; }
  • Type: string

ControlPlaneEncryptionKeyNameRequired
public string ControlPlaneEncryptionKeyName { get; }
  • Type: string

DescriptionRequired
public string Description { get; }
  • Type: string

DisableVpcPeeringRequired
public object DisableVpcPeering { get; }
  • Type: object

DisplayNameRequired
public string DisplayName { get; }
  • Type: string

IdRequired
public string Id { get; }
  • Type: string

ProjectIdRequired
public string ProjectId { get; }
  • Type: string

RetentionRequired
public string Retention { get; }
  • Type: string

RuntimeDatabaseEncryptionKeyNameRequired
public string RuntimeDatabaseEncryptionKeyName { get; }
  • Type: string

RuntimeTypeRequired
public string RuntimeType { get; }
  • Type: string

Constants

Name Type Description
TfResourceType string No description.

TfResourceTypeRequired
public string TfResourceType { get; }
  • Type: string

Structs

ApigeeOrganizationConfig

Initializer

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string ProjectId,
    string AnalyticsRegion = null,
    string ApiConsumerDataEncryptionKeyName = null,
    string ApiConsumerDataLocation = null,
    string AuthorizedNetwork = null,
    string BillingType = null,
    string ControlPlaneEncryptionKeyName = null,
    string Description = null,
    object DisableVpcPeering = null,
    string DisplayName = null,
    string Id = null,
    ApigeeOrganizationProperties Properties = null,
    string Retention = null,
    string RuntimeDatabaseEncryptionKeyName = null,
    string RuntimeType = null,
    ApigeeOrganizationTimeouts Timeouts = null
};

Properties

Name Type Description
Connection object No description.
Count object No description.
DependsOn HashiCorp.Cdktf.ITerraformDependable[] No description.
ForEach HashiCorp.Cdktf.ITerraformIterator No description.
Lifecycle HashiCorp.Cdktf.TerraformResourceLifecycle No description.
Provider HashiCorp.Cdktf.TerraformProvider No description.
Provisioners object[] No description.
ProjectId string The project ID associated with the Apigee organization.
AnalyticsRegion string Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
ApiConsumerDataEncryptionKeyName string Cloud KMS key name used for encrypting API consumer data.
ApiConsumerDataLocation string This field is needed only for customers using non-default data residency regions.
AuthorizedNetwork string Compute Engine network used for Service Networking to be peered with Apigee runtime instances.
BillingType string Billing type of the Apigee organization. See Apigee pricing.
ControlPlaneEncryptionKeyName string Cloud KMS key name used for encrypting control plane data that is stored in a multi region.
Description string Description of the Apigee organization.
DisableVpcPeering object Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.
DisplayName string The display name of the Apigee organization.
Id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.14.1/docs/resources/apigee_organization#id ApigeeOrganization#id}.
Properties ApigeeOrganizationProperties properties block.
Retention string Optional.
RuntimeDatabaseEncryptionKeyName string Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances.
RuntimeType string Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value: "CLOUD" Possible values: ["CLOUD", "HYBRID"].
Timeouts ApigeeOrganizationTimeouts timeouts block.

ConnectionOptional
public object Connection { get; set; }
  • Type: object

CountOptional
public object Count { get; set; }
  • Type: object

DependsOnOptional
public ITerraformDependable[] DependsOn { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformDependable[]

ForEachOptional
public ITerraformIterator ForEach { get; set; }
  • Type: HashiCorp.Cdktf.ITerraformIterator

LifecycleOptional
public TerraformResourceLifecycle Lifecycle { get; set; }
  • Type: HashiCorp.Cdktf.TerraformResourceLifecycle

ProviderOptional
public TerraformProvider Provider { get; set; }
  • Type: HashiCorp.Cdktf.TerraformProvider

ProvisionersOptional
public object[] Provisioners { get; set; }
  • Type: object[]

ProjectIdRequired
public string ProjectId { get; set; }
  • Type: string

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}


AnalyticsRegionOptional
public string AnalyticsRegion { get; set; }
  • Type: string

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

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


ApiConsumerDataEncryptionKeyNameOptional
public string ApiConsumerDataEncryptionKeyName { get; set; }
  • Type: string

Cloud KMS key name used for encrypting API consumer data.

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


ApiConsumerDataLocationOptional
public string ApiConsumerDataLocation { get; set; }
  • Type: string

This field is needed only for customers using non-default data residency regions.

Apigee stores some control plane data only in single region. This field determines which single region Apigee should use.

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


AuthorizedNetworkOptional
public string AuthorizedNetwork { get; set; }
  • Type: string

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

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

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


BillingTypeOptional
public string BillingType { get; set; }
  • Type: string

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}


ControlPlaneEncryptionKeyNameOptional
public string ControlPlaneEncryptionKeyName { get; set; }
  • Type: string

Cloud KMS key name used for encrypting control plane data that is stored in a multi region.

Only used for the data residency region "US" or "EU".

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


DescriptionOptional
public string Description { get; set; }
  • Type: string

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}


DisableVpcPeeringOptional
public object DisableVpcPeering { get; set; }
  • Type: object

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}


DisplayNameOptional
public string DisplayName { get; set; }
  • Type: string

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}


IdOptional
public string Id { get; set; }
  • Type: string

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.


PropertiesOptional
public ApigeeOrganizationProperties Properties { get; set; }

properties block.

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


RetentionOptional
public string Retention { get; set; }
  • Type: string

Optional.

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

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


RuntimeDatabaseEncryptionKeyNameOptional
public string RuntimeDatabaseEncryptionKeyName { get; set; }
  • Type: string

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

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

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


RuntimeTypeOptional
public string RuntimeType { get; set; }
  • Type: string

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

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


TimeoutsOptional
public ApigeeOrganizationTimeouts Timeouts { get; set; }

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

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationProperties {
    object Property = null
};

Properties

Name Type Description
Property object property block.

PropertyOptional
public object Property { get; set; }
  • Type: object

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

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationPropertiesProperty {
    string Name = null,
    string Value = null
};

Properties

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

NameOptional
public string Name { get; set; }
  • Type: string

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}


ValueOptional
public string Value { get; set; }
  • Type: string

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

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationTimeouts {
    string Create = null,
    string Delete = null,
    string Update = null
};

Properties

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

CreateOptional
public string Create { get; set; }
  • Type: string

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


DeleteOptional
public string Delete { get; set; }
  • Type: string

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


UpdateOptional
public string Update { get; set; }
  • Type: string

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

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationPropertiesOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
PutProperty No description.
ResetProperty No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

PutProperty
private void PutProperty(object Value)
ValueRequired
  • Type: object

ResetProperty
private void ResetProperty()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
Property ApigeeOrganizationPropertiesPropertyList No description.
PropertyInput object No description.
InternalValue ApigeeOrganizationProperties No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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

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


FqnRequired
public string Fqn { get; }
  • Type: string

PropertyRequired
public ApigeeOrganizationPropertiesPropertyList Property { get; }

PropertyInputOptional
public object PropertyInput { get; }
  • Type: object

InternalValueOptional
public ApigeeOrganizationProperties InternalValue { get; }

ApigeeOrganizationPropertiesPropertyList

Initializers

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationPropertiesPropertyList(IInterpolatingParent TerraformResource, string TerraformAttribute, bool WrapsSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
WrapsSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


WrapsSetRequired
  • Type: bool

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


Methods

Name Description
AllWithMapKey Creating an iterator for this complex list.
ComputeFqn No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
Get No description.

AllWithMapKey
private DynamicListTerraformIterator AllWithMapKey(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: string

ComputeFqn
private string ComputeFqn()
Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get
private ApigeeOrganizationPropertiesPropertyOutputReference Get(double Index)
IndexRequired
  • Type: double

the index of the item to return.


Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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

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


FqnRequired
public string Fqn { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

ApigeeOrganizationPropertiesPropertyOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationPropertiesPropertyOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute, double ComplexObjectIndex, bool ComplexObjectIsFromSet);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.
ComplexObjectIndex double the index of this item in the list.
ComplexObjectIsFromSet bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


ComplexObjectIndexRequired
  • Type: double

the index of this item in the list.


ComplexObjectIsFromSetRequired
  • Type: bool

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


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetName No description.
ResetValue No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetName
private void ResetName()
ResetValue
private void ResetValue()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
NameInput string No description.
ValueInput string No description.
Name string No description.
Value string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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

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


FqnRequired
public string Fqn { get; }
  • Type: string

NameInputOptional
public string NameInput { get; }
  • Type: string

ValueInputOptional
public string ValueInput { get; }
  • Type: string

NameRequired
public string Name { get; }
  • Type: string

ValueRequired
public string Value { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object

ApigeeOrganizationTimeoutsOutputReference

Initializers

using HashiCorp.Cdktf.Providers.Google;

new ApigeeOrganizationTimeoutsOutputReference(IInterpolatingParent TerraformResource, string TerraformAttribute);
Name Type Description
TerraformResource HashiCorp.Cdktf.IInterpolatingParent The parent resource.
TerraformAttribute string The attribute on the parent resource this class is referencing.

TerraformResourceRequired
  • Type: HashiCorp.Cdktf.IInterpolatingParent

The parent resource.


TerraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


Methods

Name Description
ComputeFqn No description.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
InterpolationForAttribute No description.
Resolve Produce the Token's value at resolution time.
ToString Return a string representation of this resolvable object.
ResetCreate No description.
ResetDelete No description.
ResetUpdate No description.

ComputeFqn
private string ComputeFqn()
GetAnyMapAttribute
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetBooleanMapAttribute
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetNumberMapAttribute
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

GetStringMapAttribute
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
TerraformAttributeRequired
  • Type: string

InterpolationForAttribute
private IResolvable InterpolationForAttribute(string Property)
PropertyRequired
  • Type: string

Resolve
private object Resolve(IResolveContext Context)

Produce the Token's value at resolution time.

ContextRequired
  • Type: HashiCorp.Cdktf.IResolveContext

ToString
private string ToString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

ResetCreate
private void ResetCreate()
ResetDelete
private void ResetDelete()
ResetUpdate
private void ResetUpdate()

Properties

Name Type Description
CreationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
Fqn string No description.
CreateInput string No description.
DeleteInput string No description.
UpdateInput string No description.
Create string No description.
Delete string No description.
Update string No description.
InternalValue object No description.

CreationStackRequired
public string[] CreationStack { get; }
  • Type: string[]

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

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


FqnRequired
public string Fqn { get; }
  • Type: string

CreateInputOptional
public string CreateInput { get; }
  • Type: string

DeleteInputOptional
public string DeleteInput { get; }
  • Type: string

UpdateInputOptional
public string UpdateInput { get; }
  • Type: string

CreateRequired
public string Create { get; }
  • Type: string

DeleteRequired
public string Delete { get; }
  • Type: string

UpdateRequired
public string Update { get; }
  • Type: string

InternalValueOptional
public object InternalValue { get; }
  • Type: object