EnvironmentArgs class

The set of arguments for Environment. The set of arguments for Environment.

Constructors

EnvironmentArgs({Input<String?>? apiProxyType, Input<EnvironmentClientIpResolutionConfig?>? clientIpResolutionConfig, Input<String?>? deletionPolicy, Input<String?>? deploymentType, Input<String?>? description, Input<String?>? displayName, Input<String?>? forwardProxyUri, Input<String?>? name, Input<EnvironmentNodeConfig?>? nodeConfig, required Input<String> orgId, Input<EnvironmentProperties?>? properties, Input<String?>? type})
Creates a new EnvironmentArgs. apiProxyType Optional. API Proxy type supported by the environment. The type can be set when creating clientIpResolutionConfig The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. deploymentType Optional. Deployment type supported by the environment. The deployment type can be description Description of the environment. displayName Display name of the environment. forwardProxyUri Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied. name The resource ID of the environment. nodeConfig NodeConfig for setting the min/max number of nodes associated with the environment. orgId The Apigee Organization associated with the Apigee environment, properties Key-value pairs that may be used for customizing the environment. type Types that can be selected for an Environment. Each of the types are
const
EnvironmentArgs.fromMap(Map<String, dynamic> map)
factory

Properties

apiProxyType → Input<String?>?
Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Possible values are: API_PROXY_TYPE_UNSPECIFIED, PROGRAMMABLE, CONFIGURABLE.
final
clientIpResolutionConfig → Input<EnvironmentClientIpResolutionConfig?>?
The algorithm to resolve IP. This will affect Analytics, API Security, and other features that use the client ip. To remove a client ip resolution config, update the field to an empty value. Example: '{ "clientIpResolutionConfig" = {} }' For more information, see: https://cloud.google.com/apigee/docs/api-platform/system-administration/client-ip-resolution Structure is documented below.
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
deploymentType → Input<String?>?
Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: Managing the deployment of API proxy or shared flow revisions; Creating, updating, or deleting resource files; Creating, updating, or deleting target servers. Possible values are: DEPLOYMENT_TYPE_UNSPECIFIED, PROXY, ARCHIVE.
final
description → Input<String?>?
Description of the environment.
final
displayName → Input<String?>?
Display name of the environment.
final
forwardProxyUri → Input<String?>?
Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of {scheme}://{hostname}:{port}. Note that the scheme must be one of "http" or "https", and the port must be supplied.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
The resource ID of the environment.
final
nodeConfig → Input<EnvironmentNodeConfig?>?
NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.
final
orgId → Input<String>
The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.
final
properties → Input<EnvironmentProperties?>?
Key-value pairs that may be used for customizing the environment. Structure is documented below.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → Input<String?>?
Types that can be selected for an Environment. Each of the types are limited by capability and capacity. Refer to Apigee's public documentation to understand about each of these types in details. An Apigee org can support heterogeneous Environments. Possible values are: ENVIRONMENT_TYPE_UNSPECIFIED, BASE, INTERMEDIATE, COMPREHENSIVE.
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