OrganizationState class

Input properties used for looking up and filtering Organization resources.

Constructors

OrganizationState({Input<String?>? analyticsRegion, Input<String?>? apiConsumerDataEncryptionKeyName, Input<String?>? apiConsumerDataLocation, Input<String?>? apigeeProjectId, Input<String?>? authorizedNetwork, Input<String?>? billingType, Input<String?>? caCertificate, Input<String?>? controlPlaneEncryptionKeyName, Input<String?>? deletionPolicy, Input<String?>? description, Input<bool?>? disableVpcPeering, Input<String?>? displayName, Input<String?>? name, Input<String?>? projectId, Input<OrganizationProperties?>? properties, Input<String?>? retention, Input<String?>? runtimeDatabaseEncryptionKeyName, Input<String?>? runtimeType_, Input<String?>? subscriptionType})
Creates a new OrganizationState. analyticsRegion Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization. apiConsumerDataEncryptionKeyName Cloud KMS key name used for encrypting API consumer data. apiConsumerDataLocation This field is needed only for customers using non-default data residency regions. apigeeProjectId Output only. Project ID of the Apigee Tenant Project. authorizedNetwork Compute Engine network used for Service Networking to be peered with Apigee runtime instances. billingType Billing type of the Apigee organization. See Apigee pricing. caCertificate Output only. Base64-encoded public certificate for the root CA of the Apigee organization. controlPlaneEncryptionKeyName Cloud KMS key name used for encrypting control plane data that is stored in a multi region. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description Description of the Apigee organization. disableVpcPeering Flag that specifies whether the VPC Peering through Private Google Access should be displayName The display name of the Apigee organization. name Output only. Name of the Apigee organization. projectId The project ID associated with the Apigee organization. properties Properties defined in the Apigee organization profile. retention Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType runtimeDatabaseEncryptionKeyName Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. runtimeType_ Runtime type of the Apigee organization based on the Apigee subscription purchased. subscriptionType Output only. Subscription type of the Apigee organization.
const
OrganizationState.fromMap(Map<String, dynamic> map)
factory

Properties

analyticsRegion → Input<String?>?
Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization.
final
apiConsumerDataEncryptionKeyName → Input<String?>?
Cloud KMS key name used for encrypting API consumer data.
final
apiConsumerDataLocation → Input<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.
final
apigeeProjectId → Input<String?>?
Output only. Project ID of the Apigee Tenant Project.
final
authorizedNetwork → Input<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".
final
billingType → Input<String?>?
Billing type of the Apigee organization. See Apigee pricing.
final
caCertificate → Input<String?>?
Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD. A base64-encoded string.
final
controlPlaneEncryptionKeyName → Input<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".
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
Description of the Apigee organization.
final
disableVpcPeering → Input<bool?>?
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.
final
displayName → Input<String?>?
The display name of the Apigee organization.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
Output only. Name of the Apigee organization.
final
projectId → Input<String?>?
The project ID associated with the Apigee organization.
final
properties → Input<OrganizationProperties?>?
Properties defined in the Apigee organization profile. Structure is documented below.
final
retention → Input<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 is DELETION_RETENTION_UNSPECIFIED. Possible values are: DELETION_RETENTION_UNSPECIFIED, MINIMUM.
final
runtimeDatabaseEncryptionKeyName → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
runtimeType_ → Input<String?>?
Runtime type of the Apigee organization based on the Apigee subscription purchased. Default value is CLOUD. Possible values are: CLOUD, HYBRID.
final
subscriptionType → Input<String?>?
Output only. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited