Google Cloud Classic v7.18.0, Apr 10 24

Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.composer.getEnvironment

Explore with Pulumi AI

Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

Example Usage

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

const composerEnvEnvironment = new gcp.composer.Environment("composer_env", {name: "composer-environment"});
const composerEnv = gcp.composer.getEnvironment({
    name: test.name,
});
export const debug = composerEnv.then(composerEnv => composerEnv.configs);

import pulumi
import pulumi_gcp as gcp

composer_env_environment = gcp.composer.Environment("composer_env", name="composer-environment")
composer_env = gcp.composer.get_environment(name=test["name"])
pulumi.export("debug", composer_env.configs)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/composer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := composer.NewEnvironment(ctx, "composer_env", &composer.EnvironmentArgs{
			Name: pulumi.String("composer-environment"),
		})
		if err != nil {
			return err
		}
		composerEnv, err := composer.LookupEnvironment(ctx, &composer.LookupEnvironmentArgs{
			Name: test.Name,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("debug", composerEnv.Configs)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var composerEnvEnvironment = new Gcp.Composer.Environment("composer_env", new()
    {
        Name = "composer-environment",
    });

    var composerEnv = Gcp.Composer.GetEnvironment.Invoke(new()
    {
        Name = test.Name,
    });

    return new Dictionary<string, object?>
    {
        ["debug"] = composerEnv.Apply(getEnvironmentResult => getEnvironmentResult.Configs),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.composer.Environment;
import com.pulumi.gcp.composer.EnvironmentArgs;
import com.pulumi.gcp.composer.ComposerFunctions;
import com.pulumi.gcp.composer.inputs.GetEnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var composerEnvEnvironment = new Environment("composerEnvEnvironment", EnvironmentArgs.builder()        
            .name("composer-environment")
            .build());

        final var composerEnv = ComposerFunctions.getEnvironment(GetEnvironmentArgs.builder()
            .name(test.name())
            .build());

        ctx.export("debug", composerEnv.applyValue(getEnvironmentResult -> getEnvironmentResult.configs()));
    }
}

resources:
  composerEnvEnvironment:
    type: gcp:composer:Environment
    name: composer_env
    properties:
      name: composer-environment
variables:
  composerEnv:
    fn::invoke:
      Function: gcp:composer:getEnvironment
      Arguments:
        name: ${test.name}
outputs:
  debug: ${composerEnv.configs}

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>

def get_environment(name: Optional[str] = None,
                    project: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(name: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    region: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]

func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: gcp:composer/getEnvironment:getEnvironment
  arguments:
    # arguments dictionary

The following arguments are supported:

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 of the environment.

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 of the environment.

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 of the environment.

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 of the environment.

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 of the environment.

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 of the environment.

getEnvironment Result

The following output properties are available:

Configs List<GetEnvironmentConfig>: Configuration parameters for the environment.
EffectiveLabels Dictionary<string, string>
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
Name string
PulumiLabels Dictionary<string, string>
StorageConfigs List<GetEnvironmentStorageConfig>
Project string
Region string

Configs []GetEnvironmentConfig: Configuration parameters for the environment.
EffectiveLabels map[string]string
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]string
Name string
PulumiLabels map[string]string
StorageConfigs []GetEnvironmentStorageConfig
Project string
Region string

configs List<GetEnvironmentConfig>: Configuration parameters for the environment.
effectiveLabels Map<String,String>
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,String>
name String
pulumiLabels Map<String,String>
storageConfigs List<GetEnvironmentStorageConfig>
project String
region String

configs GetEnvironmentConfig[]: Configuration parameters for the environment.
effectiveLabels {[key: string]: string}
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
name string
pulumiLabels {[key: string]: string}
storageConfigs GetEnvironmentStorageConfig[]
project string
region string

configs Sequence[GetEnvironmentConfig]: Configuration parameters for the environment.
effective_labels Mapping[str, str]
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
name str
pulumi_labels Mapping[str, str]
storage_configs Sequence[GetEnvironmentStorageConfig]
project str
region str

configs List<Property Map>: Configuration parameters for the environment.
effectiveLabels Map<String>
id String: The provider-assigned unique ID for this managed resource.
labels Map<String>
name String
pulumiLabels Map<String>
storageConfigs List<Property Map>
project String
region String

Supporting Types

GetEnvironmentConfig

AirflowUri string: The URI of the Apache Airflow Web UI hosted within the environment.
DagGcsPrefix string: The Cloud Storage prefix of the DAGs for the environment.
DataRetentionConfigs List<GetEnvironmentConfigDataRetentionConfig>: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
DatabaseConfigs List<GetEnvironmentConfigDatabaseConfig>: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
EnablePrivateBuildsOnly bool: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
EnablePrivateEnvironment bool: Optional. If true, a private Composer environment will be created.
EncryptionConfigs List<GetEnvironmentConfigEncryptionConfig>: The encryption options for the Composer environment and its dependencies.
EnvironmentSize string: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
GkeCluster string: The Kubernetes Engine cluster used to run the environment.
MaintenanceWindows List<GetEnvironmentConfigMaintenanceWindow>: The configuration for Cloud Composer maintenance window.
MasterAuthorizedNetworksConfigs List<GetEnvironmentConfigMasterAuthorizedNetworksConfig>: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
NodeConfigs List<GetEnvironmentConfigNodeConfig>: The configuration used for the Kubernetes Engine cluster.
NodeCount int: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
PrivateEnvironmentConfigs List<GetEnvironmentConfigPrivateEnvironmentConfig>: The configuration used for the Private IP Cloud Composer environment.
RecoveryConfigs List<GetEnvironmentConfigRecoveryConfig>: The recovery configuration settings for the Cloud Composer environment
ResilienceMode string: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
SoftwareConfigs List<GetEnvironmentConfigSoftwareConfig>: The configuration settings for software inside the environment.
WebServerConfigs List<GetEnvironmentConfigWebServerConfig>: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
WebServerNetworkAccessControls List<GetEnvironmentConfigWebServerNetworkAccessControl>: Network-level access control policy for the Airflow web server.
WorkloadsConfigs List<GetEnvironmentConfigWorkloadsConfig>: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

AirflowUri string: The URI of the Apache Airflow Web UI hosted within the environment.
DagGcsPrefix string: The Cloud Storage prefix of the DAGs for the environment.
DataRetentionConfigs []GetEnvironmentConfigDataRetentionConfig: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
DatabaseConfigs []GetEnvironmentConfigDatabaseConfig: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
EnablePrivateBuildsOnly bool: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
EnablePrivateEnvironment bool: Optional. If true, a private Composer environment will be created.
EncryptionConfigs []GetEnvironmentConfigEncryptionConfig: The encryption options for the Composer environment and its dependencies.
EnvironmentSize string: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
GkeCluster string: The Kubernetes Engine cluster used to run the environment.
MaintenanceWindows []GetEnvironmentConfigMaintenanceWindow: The configuration for Cloud Composer maintenance window.
MasterAuthorizedNetworksConfigs []GetEnvironmentConfigMasterAuthorizedNetworksConfig: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
NodeConfigs []GetEnvironmentConfigNodeConfig: The configuration used for the Kubernetes Engine cluster.
NodeCount int: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
PrivateEnvironmentConfigs []GetEnvironmentConfigPrivateEnvironmentConfig: The configuration used for the Private IP Cloud Composer environment.
RecoveryConfigs []GetEnvironmentConfigRecoveryConfig: The recovery configuration settings for the Cloud Composer environment
ResilienceMode string: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
SoftwareConfigs []GetEnvironmentConfigSoftwareConfig: The configuration settings for software inside the environment.
WebServerConfigs []GetEnvironmentConfigWebServerConfig: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
WebServerNetworkAccessControls []GetEnvironmentConfigWebServerNetworkAccessControl: Network-level access control policy for the Airflow web server.
WorkloadsConfigs []GetEnvironmentConfigWorkloadsConfig: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

airflowUri String: The URI of the Apache Airflow Web UI hosted within the environment.
dagGcsPrefix String: The Cloud Storage prefix of the DAGs for the environment.
dataRetentionConfigs List<GetEnvironmentConfigDataRetentionConfig>: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
databaseConfigs List<GetEnvironmentConfigDatabaseConfig>: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivateBuildsOnly Boolean: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
enablePrivateEnvironment Boolean: Optional. If true, a private Composer environment will be created.
encryptionConfigs List<GetEnvironmentConfigEncryptionConfig>: The encryption options for the Composer environment and its dependencies.
environmentSize String: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
gkeCluster String: The Kubernetes Engine cluster used to run the environment.
maintenanceWindows List<GetEnvironmentConfigMaintenanceWindow>: The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfigs List<GetEnvironmentConfigMasterAuthorizedNetworksConfig>: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
nodeConfigs List<GetEnvironmentConfigNodeConfig>: The configuration used for the Kubernetes Engine cluster.
nodeCount Integer: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
privateEnvironmentConfigs List<GetEnvironmentConfigPrivateEnvironmentConfig>: The configuration used for the Private IP Cloud Composer environment.
recoveryConfigs List<GetEnvironmentConfigRecoveryConfig>: The recovery configuration settings for the Cloud Composer environment
resilienceMode String: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
softwareConfigs List<GetEnvironmentConfigSoftwareConfig>: The configuration settings for software inside the environment.
webServerConfigs List<GetEnvironmentConfigWebServerConfig>: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
webServerNetworkAccessControls List<GetEnvironmentConfigWebServerNetworkAccessControl>: Network-level access control policy for the Airflow web server.
workloadsConfigs List<GetEnvironmentConfigWorkloadsConfig>: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

airflowUri string: The URI of the Apache Airflow Web UI hosted within the environment.
dagGcsPrefix string: The Cloud Storage prefix of the DAGs for the environment.
dataRetentionConfigs GetEnvironmentConfigDataRetentionConfig[]: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
databaseConfigs GetEnvironmentConfigDatabaseConfig[]: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivateBuildsOnly boolean: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
enablePrivateEnvironment boolean: Optional. If true, a private Composer environment will be created.
encryptionConfigs GetEnvironmentConfigEncryptionConfig[]: The encryption options for the Composer environment and its dependencies.
environmentSize string: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
gkeCluster string: The Kubernetes Engine cluster used to run the environment.
maintenanceWindows GetEnvironmentConfigMaintenanceWindow[]: The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfigs GetEnvironmentConfigMasterAuthorizedNetworksConfig[]: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
nodeConfigs GetEnvironmentConfigNodeConfig[]: The configuration used for the Kubernetes Engine cluster.
nodeCount number: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
privateEnvironmentConfigs GetEnvironmentConfigPrivateEnvironmentConfig[]: The configuration used for the Private IP Cloud Composer environment.
recoveryConfigs GetEnvironmentConfigRecoveryConfig[]: The recovery configuration settings for the Cloud Composer environment
resilienceMode string: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
softwareConfigs GetEnvironmentConfigSoftwareConfig[]: The configuration settings for software inside the environment.
webServerConfigs GetEnvironmentConfigWebServerConfig[]: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
webServerNetworkAccessControls GetEnvironmentConfigWebServerNetworkAccessControl[]: Network-level access control policy for the Airflow web server.
workloadsConfigs GetEnvironmentConfigWorkloadsConfig[]: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

airflow_uri str: The URI of the Apache Airflow Web UI hosted within the environment.
dag_gcs_prefix str: The Cloud Storage prefix of the DAGs for the environment.
data_retention_configs Sequence[GetEnvironmentConfigDataRetentionConfig]: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
database_configs Sequence[GetEnvironmentConfigDatabaseConfig]: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enable_private_builds_only bool: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
enable_private_environment bool: Optional. If true, a private Composer environment will be created.
encryption_configs Sequence[GetEnvironmentConfigEncryptionConfig]: The encryption options for the Composer environment and its dependencies.
environment_size str: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
gke_cluster str: The Kubernetes Engine cluster used to run the environment.
maintenance_windows Sequence[GetEnvironmentConfigMaintenanceWindow]: The configuration for Cloud Composer maintenance window.
master_authorized_networks_configs Sequence[GetEnvironmentConfigMasterAuthorizedNetworksConfig]: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
node_configs Sequence[GetEnvironmentConfigNodeConfig]: The configuration used for the Kubernetes Engine cluster.
node_count int: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
private_environment_configs Sequence[GetEnvironmentConfigPrivateEnvironmentConfig]: The configuration used for the Private IP Cloud Composer environment.
recovery_configs Sequence[GetEnvironmentConfigRecoveryConfig]: The recovery configuration settings for the Cloud Composer environment
resilience_mode str: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
software_configs Sequence[GetEnvironmentConfigSoftwareConfig]: The configuration settings for software inside the environment.
web_server_configs Sequence[GetEnvironmentConfigWebServerConfig]: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
web_server_network_access_controls Sequence[GetEnvironmentConfigWebServerNetworkAccessControl]: Network-level access control policy for the Airflow web server.
workloads_configs Sequence[GetEnvironmentConfigWorkloadsConfig]: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

airflowUri String: The URI of the Apache Airflow Web UI hosted within the environment.
dagGcsPrefix String: The Cloud Storage prefix of the DAGs for the environment.
dataRetentionConfigs List<Property Map>: The configuration setting for Airflow data retention mechanism. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4. or newer
databaseConfigs List<Property Map>: The configuration of Cloud SQL instance that is used by the Apache Airflow software. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivateBuildsOnly Boolean: Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services. If false, the builds also have access to the internet.
enablePrivateEnvironment Boolean: Optional. If true, a private Composer environment will be created.
encryptionConfigs List<Property Map>: The encryption options for the Composer environment and its dependencies.
environmentSize String: The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
gkeCluster String: The Kubernetes Engine cluster used to run the environment.
maintenanceWindows List<Property Map>: The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfigs List<Property Map>: Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
nodeConfigs List<Property Map>: The configuration used for the Kubernetes Engine cluster.
nodeCount Number: The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
privateEnvironmentConfigs List<Property Map>: The configuration used for the Private IP Cloud Composer environment.
recoveryConfigs List<Property Map>: The recovery configuration settings for the Cloud Composer environment
resilienceMode String: Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
softwareConfigs List<Property Map>: The configuration settings for software inside the environment.
webServerConfigs List<Property Map>: The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
webServerNetworkAccessControls List<Property Map>: Network-level access control policy for the Airflow web server.
workloadsConfigs List<Property Map>: The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

GetEnvironmentConfigDataRetentionConfig

TaskLogsRetentionConfigs List<GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig>: Optional. The configuration setting for Task Logs.

TaskLogsRetentionConfigs []GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig: Optional. The configuration setting for Task Logs.

taskLogsRetentionConfigs List<GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig>: Optional. The configuration setting for Task Logs.

taskLogsRetentionConfigs GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig[]: Optional. The configuration setting for Task Logs.

task_logs_retention_configs Sequence[GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig]: Optional. The configuration setting for Task Logs.

taskLogsRetentionConfigs List<Property Map>: Optional. The configuration setting for Task Logs.

GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig

StorageMode string: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

StorageMode string: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

storageMode String: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

storageMode string: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

storage_mode str: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

storageMode String: Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.

GetEnvironmentConfigDatabaseConfig

MachineType string: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
Zone string: Optional. Cloud SQL database preferred zone.

MachineType string: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
Zone string: Optional. Cloud SQL database preferred zone.

machineType String: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
zone String: Optional. Cloud SQL database preferred zone.

machineType string: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
zone string: Optional. Cloud SQL database preferred zone.

machine_type str: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
zone str: Optional. Cloud SQL database preferred zone.

machineType String: Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
zone String: Optional. Cloud SQL database preferred zone.

GetEnvironmentConfigEncryptionConfig

KmsKeyName string: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

KmsKeyName string: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

kmsKeyName String: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

kmsKeyName string: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

kms_key_name str: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

kmsKeyName String: Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

GetEnvironmentConfigMaintenanceWindow

EndTime string: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
Recurrence string: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
StartTime string: Start time of the first recurrence of the maintenance window.

EndTime string: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
Recurrence string: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
StartTime string: Start time of the first recurrence of the maintenance window.

endTime String: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
recurrence String: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
startTime String: Start time of the first recurrence of the maintenance window.

endTime string: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
recurrence string: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
startTime string: Start time of the first recurrence of the maintenance window.

end_time str: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
recurrence str: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
start_time str: Start time of the first recurrence of the maintenance window.

endTime String: Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
recurrence String: Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
startTime String: Start time of the first recurrence of the maintenance window.

GetEnvironmentConfigMasterAuthorizedNetworksConfig

CidrBlocks List<GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock>: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
Enabled bool: Whether or not master authorized networks is enabled.

CidrBlocks []GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
Enabled bool: Whether or not master authorized networks is enabled.

cidrBlocks List<GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock>: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled Boolean: Whether or not master authorized networks is enabled.

cidrBlocks GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock[]: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled boolean: Whether or not master authorized networks is enabled.

cidr_blocks Sequence[GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock]: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled bool: Whether or not master authorized networks is enabled.

cidrBlocks List<Property Map>: cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled Boolean: Whether or not master authorized networks is enabled.

GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock

CidrBlock string: cidr_block must be specified in CIDR notation.
DisplayName string: display_name is a field for users to identify CIDR blocks.

CidrBlock string: cidr_block must be specified in CIDR notation.
DisplayName string: display_name is a field for users to identify CIDR blocks.

cidrBlock String: cidr_block must be specified in CIDR notation.
displayName String: display_name is a field for users to identify CIDR blocks.

cidrBlock string: cidr_block must be specified in CIDR notation.
displayName string: display_name is a field for users to identify CIDR blocks.

cidr_block str: cidr_block must be specified in CIDR notation.
display_name str: display_name is a field for users to identify CIDR blocks.

cidrBlock String: cidr_block must be specified in CIDR notation.
displayName String: display_name is a field for users to identify CIDR blocks.

GetEnvironmentConfigNodeConfig

ComposerInternalIpv4CidrBlock string: IPv4 cidr range that will be used by Composer internal components.
ComposerNetworkAttachment string: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
DiskSizeGb int: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
EnableIpMasqAgent bool: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
IpAllocationPolicies List<GetEnvironmentConfigNodeConfigIpAllocationPolicy>: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
MaxPodsPerNode int: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
Network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

ComposerInternalIpv4CidrBlock string: IPv4 cidr range that will be used by Composer internal components.
ComposerNetworkAttachment string: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
DiskSizeGb int: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
EnableIpMasqAgent bool: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
IpAllocationPolicies []GetEnvironmentConfigNodeConfigIpAllocationPolicy: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
MaxPodsPerNode int: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
Network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

composerInternalIpv4CidrBlock String: IPv4 cidr range that will be used by Composer internal components.
composerNetworkAttachment String: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
diskSizeGb Integer: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enableIpMasqAgent Boolean: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
ipAllocationPolicies List<GetEnvironmentConfigNodeConfigIpAllocationPolicy>: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
maxPodsPerNode Integer: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

composerInternalIpv4CidrBlock string: IPv4 cidr range that will be used by Composer internal components.
composerNetworkAttachment string: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
diskSizeGb number: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enableIpMasqAgent boolean: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
ipAllocationPolicies GetEnvironmentConfigNodeConfigIpAllocationPolicy[]: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
maxPodsPerNode number: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

composer_internal_ipv4_cidr_block str: IPv4 cidr range that will be used by Composer internal components.
composer_network_attachment str: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
disk_size_gb int: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enable_ip_masq_agent bool: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
ip_allocation_policies Sequence[GetEnvironmentConfigNodeConfigIpAllocationPolicy]: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
max_pods_per_node int: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
oauth_scopes Sequence[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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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 Sequence[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.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

composerInternalIpv4CidrBlock String: IPv4 cidr range that will be used by Composer internal components.
composerNetworkAttachment String: PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
diskSizeGb Number: The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
enableIpMasqAgent Boolean: Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
ipAllocationPolicies List<Property Map>: Configuration for controlling how IPs are allocated in the GKE cluster. 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
maxPodsPerNode Number: The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
network 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. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
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"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

GetEnvironmentConfigNodeConfigIpAllocationPolicy

ClusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

ClusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

clusterIpv4CidrBlock String: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

clusterIpv4CidrBlock string: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

cluster_ipv4_cidr_block str: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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.
cluster_secondary_range_name 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
services_ipv4_cidr_block str: The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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.
services_secondary_range_name 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
use_ip_aliases 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

clusterIpv4CidrBlock String: The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. 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. For Cloud Composer environments in versions composer-1..-airflow-..*, 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_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.

GetEnvironmentConfigPrivateEnvironmentConfig

CloudComposerConnectionSubnetwork string: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
CloudComposerNetworkIpv4CidrBlock string: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
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.
ConnectionType string: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
EnablePrivateEndpoint bool: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
EnablePrivatelyUsedPublicIps bool: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

CloudComposerConnectionSubnetwork string: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
CloudComposerNetworkIpv4CidrBlock string: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
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.
ConnectionType string: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
EnablePrivateEndpoint bool: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
EnablePrivatelyUsedPublicIps bool: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

cloudComposerConnectionSubnetwork String: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloudComposerNetworkIpv4CidrBlock String: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
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.
connectionType String: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint Boolean: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivatelyUsedPublicIps Boolean: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

cloudComposerConnectionSubnetwork string: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloudComposerNetworkIpv4CidrBlock string: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
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.
connectionType string: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint boolean: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivatelyUsedPublicIps boolean: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

cloud_composer_connection_subnetwork str: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloud_composer_network_ipv4_cidr_block str: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloud_sql_ipv4_cidr_block 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.
connection_type str: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enable_private_endpoint bool: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
enable_privately_used_public_ips bool: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
master_ipv4_cidr_block 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.
web_server_ipv4_cidr_block 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

cloudComposerConnectionSubnetwork String: When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloudComposerNetworkIpv4CidrBlock String: The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
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.
connectionType String: Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint Boolean: If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
enablePrivatelyUsedPublicIps Boolean: When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.

GetEnvironmentConfigRecoveryConfig

ScheduledSnapshotsConfigs List<GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig>: The configuration settings for scheduled snapshots.

ScheduledSnapshotsConfigs []GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig: The configuration settings for scheduled snapshots.

scheduledSnapshotsConfigs List<GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig>: The configuration settings for scheduled snapshots.

scheduledSnapshotsConfigs GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig[]: The configuration settings for scheduled snapshots.

scheduled_snapshots_configs Sequence[GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig]: The configuration settings for scheduled snapshots.

scheduledSnapshotsConfigs List<Property Map>: The configuration settings for scheduled snapshots.

GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig

Enabled bool: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
SnapshotCreationSchedule string: Snapshot schedule, in the unix-cron format.
SnapshotLocation string: the URI of a bucket folder where to save the snapshot.
TimeZone string: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

Enabled bool: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
SnapshotCreationSchedule string: Snapshot schedule, in the unix-cron format.
SnapshotLocation string: the URI of a bucket folder where to save the snapshot.
TimeZone string: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

enabled Boolean: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
snapshotCreationSchedule String: Snapshot schedule, in the unix-cron format.
snapshotLocation String: the URI of a bucket folder where to save the snapshot.
timeZone String: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

enabled boolean: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
snapshotCreationSchedule string: Snapshot schedule, in the unix-cron format.
snapshotLocation string: the URI of a bucket folder where to save the snapshot.
timeZone string: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

enabled bool: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
snapshot_creation_schedule str: Snapshot schedule, in the unix-cron format.
snapshot_location str: the URI of a bucket folder where to save the snapshot.
time_zone str: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

enabled Boolean: When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
snapshotCreationSchedule String: Snapshot schedule, in the unix-cron format.
snapshotLocation String: the URI of a bucket folder where to save the snapshot.
timeZone String: A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.

GetEnvironmentConfigSoftwareConfig

AirflowConfigOverrides Dictionary<string, string>: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
CloudDataLineageIntegrations List<GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration>: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
SchedulerCount int: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
WebServerPluginsMode string: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

AirflowConfigOverrides map[string]string: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
CloudDataLineageIntegrations []GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
EnvVariables map[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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
PypiPackages map[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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
SchedulerCount int: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
WebServerPluginsMode string: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

airflowConfigOverrides Map<String,String>: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
cloudDataLineageIntegrations List<GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration>: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
envVariables Map<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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
pypiPackages Map<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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
schedulerCount Integer: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
webServerPluginsMode String: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

airflowConfigOverrides {[key: string]: string}: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
cloudDataLineageIntegrations GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration[]: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
envVariables {[key: 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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
pypiPackages {[key: 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
schedulerCount number: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
webServerPluginsMode string: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

airflow_config_overrides Mapping[str, str]: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
cloud_data_lineage_integrations Sequence[GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration]: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
env_variables Mapping[str, str]: 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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
image_version str: 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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
pypi_packages Mapping[str, str]: 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.
python_version 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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
scheduler_count int: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
web_server_plugins_mode str: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

airflowConfigOverrides Map<String>: 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". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
cloudDataLineageIntegrations List<Property Map>: The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
envVariables Map<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: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
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]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
pypiPackages Map<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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
schedulerCount Number: The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
webServerPluginsMode String: Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.

GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration

Enabled bool: Whether or not Cloud Data Lineage integration is enabled.

Enabled bool: Whether or not Cloud Data Lineage integration is enabled.

enabled Boolean: Whether or not Cloud Data Lineage integration is enabled.

enabled boolean: Whether or not Cloud Data Lineage integration is enabled.

enabled bool: Whether or not Cloud Data Lineage integration is enabled.

enabled Boolean: Whether or not Cloud Data Lineage integration is enabled.

GetEnvironmentConfigWebServerConfig

MachineType string: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

MachineType string: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

machineType String: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

machineType string: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

machine_type str: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

machineType String: Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.

GetEnvironmentConfigWebServerNetworkAccessControl

AllowedIpRanges List<GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange>: A collection of allowed IP ranges with descriptions.

AllowedIpRanges []GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange: A collection of allowed IP ranges with descriptions.

allowedIpRanges List<GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange>: A collection of allowed IP ranges with descriptions.

allowedIpRanges GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange[]: A collection of allowed IP ranges with descriptions.

allowed_ip_ranges Sequence[GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange]: A collection of allowed IP ranges with descriptions.

allowedIpRanges List<Property Map>: A collection of allowed IP ranges with descriptions.

GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

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

GetEnvironmentConfigWorkloadsConfig

DagProcessors List<GetEnvironmentConfigWorkloadsConfigDagProcessor>: Configuration for resources used by DAG processor.
Schedulers List<GetEnvironmentConfigWorkloadsConfigScheduler>: Configuration for resources used by Airflow schedulers.
Triggerers List<GetEnvironmentConfigWorkloadsConfigTriggerer>: Configuration for resources used by Airflow triggerers.
WebServers List<GetEnvironmentConfigWorkloadsConfigWebServer>: Configuration for resources used by Airflow web server.
Workers List<GetEnvironmentConfigWorkloadsConfigWorker>: Configuration for resources used by Airflow workers.

DagProcessors []GetEnvironmentConfigWorkloadsConfigDagProcessor: Configuration for resources used by DAG processor.
Schedulers []GetEnvironmentConfigWorkloadsConfigScheduler: Configuration for resources used by Airflow schedulers.
Triggerers []GetEnvironmentConfigWorkloadsConfigTriggerer: Configuration for resources used by Airflow triggerers.
WebServers []GetEnvironmentConfigWorkloadsConfigWebServer: Configuration for resources used by Airflow web server.
Workers []GetEnvironmentConfigWorkloadsConfigWorker: Configuration for resources used by Airflow workers.

dagProcessors List<GetEnvironmentConfigWorkloadsConfigDagProcessor>: Configuration for resources used by DAG processor.
schedulers List<GetEnvironmentConfigWorkloadsConfigScheduler>: Configuration for resources used by Airflow schedulers.
triggerers List<GetEnvironmentConfigWorkloadsConfigTriggerer>: Configuration for resources used by Airflow triggerers.
webServers List<GetEnvironmentConfigWorkloadsConfigWebServer>: Configuration for resources used by Airflow web server.
workers List<GetEnvironmentConfigWorkloadsConfigWorker>: Configuration for resources used by Airflow workers.

dagProcessors GetEnvironmentConfigWorkloadsConfigDagProcessor[]: Configuration for resources used by DAG processor.
schedulers GetEnvironmentConfigWorkloadsConfigScheduler[]: Configuration for resources used by Airflow schedulers.
triggerers GetEnvironmentConfigWorkloadsConfigTriggerer[]: Configuration for resources used by Airflow triggerers.
webServers GetEnvironmentConfigWorkloadsConfigWebServer[]: Configuration for resources used by Airflow web server.
workers GetEnvironmentConfigWorkloadsConfigWorker[]: Configuration for resources used by Airflow workers.

dag_processors Sequence[GetEnvironmentConfigWorkloadsConfigDagProcessor]: Configuration for resources used by DAG processor.
schedulers Sequence[GetEnvironmentConfigWorkloadsConfigScheduler]: Configuration for resources used by Airflow schedulers.
triggerers Sequence[GetEnvironmentConfigWorkloadsConfigTriggerer]: Configuration for resources used by Airflow triggerers.
web_servers Sequence[GetEnvironmentConfigWorkloadsConfigWebServer]: Configuration for resources used by Airflow web server.
workers Sequence[GetEnvironmentConfigWorkloadsConfigWorker]: Configuration for resources used by Airflow workers.

dagProcessors List<Property Map>: Configuration for resources used by DAG processor.
schedulers List<Property Map>: Configuration for resources used by Airflow schedulers.
triggerers List<Property Map>: Configuration for resources used by Airflow triggerers.
webServers List<Property Map>: Configuration for resources used by Airflow web server.
workers List<Property Map>: Configuration for resources used by Airflow workers.

GetEnvironmentConfigWorkloadsConfigDagProcessor

Count int: Number of DAG processors.
Cpu double: CPU request and limit for DAG processor.
MemoryGb double: Memory (GB) request and limit for DAG processor.
StorageGb double: Storage (GB) request and limit for DAG processor.

Count int: Number of DAG processors.
Cpu float64: CPU request and limit for DAG processor.
MemoryGb float64: Memory (GB) request and limit for DAG processor.
StorageGb float64: Storage (GB) request and limit for DAG processor.

count Integer: Number of DAG processors.
cpu Double: CPU request and limit for DAG processor.
memoryGb Double: Memory (GB) request and limit for DAG processor.
storageGb Double: Storage (GB) request and limit for DAG processor.

count number: Number of DAG processors.
cpu number: CPU request and limit for DAG processor.
memoryGb number: Memory (GB) request and limit for DAG processor.
storageGb number: Storage (GB) request and limit for DAG processor.

count int: Number of DAG processors.
cpu float: CPU request and limit for DAG processor.
memory_gb float: Memory (GB) request and limit for DAG processor.
storage_gb float: Storage (GB) request and limit for DAG processor.

count Number: Number of DAG processors.
cpu Number: CPU request and limit for DAG processor.
memoryGb Number: Memory (GB) request and limit for DAG processor.
storageGb Number: Storage (GB) request and limit for DAG processor.

GetEnvironmentConfigWorkloadsConfigScheduler

Count int: The number of schedulers.
Cpu double: CPU request and limit for a single Airflow scheduler replica
MemoryGb double: Memory (GB) request and limit for a single Airflow scheduler replica.
StorageGb double: Storage (GB) request and limit for a single Airflow scheduler replica.

Count int: The number of schedulers.
Cpu float64: CPU request and limit for a single Airflow scheduler replica
MemoryGb float64: Memory (GB) request and limit for a single Airflow scheduler replica.
StorageGb float64: Storage (GB) request and limit for a single Airflow scheduler replica.

count Integer: The number of schedulers.
cpu Double: CPU request and limit for a single Airflow scheduler replica
memoryGb Double: Memory (GB) request and limit for a single Airflow scheduler replica.
storageGb Double: Storage (GB) request and limit for a single Airflow scheduler replica.

count number: The number of schedulers.
cpu number: CPU request and limit for a single Airflow scheduler replica
memoryGb number: Memory (GB) request and limit for a single Airflow scheduler replica.
storageGb number: Storage (GB) request and limit for a single Airflow scheduler replica.

count int: The number of schedulers.
cpu float: CPU request and limit for a single Airflow scheduler replica
memory_gb float: Memory (GB) request and limit for a single Airflow scheduler replica.
storage_gb float: Storage (GB) request and limit for a single Airflow scheduler replica.

count Number: The number of schedulers.
cpu Number: CPU request and limit for a single Airflow scheduler replica
memoryGb Number: Memory (GB) request and limit for a single Airflow scheduler replica.
storageGb Number: Storage (GB) request and limit for a single Airflow scheduler replica.

GetEnvironmentConfigWorkloadsConfigTriggerer

Count int: The number of triggerers.
Cpu double: CPU request and limit for a single Airflow triggerer replica.
MemoryGb double: Memory (GB) request and limit for a single Airflow triggerer replica.

Count int: The number of triggerers.
Cpu float64: CPU request and limit for a single Airflow triggerer replica.
MemoryGb float64: Memory (GB) request and limit for a single Airflow triggerer replica.

count Integer: The number of triggerers.
cpu Double: CPU request and limit for a single Airflow triggerer replica.
memoryGb Double: Memory (GB) request and limit for a single Airflow triggerer replica.

count number: The number of triggerers.
cpu number: CPU request and limit for a single Airflow triggerer replica.
memoryGb number: Memory (GB) request and limit for a single Airflow triggerer replica.

count int: The number of triggerers.
cpu float: CPU request and limit for a single Airflow triggerer replica.
memory_gb float: Memory (GB) request and limit for a single Airflow triggerer replica.

count Number: The number of triggerers.
cpu Number: CPU request and limit for a single Airflow triggerer replica.
memoryGb Number: Memory (GB) request and limit for a single Airflow triggerer replica.

GetEnvironmentConfigWorkloadsConfigWebServer

Cpu double: CPU request and limit for Airflow web server.
MemoryGb double: Memory (GB) request and limit for Airflow web server.
StorageGb double: Storage (GB) request and limit for Airflow web server.

Cpu float64: CPU request and limit for Airflow web server.
MemoryGb float64: Memory (GB) request and limit for Airflow web server.
StorageGb float64: Storage (GB) request and limit for Airflow web server.

cpu Double: CPU request and limit for Airflow web server.
memoryGb Double: Memory (GB) request and limit for Airflow web server.
storageGb Double: Storage (GB) request and limit for Airflow web server.

cpu number: CPU request and limit for Airflow web server.
memoryGb number: Memory (GB) request and limit for Airflow web server.
storageGb number: Storage (GB) request and limit for Airflow web server.

cpu float: CPU request and limit for Airflow web server.
memory_gb float: Memory (GB) request and limit for Airflow web server.
storage_gb float: Storage (GB) request and limit for Airflow web server.

cpu Number: CPU request and limit for Airflow web server.
memoryGb Number: Memory (GB) request and limit for Airflow web server.
storageGb Number: Storage (GB) request and limit for Airflow web server.

GetEnvironmentConfigWorkloadsConfigWorker

Cpu double: CPU request and limit for a single Airflow worker replica.
MaxCount int: Maximum number of workers for autoscaling.
MemoryGb double: Memory (GB) request and limit for a single Airflow worker replica.
MinCount int: Minimum number of workers for autoscaling.
StorageGb double: Storage (GB) request and limit for a single Airflow worker replica.

Cpu float64: CPU request and limit for a single Airflow worker replica.
MaxCount int: Maximum number of workers for autoscaling.
MemoryGb float64: Memory (GB) request and limit for a single Airflow worker replica.
MinCount int: Minimum number of workers for autoscaling.
StorageGb float64: Storage (GB) request and limit for a single Airflow worker replica.

cpu Double: CPU request and limit for a single Airflow worker replica.
maxCount Integer: Maximum number of workers for autoscaling.
memoryGb Double: Memory (GB) request and limit for a single Airflow worker replica.
minCount Integer: Minimum number of workers for autoscaling.
storageGb Double: Storage (GB) request and limit for a single Airflow worker replica.

cpu number: CPU request and limit for a single Airflow worker replica.
maxCount number: Maximum number of workers for autoscaling.
memoryGb number: Memory (GB) request and limit for a single Airflow worker replica.
minCount number: Minimum number of workers for autoscaling.
storageGb number: Storage (GB) request and limit for a single Airflow worker replica.

cpu float: CPU request and limit for a single Airflow worker replica.
max_count int: Maximum number of workers for autoscaling.
memory_gb float: Memory (GB) request and limit for a single Airflow worker replica.
min_count int: Minimum number of workers for autoscaling.
storage_gb float: Storage (GB) request and limit for a single Airflow worker replica.

cpu Number: CPU request and limit for a single Airflow worker replica.
maxCount Number: Maximum number of workers for autoscaling.
memoryGb Number: Memory (GB) request and limit for a single Airflow worker replica.
minCount Number: Minimum number of workers for autoscaling.
storageGb Number: Storage (GB) request and limit for a single Airflow worker replica.

GetEnvironmentStorageConfig

Bucket string: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

Bucket string: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

bucket String: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

bucket string: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

bucket str: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

bucket String: Optional. Name of an existing Cloud Storage bucket to be used by the environment.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.composer.getEnvironment

On this page

On this page

Example Usage

Using getEnvironment

getEnvironment Result

Supporting Types

GetEnvironmentConfig

GetEnvironmentConfigDataRetentionConfig

GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig

GetEnvironmentConfigDatabaseConfig

GetEnvironmentConfigEncryptionConfig

GetEnvironmentConfigMaintenanceWindow

GetEnvironmentConfigMasterAuthorizedNetworksConfig

GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock

GetEnvironmentConfigNodeConfig

GetEnvironmentConfigNodeConfigIpAllocationPolicy

GetEnvironmentConfigPrivateEnvironmentConfig

GetEnvironmentConfigRecoveryConfig

GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig

GetEnvironmentConfigSoftwareConfig

GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration

GetEnvironmentConfigWebServerConfig

GetEnvironmentConfigWebServerNetworkAccessControl

GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

GetEnvironmentConfigWorkloadsConfig

GetEnvironmentConfigWorkloadsConfigDagProcessor

GetEnvironmentConfigWorkloadsConfigScheduler

GetEnvironmentConfigWorkloadsConfigTriggerer

GetEnvironmentConfigWorkloadsConfigWebServer

GetEnvironmentConfigWorkloadsConfigWorker

GetEnvironmentStorageConfig

Package Details

On this page

On this page