Google Cloud (GCP) Classic

Pulumi Official
Package maintained by Pulumi
v6.32.0 published on Wednesday, Jul 20, 2022 by Pulumi

Environment

Import

Environment can be imported using any of these accepted formats

 $ pulumi import gcp:composer/environment:Environment default projects/{{project}}/locations/{{region}}/environments/{{name}}
 $ pulumi import gcp:composer/environment:Environment default {{project}}/{{region}}/{{name}}
 $ pulumi import gcp:composer/environment:Environment default {{name}}

Create a Environment Resource

new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                config: Optional[EnvironmentConfigArgs] = None,
                labels: Optional[Mapping[str, str]] = None,
                name: Optional[str] = None,
                project: Optional[str] = None,
                region: Optional[str] = None)
@overload
def Environment(resource_name: str,
                args: Optional[EnvironmentArgs] = None,
                opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: gcp:composer: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:

Config EnvironmentConfigArgs

Configuration parameters for this environment.

Labels Dictionary<string, string>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

Name string

Name of the environment.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The location or Compute Engine region for the environment.

Config EnvironmentConfigArgs

Configuration parameters for this environment.

Labels map[string]string

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

Name string

Name of the environment.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels Map<String,String>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name String

Name of the environment.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels {[key: string]: string}

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name string

Name of the environment.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels Mapping[str, str]

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name str

Name of the environment.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The location or Compute Engine region for the environment.

config Property Map

Configuration parameters for this environment.

labels Map<String>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name String

Name of the environment.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The location or Compute Engine region for the environment.

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 an 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,
        config: Optional[EnvironmentConfigArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: 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:
Config EnvironmentConfigArgs

Configuration parameters for this environment.

Labels Dictionary<string, string>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

Name string

Name of the environment.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The location or Compute Engine region for the environment.

Config EnvironmentConfigArgs

Configuration parameters for this environment.

Labels map[string]string

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

Name string

Name of the environment.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Region string

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels Map<String,String>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name String

Name of the environment.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels {[key: string]: string}

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name string

Name of the environment.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region string

The location or Compute Engine region for the environment.

config EnvironmentConfigArgs

Configuration parameters for this environment.

labels Mapping[str, str]

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name str

Name of the environment.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region str

The location or Compute Engine region for the environment.

config Property Map

Configuration parameters for this environment.

labels Map<String>

User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size.

name String

Name of the environment.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region String

The location or Compute Engine region for the environment.

Supporting Types

EnvironmentConfig

EnvironmentConfigDatabaseConfig

EnvironmentConfigEncryptionConfig

KmsKeyName string
KmsKeyName string
kmsKeyName String
kmsKeyName string
kmsKeyName String

EnvironmentConfigMaintenanceWindow

EndTime string
Recurrence string
StartTime string
EndTime string
Recurrence string
StartTime string
endTime String
recurrence String
startTime String
endTime string
recurrence string
startTime string
endTime String
recurrence String
startTime String

EnvironmentConfigMasterAuthorizedNetworksConfig

EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock

CidrBlock string
DisplayName string
CidrBlock string
DisplayName string
cidrBlock String
displayName String
cidrBlock string
displayName string
cidrBlock String
displayName String

EnvironmentConfigNodeConfig

EnvironmentConfigNodeConfigIpAllocationPolicy

EnvironmentConfigPrivateEnvironmentConfig

EnvironmentConfigSoftwareConfig

AirflowConfigOverrides Dictionary<string, string>
EnvVariables Dictionary<string, string>
ImageVersion string
PypiPackages Dictionary<string, string>
PythonVersion string
SchedulerCount int
AirflowConfigOverrides map[string]string
EnvVariables map[string]string
ImageVersion string
PypiPackages map[string]string
PythonVersion string
SchedulerCount int
airflowConfigOverrides Map<String,String>
envVariables Map<String,String>
imageVersion String
pypiPackages Map<String,String>
pythonVersion String
schedulerCount Integer
airflowConfigOverrides {[key: string]: string}
envVariables {[key: string]: string}
imageVersion string
pypiPackages {[key: string]: string}
pythonVersion string
schedulerCount number
airflow_config_overrides Mapping[str, str]
env_variables Mapping[str, str]
image_version str
pypi_packages Mapping[str, str]
python_version str
scheduler_count int
airflowConfigOverrides Map<String>
envVariables Map<String>
imageVersion String
pypiPackages Map<String>
pythonVersion String
schedulerCount Number

EnvironmentConfigWebServerConfig

EnvironmentConfigWebServerNetworkAccessControl

EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

Value string
Description string
Value string
Description string
value String
description String
value string
description string
value String
description String

EnvironmentConfigWorkloadsConfig

EnvironmentConfigWorkloadsConfigScheduler

Count int
Cpu double
MemoryGb double
StorageGb double
Count int
Cpu float64
MemoryGb float64
StorageGb float64
count Integer
cpu Double
memoryGb Double
storageGb Double
count number
cpu number
memoryGb number
storageGb number
count int
cpu float
memory_gb float
storage_gb float
count Number
cpu Number
memoryGb Number
storageGb Number

EnvironmentConfigWorkloadsConfigWebServer

Cpu double
MemoryGb double
StorageGb double
Cpu float64
MemoryGb float64
StorageGb float64
cpu Double
memoryGb Double
storageGb Double
cpu number
memoryGb number
storageGb number
cpu float
memory_gb float
storage_gb float
cpu Number
memoryGb Number
storageGb Number

EnvironmentConfigWorkloadsConfigWorker

Cpu double
MaxCount int
MemoryGb double
MinCount int
StorageGb double
Cpu float64
MaxCount int
MemoryGb float64
MinCount int
StorageGb float64
cpu Double
maxCount Integer
memoryGb Double
minCount Integer
storageGb Double
cpu number
maxCount number
memoryGb number
minCount number
storageGb number
cpu Number
maxCount Number
memoryGb Number
minCount Number
storageGb Number

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.