OrganizationArgs class

The set of arguments for Organization. The set of arguments for Organization.

Constructors

OrganizationArgs({Input<GoogleCloudApigeeV1AddonsConfig>? addonsConfig, required Input<String> analyticsRegion, Input<String>? apiConsumerDataEncryptionKeyName, Input<String>? apiConsumerDataLocation, Input<List<String>>? attributes, Input<String>? authorizedNetwork, Input<OrganizationBillingType>? billingType, Input<String>? controlPlaneEncryptionKeyName, Input<String>? customerName, Input<String>? description, Input<bool>? disableVpcPeering, Input<String>? displayName, required Input<String> parent, Input<bool>? portalDisabled, Input<GoogleCloudApigeeV1Properties>? properties, Input<String>? runtimeDatabaseEncryptionKeyName, required Input<OrganizationRuntimeType> runtimeType_, Input<OrganizationType>? type})
Creates a new OrganizationArgs. addonsConfig Addon configurations of the Apigee organization. analyticsRegion DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization. apiConsumerDataEncryptionKeyName Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType is EVALUATION or the region is not US/EU, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/* apiConsumerDataLocation This field is needed only for customers with control plane in US or EU. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU. attributes Not used by Apigee. authorizedNetwork 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 must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork Note: Not supported for Apigee hybrid. billingType Billing type of the Apigee organization. See Apigee pricing. controlPlaneEncryptionKeyName Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/* customerName Not used by Apigee. description Description of the Apigee organization. disableVpcPeering Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. displayName Display name for the Apigee organization. Unused, but reserved for future use. parent Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/ portalDisabled Configuration for the Portals settings. properties Properties defined in the Apigee organization profile. runtimeDatabaseEncryptionKeyName 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. Required when RuntimeType is CLOUD. If not specified when RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid. runtimeType_ Runtime type of the Apigee organization based on the Apigee subscription purchased. type Not used by Apigee.
const
OrganizationArgs.fromMap(Map<String, dynamic> map)
factory

Properties

addonsConfig → Input<GoogleCloudApigeeV1AddonsConfig>?
Addon configurations of the Apigee organization.
final
analyticsRegion → Input<String>
DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud 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. Required for US/EU regions when BillingType is SUBSCRIPTION. When BillingType is EVALUATION or the region is not US/EU, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
final
apiConsumerDataLocation → Input<String>?
This field is needed only for customers with control plane in US or EU. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU.
final
attributes → Input<List<String>>?
Not used by Apigee.
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 must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork Note: Not supported for Apigee hybrid.
final
billingType → Input<OrganizationBillingType>?
Billing type of the Apigee organization. See Apigee pricing.
final
controlPlaneEncryptionKeyName → Input<String>?
Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/*
final
customerName → Input<String>?
Not used by Apigee.
final
description → Input<String>?
Description of the Apigee organization.
final
disableVpcPeering → Input<bool>?
Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.
final
displayName → Input<String>?
Display name for the Apigee organization. Unused, but reserved for future use.
final
hashCode → int
The hash code for this object.
no setterinherited
parent → Input<String>
Required. Name of the Google Cloud project in which to associate the Apigee organization. Pass the information as a query parameter using the following structure in your request: projects/
final
portalDisabled → Input<bool>?
Configuration for the Portals settings.
final
properties → Input<GoogleCloudApigeeV1Properties>?
Properties defined in the Apigee organization profile.
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. Required when RuntimeType is CLOUD. If not specified when RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
runtimeType_ → Input<OrganizationRuntimeType>
Runtime type of the Apigee organization based on the Apigee subscription purchased.
final
type → Input<OrganizationType>?
Not used by Apigee.
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