Google Cloud Native v0.30.0, Apr 14 23
Google Cloud Native v0.30.0, Apr 14 23
google-native.apigee/v1.Environment
Explore with Pulumi AI
Creates an environment in an organization.
Create Environment Resource
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_proxy_type: Optional[EnvironmentApiProxyType] = None,
deployment_type: Optional[EnvironmentDeploymentType] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
forward_proxy_uri: Optional[str] = None,
name: Optional[str] = None,
node_config: Optional[GoogleCloudApigeeV1NodeConfigArgs] = None,
organization_id: Optional[str] = None,
properties: Optional[GoogleCloudApigeeV1PropertiesArgs] = None)
@overload
def Environment(resource_name: str,
args: EnvironmentArgs,
opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: google-native:apigee/v1:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Environment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Environment resource accepts the following input properties:
- Organization
Id string - Api
Proxy Pulumi.Type Google Native. Apigee. V1. Environment Api Proxy Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- Deployment
Type Pulumi.Google Native. Apigee. V1. Environment Deployment Type 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
- Description string
Optional. Description of the environment.
- Display
Name string Optional. Display name for this environment.
- Forward
Proxy stringUri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- Name string
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- Node
Config Pulumi.Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Node Config Args Optional. NodeConfig of the environment.
- Properties
Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Properties Args Optional. Key-value pairs that may be used for customizing the environment.
- Organization
Id string - Api
Proxy EnvironmentType Api Proxy Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- Deployment
Type EnvironmentDeployment Type 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
- Description string
Optional. Description of the environment.
- Display
Name string Optional. Display name for this environment.
- Forward
Proxy stringUri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- Name string
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- Node
Config GoogleCloud Apigee V1Node Config Args Optional. NodeConfig of the environment.
- Properties
Google
Cloud Apigee V1Properties Args Optional. Key-value pairs that may be used for customizing the environment.
- organization
Id String - api
Proxy EnvironmentType Api Proxy Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- deployment
Type EnvironmentDeployment Type 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
- description String
Optional. Description of the environment.
- display
Name String Optional. Display name for this environment.
- forward
Proxy StringUri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- name String
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- node
Config GoogleCloud Apigee V1Node Config Args Optional. NodeConfig of the environment.
- properties
Google
Cloud Apigee V1Properties Args Optional. Key-value pairs that may be used for customizing the environment.
- organization
Id string - api
Proxy EnvironmentType Api Proxy Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- deployment
Type EnvironmentDeployment Type 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
- description string
Optional. Description of the environment.
- display
Name string Optional. Display name for this environment.
- forward
Proxy stringUri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- name string
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- node
Config GoogleCloud Apigee V1Node Config Args Optional. NodeConfig of the environment.
- properties
Google
Cloud Apigee V1Properties Args Optional. Key-value pairs that may be used for customizing the environment.
- organization_
id str - api_
proxy_ Environmenttype Api Proxy Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- deployment_
type EnvironmentDeployment Type 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
- description str
Optional. Description of the environment.
- display_
name str Optional. Display name for this environment.
- forward_
proxy_ struri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- name str
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- node_
config GoogleCloud Apigee V1Node Config Args Optional. NodeConfig of the environment.
- properties
Google
Cloud Apigee V1Properties Args Optional. Key-value pairs that may be used for customizing the environment.
- organization
Id String - api
Proxy "API_PROXY_TYPE_UNSPECIFIED" | "PROGRAMMABLE" | "CONFIGURABLE"Type Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.
- deployment
Type "DEPLOYMENT_TYPE_UNSPECIFIED" | "PROXY" | "ARCHIVE" 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
- description String
Optional. Description of the environment.
- display
Name String Optional. Display name for this environment.
- forward
Proxy StringUri Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied.
- name String
Name of the environment. Values must match the regular expression
^[.\\p{Alnum}-_]{1,255}$
- node
Config Property Map Optional. NodeConfig of the environment.
- properties Property Map
Optional. Key-value pairs that may be used for customizing the environment.
Outputs
All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:
- Created
At string Creation time of this environment as milliseconds since epoch.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Last modification time of this environment as milliseconds since epoch.
- State string
State of the environment. Values other than ACTIVE means the resource is not ready to use.
- Created
At string Creation time of this environment as milliseconds since epoch.
- Id string
The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt Last modification time of this environment as milliseconds since epoch.
- State string
State of the environment. Values other than ACTIVE means the resource is not ready to use.
- created
At String Creation time of this environment as milliseconds since epoch.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt Last modification time of this environment as milliseconds since epoch.
- state String
State of the environment. Values other than ACTIVE means the resource is not ready to use.
- created
At string Creation time of this environment as milliseconds since epoch.
- id string
The provider-assigned unique ID for this managed resource.
- last
Modified stringAt Last modification time of this environment as milliseconds since epoch.
- state string
State of the environment. Values other than ACTIVE means the resource is not ready to use.
- created_
at str Creation time of this environment as milliseconds since epoch.
- id str
The provider-assigned unique ID for this managed resource.
- last_
modified_ strat Last modification time of this environment as milliseconds since epoch.
- state str
State of the environment. Values other than ACTIVE means the resource is not ready to use.
- created
At String Creation time of this environment as milliseconds since epoch.
- id String
The provider-assigned unique ID for this managed resource.
- last
Modified StringAt Last modification time of this environment as milliseconds since epoch.
- state String
State of the environment. Values other than ACTIVE means the resource is not ready to use.
Supporting Types
EnvironmentApiProxyType
- Api
Proxy Type Unspecified - API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- Programmable
- PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- Configurable
- CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
- Environment
Api Proxy Type Api Proxy Type Unspecified - API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- Environment
Api Proxy Type Programmable - PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- Environment
Api Proxy Type Configurable - CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
- Api
Proxy Type Unspecified - API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- Programmable
- PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- Configurable
- CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
- Api
Proxy Type Unspecified - API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- Programmable
- PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- Configurable
- CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
- API_PROXY_TYPE_UNSPECIFIED
- API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- PROGRAMMABLE
- PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- CONFIGURABLE
- CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
- "API_PROXY_TYPE_UNSPECIFIED"
- API_PROXY_TYPE_UNSPECIFIED
API proxy type not specified.
- "PROGRAMMABLE"
- PROGRAMMABLE
Programmable API Proxies enable you to develop APIs with highly flexible behavior using bundled policy configuration and one or more programming languages to describe complex sequential and/or conditional flows of logic.
- "CONFIGURABLE"
- CONFIGURABLE
Configurable API Proxies enable you to develop efficient APIs using simple configuration while complex execution control flow logic is handled by Apigee. This type only works with the ARCHIVE deployment type and cannot be combined with the PROXY deployment type.
EnvironmentDeploymentType
- Deployment
Type Unspecified - DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- Proxy
- PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- Archive
- ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
- Environment
Deployment Type Deployment Type Unspecified - DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- Environment
Deployment Type Proxy - PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- Environment
Deployment Type Archive - ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
- Deployment
Type Unspecified - DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- Proxy
- PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- Archive
- ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
- Deployment
Type Unspecified - DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- Proxy
- PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- Archive
- ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
- DEPLOYMENT_TYPE_UNSPECIFIED
- DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- PROXY
- PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- ARCHIVE
- ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
- "DEPLOYMENT_TYPE_UNSPECIFIED"
- DEPLOYMENT_TYPE_UNSPECIFIED
Deployment type not specified.
- "PROXY"
- PROXY
Proxy deployment enables you to develop and deploy API proxies using Apigee on Google Cloud. This cannot currently be combined with the CONFIGURABLE API proxy type.
- "ARCHIVE"
- ARCHIVE
Archive deployment enables you to develop API proxies locally then deploy an archive of your API proxy configuration to an environment in Apigee on Google Cloud. You will be prevented from performing a subset of actions within the environment.
GoogleCloudApigeeV1NodeConfig
- Max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- Min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- Max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- Min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- max
Node StringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node StringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- max_
node_ strcount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min_
node_ strcount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- max
Node StringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node StringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
GoogleCloudApigeeV1NodeConfigResponse
- Current
Aggregate stringNode Count The current total number of gateway nodes that each environment currently has across all instances.
- Max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- Min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- Current
Aggregate stringNode Count The current total number of gateway nodes that each environment currently has across all instances.
- Max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- Min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- current
Aggregate StringNode Count The current total number of gateway nodes that each environment currently has across all instances.
- max
Node StringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node StringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- current
Aggregate stringNode Count The current total number of gateway nodes that each environment currently has across all instances.
- max
Node stringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node stringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- current_
aggregate_ strnode_ count The current total number of gateway nodes that each environment currently has across all instances.
- max_
node_ strcount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min_
node_ strcount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
- current
Aggregate StringNode Count The current total number of gateway nodes that each environment currently has across all instances.
- max
Node StringCount Optional. The maximum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended maximum number of nodes for that gateway.
- min
Node StringCount Optional. The minimum total number of gateway nodes that the is reserved for all instances that has the specified environment. If not specified, the default is determined by the recommended minimum number of nodes for that gateway.
GoogleCloudApigeeV1Properties
- Property
List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Property> List of all properties in the object
- Property
[]Google
Cloud Apigee V1Property List of all properties in the object
- property
List<Google
Cloud Apigee V1Property> List of all properties in the object
- property
Google
Cloud Apigee V1Property[] List of all properties in the object
- property
Sequence[Google
Cloud Apigee V1Property] List of all properties in the object
- property List<Property Map>
List of all properties in the object
GoogleCloudApigeeV1PropertiesResponse
- Property
List<Pulumi.
Google Native. Apigee. V1. Inputs. Google Cloud Apigee V1Property Response> List of all properties in the object
- Property
[]Google
Cloud Apigee V1Property Response List of all properties in the object
- property
List<Google
Cloud Apigee V1Property Response> List of all properties in the object
- property
Google
Cloud Apigee V1Property Response[] List of all properties in the object
- property
Sequence[Google
Cloud Apigee V1Property Response] List of all properties in the object
- property List<Property Map>
List of all properties in the object
GoogleCloudApigeeV1Property
GoogleCloudApigeeV1PropertyResponse
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0