Google Cloud (GCP) Classic

v6.44.0 published on Tuesday, Nov 29, 2022 by Pulumi

Environment

An Environment in Apigee.

To get more information about Environment, see:

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[str] = None,
                deployment_type: Optional[str] = None,
                description: Optional[str] = None,
                display_name: Optional[str] = None,
                name: Optional[str] = None,
                node_config: Optional[EnvironmentNodeConfigArgs] = None,
                org_id: Optional[str] = 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: gcp:apigee: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:

OrgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

ApiProxyType 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, and CONFIGURABLE.

DeploymentType 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, and ARCHIVE.

Description string

Description of the environment.

DisplayName string

Display name of the environment.

Name string

The resource ID of the environment.

NodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

OrgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

ApiProxyType 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, and CONFIGURABLE.

DeploymentType 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, and ARCHIVE.

Description string

Description of the environment.

DisplayName string

Display name of the environment.

Name string

The resource ID of the environment.

NodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId String

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description String

Description of the environment.

displayName String

Display name of the environment.

name String

The resource ID of the environment.

nodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description string

Description of the environment.

displayName string

Display name of the environment.

name string

The resource ID of the environment.

nodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

org_id str

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

api_proxy_type str

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, and CONFIGURABLE.

deployment_type str

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, and ARCHIVE.

description str

Description of the environment.

display_name str

Display name of the environment.

name str

The resource ID of the environment.

node_config EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId String

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description String

Description of the environment.

displayName String

Display name of the environment.

name String

The resource ID of the environment.

nodeConfig Property Map

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Environment Resource

Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_proxy_type: Optional[str] = None,
        deployment_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None,
        node_config: Optional[EnvironmentNodeConfigArgs] = None,
        org_id: Optional[str] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiProxyType 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, and CONFIGURABLE.

DeploymentType 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, and ARCHIVE.

Description string

Description of the environment.

DisplayName string

Display name of the environment.

Name string

The resource ID of the environment.

NodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

OrgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

ApiProxyType 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, and CONFIGURABLE.

DeploymentType 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, and ARCHIVE.

Description string

Description of the environment.

DisplayName string

Display name of the environment.

Name string

The resource ID of the environment.

NodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

OrgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description String

Description of the environment.

displayName String

Display name of the environment.

name String

The resource ID of the environment.

nodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId String

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description string

Description of the environment.

displayName string

Display name of the environment.

name string

The resource ID of the environment.

nodeConfig EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId string

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

api_proxy_type str

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, and CONFIGURABLE.

deployment_type str

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, and ARCHIVE.

description str

Description of the environment.

display_name str

Display name of the environment.

name str

The resource ID of the environment.

node_config EnvironmentNodeConfigArgs

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

org_id str

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

apiProxyType 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, and CONFIGURABLE.

deploymentType 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, and ARCHIVE.

description String

Description of the environment.

displayName String

Display name of the environment.

name String

The resource ID of the environment.

nodeConfig Property Map

NodeConfig for setting the min/max number of nodes associated with the environment. Structure is documented below.

orgId String

The Apigee Organization associated with the Apigee environment, in the format organizations/{{org_name}}.

Supporting Types

EnvironmentNodeConfig

CurrentAggregateNodeCount string

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

MaxNodeCount string

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

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

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

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

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

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

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

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

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

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

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

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.

Import

Environment can be imported using any of these accepted formats

 $ pulumi import gcp:apigee/environment:Environment default {{org_id}}/environments/{{name}}
 $ pulumi import gcp:apigee/environment:Environment default {{org_id}}/{{name}}

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes

This Pulumi package is based on the google-beta Terraform Provider.