Environment

An environment for running orchestration tasks.

Environments run Apache Airflow software on Google infrastructure.

To get more information about Environments, see:

Warning: We STRONGLY recommend you read the GCP guides as the Environment resource requires a long deployment process and involves several layers of GCP infrastructure, including a Kubernetes Engine cluster, Cloud Storage, and Compute networking resources. Due to limitations of the API, This provider will not be able to automatically find or manage many of these underlying resources. In particular: * It can take up to one hour to create or update an environment resource. In addition, GCP may only detect some errors in configuration when they are used (e.g. ~40-50 minutes into the creation process), and is prone to limited error reporting. If you encounter confusing or uninformative errors, please verify your configuration is valid against GCP Cloud Composer before filing bugs against this provider. * Environments create Google Cloud Storage buckets that do not get cleaned up automatically on environment deletion. More about Composer’s use of Cloud Storage.

Create a Environment Resource

new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);

def Environment(resource_name, opts=None, config=None, labels=None, name=None, project=None, region=None, __props__=None);

func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)

public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Environment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Environment resource accepts the following input properties:

Config EnvironmentConfigArgs: Configuration parameters for this environment Structure is documented below.
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 EnvironmentConfig: Configuration parameters for this environment Structure is documented below.
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 EnvironmentConfig: Configuration parameters for this environment Structure is documented below.
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 Dict[EnvironmentConfig]: Configuration parameters for this environment Structure is documented below.
labels Dict[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.

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

static get(resource_name, id, opts=None, config=None, labels=None, name=None, project=None, region=None, __props__=None);

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)

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.

The following state arguments are supported:

Config EnvironmentConfigArgs: Configuration parameters for this environment Structure is documented below.
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 EnvironmentConfig: Configuration parameters for this environment Structure is documented below.
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 EnvironmentConfig: Configuration parameters for this environment Structure is documented below.
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 Dict[EnvironmentConfig]: Configuration parameters for this environment Structure is documented below.
labels Dict[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.

Supporting Types

EnvironmentConfig

See the input and output API doc for this type.

AirflowUri string
DagGcsPrefix string
GkeCluster string
NodeConfig EnvironmentConfigNodeConfigArgs: The configuration used for the Kubernetes Engine cluster. Structure is documented below.
NodeCount int: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
PrivateEnvironmentConfig EnvironmentConfigPrivateEnvironmentConfigArgs: The configuration used for the Private IP Cloud Composer environment. Structure is documented below.
SoftwareConfig EnvironmentConfigSoftwareConfigArgs: The configuration settings for software inside the environment. Structure is documented below.
WebServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControlArgs: The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

AirflowUri string
DagGcsPrefix string
GkeCluster string
NodeConfig EnvironmentConfigNodeConfig: The configuration used for the Kubernetes Engine cluster. Structure is documented below.
NodeCount int: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
PrivateEnvironmentConfig EnvironmentConfigPrivateEnvironmentConfig: The configuration used for the Private IP Cloud Composer environment. Structure is documented below.
SoftwareConfig EnvironmentConfigSoftwareConfig: The configuration settings for software inside the environment. Structure is documented below.
WebServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl: The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

airflowUri string
dagGcsPrefix string
gkeCluster string
nodeConfig EnvironmentConfigNodeConfig: The configuration used for the Kubernetes Engine cluster. Structure is documented below.
nodeCount number: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
privateEnvironmentConfig EnvironmentConfigPrivateEnvironmentConfig: The configuration used for the Private IP Cloud Composer environment. Structure is documented below.
softwareConfig EnvironmentConfigSoftwareConfig: The configuration settings for software inside the environment. Structure is documented below.
webServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl: The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

airflowUri str
dagGcsPrefix str
gkeCluster str
node_config Dict[EnvironmentConfigNodeConfig]: The configuration used for the Kubernetes Engine cluster. Structure is documented below.
node_count float: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.
privateEnvironmentConfig Dict[EnvironmentConfigPrivateEnvironmentConfig]: The configuration used for the Private IP Cloud Composer environment. Structure is documented below.
softwareConfig Dict[EnvironmentConfigSoftwareConfig]: The configuration settings for software inside the environment. Structure is documented below.
webServerNetworkAccessControl Dict[EnvironmentConfigWebServerNetworkAccessControl]: The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

EnvironmentConfigNodeConfig

See the input and output API doc for this type.

Zone string: The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. “projects/{project}/zones/{zone}”). Must belong to the enclosing environment’s project and region.
DiskSizeGb int: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
IpAllocationPolicy EnvironmentConfigNodeConfigIpAllocationPolicyArgs: Configuration for controlling how IPs are allocated in the GKE cluster. Structure is documented below. Cannot be updated.
MachineType string: The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: “projects/{project}/zones/{zone}/machineTypes/{machineType}”. Must belong to the enclosing environment’s project and region/zone.
Network string: The Compute Engine network to be used for machine communications, specified as a self-link, relative resource name (e.g. “projects/{project}/global/networks/{network}”), by name.
OauthScopes List<string>: The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]
ServiceAccount string: The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
Subnetwork string: The Compute Engine subnetwork to be used for machine communications, , specified as a self-link, relative resource name (e.g. “projects/{project}/regions/{region}/subnetworks/{subnetwork}”), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment’s project and region.
Tags List<string>: The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.

