Docs Packages
  1. Pulumi Registry
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. Environment
google-native logo
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:

OrganizationId string
ApiProxyType Pulumi.GoogleNative.Apigee.V1.EnvironmentApiProxyType

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

DeploymentType Pulumi.GoogleNative.Apigee.V1.EnvironmentDeploymentType

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.

DisplayName string

Optional. Display name for this environment.

ForwardProxyUri string

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}$

NodeConfig Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1NodeConfigArgs

Optional. NodeConfig of the environment.

Properties Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1PropertiesArgs

Optional. Key-value pairs that may be used for customizing the environment.

OrganizationId string
ApiProxyType EnvironmentApiProxyType

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

DeploymentType EnvironmentDeploymentType

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.

DisplayName string

Optional. Display name for this environment.

ForwardProxyUri string

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}$

NodeConfig GoogleCloudApigeeV1NodeConfigArgs

Optional. NodeConfig of the environment.

Properties GoogleCloudApigeeV1PropertiesArgs

Optional. Key-value pairs that may be used for customizing the environment.

organizationId String
apiProxyType EnvironmentApiProxyType

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

deploymentType EnvironmentDeploymentType

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.

displayName String

Optional. Display name for this environment.

forwardProxyUri String

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}$

nodeConfig GoogleCloudApigeeV1NodeConfigArgs

Optional. NodeConfig of the environment.

properties GoogleCloudApigeeV1PropertiesArgs

Optional. Key-value pairs that may be used for customizing the environment.

organizationId string
apiProxyType EnvironmentApiProxyType

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

deploymentType EnvironmentDeploymentType

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.

displayName string

Optional. Display name for this environment.

forwardProxyUri string

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}$

nodeConfig GoogleCloudApigeeV1NodeConfigArgs

Optional. NodeConfig of the environment.

properties GoogleCloudApigeeV1PropertiesArgs

Optional. Key-value pairs that may be used for customizing the environment.

organization_id str
api_proxy_type EnvironmentApiProxyType

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

deployment_type EnvironmentDeploymentType

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_uri str

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 GoogleCloudApigeeV1NodeConfigArgs

Optional. NodeConfig of the environment.

properties GoogleCloudApigeeV1PropertiesArgs

Optional. Key-value pairs that may be used for customizing the environment.

organizationId String
apiProxyType "API_PROXY_TYPE_UNSPECIFIED" | "PROGRAMMABLE" | "CONFIGURABLE"

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed.

deploymentType "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.

displayName String

Optional. Display name for this environment.

forwardProxyUri String

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}$

nodeConfig 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:

CreatedAt string

Creation time of this environment as milliseconds since epoch.

Id string

The provider-assigned unique ID for this managed resource.

LastModifiedAt string

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.

CreatedAt string

Creation time of this environment as milliseconds since epoch.

Id string

The provider-assigned unique ID for this managed resource.

LastModifiedAt string

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.

createdAt String

Creation time of this environment as milliseconds since epoch.

id String

The provider-assigned unique ID for this managed resource.

lastModifiedAt String

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.

createdAt string

Creation time of this environment as milliseconds since epoch.

id string

The provider-assigned unique ID for this managed resource.

lastModifiedAt string

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_at str

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.

createdAt String

Creation time of this environment as milliseconds since epoch.

id String

The provider-assigned unique ID for this managed resource.

lastModifiedAt String

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

ApiProxyTypeUnspecified
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.

EnvironmentApiProxyTypeApiProxyTypeUnspecified
API_PROXY_TYPE_UNSPECIFIED

API proxy type not specified.

EnvironmentApiProxyTypeProgrammable
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.

EnvironmentApiProxyTypeConfigurable
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.

ApiProxyTypeUnspecified
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.

ApiProxyTypeUnspecified
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

DeploymentTypeUnspecified
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.

EnvironmentDeploymentTypeDeploymentTypeUnspecified
DEPLOYMENT_TYPE_UNSPECIFIED

Deployment type not specified.

EnvironmentDeploymentTypeProxy
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.

EnvironmentDeploymentTypeArchive
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.

DeploymentTypeUnspecified
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.

DeploymentTypeUnspecified
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

MaxNodeCount string

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.

MinNodeCount string

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.

MaxNodeCount string

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.

MinNodeCount string

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.

maxNodeCount String

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.

minNodeCount String

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.

maxNodeCount string

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.

minNodeCount string

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_count str

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_count str

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.

maxNodeCount String

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.

minNodeCount String

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

CurrentAggregateNodeCount string

The current total number of gateway nodes that each environment currently has across all instances.

MaxNodeCount string

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.

MinNodeCount string

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.

CurrentAggregateNodeCount string

The current total number of gateway nodes that each environment currently has across all instances.

MaxNodeCount string

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.

MinNodeCount string

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.

currentAggregateNodeCount String

The current total number of gateway nodes that each environment currently has across all instances.

maxNodeCount String

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.

minNodeCount String

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.

currentAggregateNodeCount string

The current total number of gateway nodes that each environment currently has across all instances.

maxNodeCount string

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.

minNodeCount string

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_node_count str

The current total number of gateway nodes that each environment currently has across all instances.

max_node_count str

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_count str

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.

currentAggregateNodeCount String

The current total number of gateway nodes that each environment currently has across all instances.

maxNodeCount String

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.

minNodeCount String

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 []GoogleCloudApigeeV1Property

List of all properties in the object

property List<GoogleCloudApigeeV1Property>

List of all properties in the object

property GoogleCloudApigeeV1Property[]

List of all properties in the object

property Sequence[GoogleCloudApigeeV1Property]

List of all properties in the object

property List<Property Map>

List of all properties in the object

GoogleCloudApigeeV1PropertiesResponse

Property []GoogleCloudApigeeV1PropertyResponse

List of all properties in the object

property List<GoogleCloudApigeeV1PropertyResponse>

List of all properties in the object

property GoogleCloudApigeeV1PropertyResponse[]

List of all properties in the object

property Sequence[GoogleCloudApigeeV1PropertyResponse]

List of all properties in the object

property List<Property Map>

List of all properties in the object

GoogleCloudApigeeV1Property

Name string

The property key

Value string

The property value

Name string

The property key

Value string

The property value

name String

The property key

value String

The property value

name string

The property key

value string

The property value

name str

The property key

value str

The property value

name String

The property key

value String

The property value

GoogleCloudApigeeV1PropertyResponse

Name string

The property key

Value string

The property value

Name string

The property key

Value string

The property value

name String

The property key

value String

The property value

name string

The property key

value string

The property value

name str

The property key

value str

The property value

name String

The property key

value String

The property value

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0