Zone string: The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. “projects/{project}/zones/{zone}”). Must belong to the enclosing environment’s project and region.
DiskSizeGb int: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
IpAllocationPolicy EnvironmentConfigNodeConfigIpAllocationPolicy: Configuration for controlling how IPs are allocated in the GKE cluster. Structure is documented below. Cannot be updated.
MachineType string: The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: “projects/{project}/zones/{zone}/machineTypes/{machineType}”. Must belong to the enclosing environment’s project and region/zone.
Network string: The Compute Engine network to be used for machine communications, specified as a self-link, relative resource name (e.g. “projects/{project}/global/networks/{network}”), by name.
OauthScopes []string: The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]
ServiceAccount string: The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
Subnetwork string: The Compute Engine subnetwork to be used for machine communications, , specified as a self-link, relative resource name (e.g. “projects/{project}/regions/{region}/subnetworks/{subnetwork}”), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment’s project and region.
Tags []string: The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.

zone string: The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. “projects/{project}/zones/{zone}”). Must belong to the enclosing environment’s project and region.
diskSizeGb number: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
ipAllocationPolicy EnvironmentConfigNodeConfigIpAllocationPolicy: Configuration for controlling how IPs are allocated in the GKE cluster. Structure is documented below. Cannot be updated.
machineType string: The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: “projects/{project}/zones/{zone}/machineTypes/{machineType}”. Must belong to the enclosing environment’s project and region/zone.
network string: The Compute Engine network to be used for machine communications, specified as a self-link, relative resource name (e.g. “projects/{project}/global/networks/{network}”), by name.
oauthScopes string[]: The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]
serviceAccount string: The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
subnetwork string: The Compute Engine subnetwork to be used for machine communications, , specified as a self-link, relative resource name (e.g. “projects/{project}/regions/{region}/subnetworks/{subnetwork}”), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment’s project and region.
tags string[]: The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.

zone str: The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. “projects/{project}/zones/{zone}”). Must belong to the enclosing environment’s project and region.
disk_size_gb float: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.
ip_allocation_policy Dict[EnvironmentConfigNodeConfigIpAllocationPolicy]: Configuration for controlling how IPs are allocated in the GKE cluster. Structure is documented below. Cannot be updated.
machine_type str: The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: “projects/{project}/zones/{zone}/machineTypes/{machineType}”. Must belong to the enclosing environment’s project and region/zone.
network str: The Compute Engine network to be used for machine communications, specified as a self-link, relative resource name (e.g. “projects/{project}/global/networks/{network}”), by name.
oauthScopes List[str]: The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]
service_account str: The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
subnetwork str: The Compute Engine subnetwork to be used for machine communications, , specified as a self-link, relative resource name (e.g. “projects/{project}/regions/{region}/subnetworks/{subnetwork}”), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment’s project and region.
tags List[str]: The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.

EnvironmentConfigNodeConfigIpAllocationPolicy

See the input and output API doc for this type.

UseIpAliases bool: Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_block is present in config.
ClusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
ClusterSecondaryRangeName string: The name of the cluster’s secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.
ServicesIpv4CidrBlock string: The IP address range used to allocate IP addresses in this cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
ServicesSecondaryRangeName string: The name of the services’ secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.

UseIpAliases bool: Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_block is present in config.
ClusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
ClusterSecondaryRangeName string: The name of the cluster’s secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.
ServicesIpv4CidrBlock string: The IP address range used to allocate IP addresses in this cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
ServicesSecondaryRangeName string: The name of the services’ secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.

useIpAliases boolean: Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_block is present in config.
clusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
clusterSecondaryRangeName string: The name of the cluster’s secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.
servicesIpv4CidrBlock string: The IP address range used to allocate IP addresses in this cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
servicesSecondaryRangeName string: The name of the services’ secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.

useIpAliases bool: Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_block is present in config.
clusterIpv4CidrBlock str: The IP address range used to allocate IP addresses to pods in the cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
clusterSecondaryRangeName str: The name of the cluster’s secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.
servicesIpv4CidrBlock str: The IP address range used to allocate IP addresses in this cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
servicesSecondaryRangeName str: The name of the services’ secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. This field is applicable only when use_ip_aliases is true.

EnvironmentConfigPrivateEnvironmentConfig

See the input and output API doc for this type.

CloudSqlIpv4CidrBlock string: The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
EnablePrivateEndpoint bool: - If true, access to the public endpoint of the GKE cluster is denied.
MasterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster’s network. If left blank, the default value of ‘172.16.0.0/28’ is used.
WebServerIpv4CidrBlock string: The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

CloudSqlIpv4CidrBlock string: The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
EnablePrivateEndpoint bool: - If true, access to the public endpoint of the GKE cluster is denied.
MasterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster’s network. If left blank, the default value of ‘172.16.0.0/28’ is used.
WebServerIpv4CidrBlock string: The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

cloudSqlIpv4CidrBlock string: The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
enablePrivateEndpoint boolean: - If true, access to the public endpoint of the GKE cluster is denied.
masterIpv4CidrBlock string: The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster’s network. If left blank, the default value of ‘172.16.0.0/28’ is used.
webServerIpv4CidrBlock string: The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

cloudSqlIpv4CidrBlock str: The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block
enablePrivateEndpoint bool: - If true, access to the public endpoint of the GKE cluster is denied.
masterIpv4CidrBlock str: The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster’s network. If left blank, the default value of ‘172.16.0.0/28’ is used.
webServerIpv4CidrBlock str: The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block.

EnvironmentConfigSoftwareConfig

See the input and output API doc for this type.

AirflowConfigOverrides Dictionary<string, string>

- (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example “core-dags_are_paused_at_creation”.

EnvVariables Dictionary<string, string>

Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names:

import * as pulumi from "@pulumi/pulumi";

import pulumi

using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

ImageVersion string

- The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-[0-9]+\.[0-9]+(\.[0-9]+)?-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?. The Cloud Composer portion of the version is a semantic version. The portion of the image version following ‘airflow-’ is an official Apache Airflow repository release name. See documentation for allowed release names.

PypiPackages Dictionary<string, string>

Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. “numpy”). Values are the lowercase extras and version specifier (e.g. “==1.12.0”, “[devel,gcp_api]“, “[devel]>=1.8.2, <1.9.2”). To specify a package without pinning it to a version specifier, use the empty string as the value.

PythonVersion string

- The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to ‘2’ or ‘3’. If not specified, the default is ‘2’. Cannot be updated.

AirflowConfigOverrides map[string]string

- (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example “core-dags_are_paused_at_creation”.

EnvVariables map[string]string

import * as pulumi from "@pulumi/pulumi";

import pulumi

using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

ImageVersion string

PypiPackages map[string]string

PythonVersion string

- The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to ‘2’ or ‘3’. If not specified, the default is ‘2’. Cannot be updated.

airflowConfigOverrides {[key: string]: string}

- (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example “core-dags_are_paused_at_creation”.

envVariables {[key: string]: string}

import * as pulumi from "@pulumi/pulumi";

import pulumi

using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

imageVersion string

pypiPackages {[key: string]: string}

pythonVersion string

- The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to ‘2’ or ‘3’. If not specified, the default is ‘2’. Cannot be updated.

airflowConfigOverrides Dict[str, str]

- (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example “core-dags_are_paused_at_creation”.

env_variables Dict[str, str]

import * as pulumi from "@pulumi/pulumi";

import pulumi

using Pulumi;

class MyStack : Stack
{
    public MyStack()
    {
    }

}

package main

import (
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        return nil
    })
}

imageVersion str

pypiPackages Dict[str, str]

pythonVersion str

- The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to ‘2’ or ‘3’. If not specified, the default is ‘2’. Cannot be updated.

EnvironmentConfigWebServerNetworkAccessControl

See the input and output API doc for this type.

AllowedIpRanges List<EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArgs>: - A collection of allowed IP ranges with descriptions. Structure is documented below.

AllowedIpRanges []EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange: - A collection of allowed IP ranges with descriptions. Structure is documented below.

allowedIpRanges EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange[]: - A collection of allowed IP ranges with descriptions. Structure is documented below.

allowedIpRanges List[EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange]: - A collection of allowed IP ranges with descriptions. Structure is documented below.

EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

See the input and output API doc for this type.

Value string: IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
Description string: A description of this ip range.

Value string: IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
Description string: A description of this ip range.

value string: IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
description string: A description of this ip range.

value str: IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
description str: A description of this ip range.

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Environment

Create a Environment Resource

Environment Resource Properties

Inputs

Outputs

Look up an Existing Environment Resource

Supporting Types

EnvironmentConfig

EnvironmentConfigNodeConfig

EnvironmentConfigNodeConfigIpAllocationPolicy

EnvironmentConfigPrivateEnvironmentConfig

EnvironmentConfigSoftwareConfig

EnvironmentConfigWebServerNetworkAccessControl

EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

Package Details

On This Page