Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. composer
  5. Environment
Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.composer.Environment

Explore with Pulumi AI

Google Cloud v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp

Import

Environment can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{region}}/environments/{{name}}

  • {{project}}/{{region}}/{{name}}

  • {{name}}

When using the pulumi import command, Environment can be imported using one of the formats above. For example:

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

Create Environment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
                args: Optional[EnvironmentArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                config: Optional[EnvironmentConfigArgs] = None,
                labels: Optional[Mapping[str, str]] = None,
                name: Optional[str] = None,
                project: Optional[str] = None,
                region: Optional[str] = None,
                storage_config: Optional[EnvironmentStorageConfigArgs] = None)
func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

type: gcp:composer:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gcpEnvironmentResource = new Gcp.Composer.Environment("gcpEnvironmentResource", new()
{
    Config = new Gcp.Composer.Inputs.EnvironmentConfigArgs
    {
        AirflowUri = "string",
        DagGcsPrefix = "string",
        DataRetentionConfig = new Gcp.Composer.Inputs.EnvironmentConfigDataRetentionConfigArgs
        {
            AirflowMetadataRetentionConfigs = new[]
            {
                new Gcp.Composer.Inputs.EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfigArgs
                {
                    RetentionDays = 0,
                    RetentionMode = "string",
                },
            },
            TaskLogsRetentionConfigs = new[]
            {
                new Gcp.Composer.Inputs.EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfigArgs
                {
                    StorageMode = "string",
                },
            },
        },
        DatabaseConfig = new Gcp.Composer.Inputs.EnvironmentConfigDatabaseConfigArgs
        {
            MachineType = "string",
            Zone = "string",
        },
        EnablePrivateBuildsOnly = false,
        EnablePrivateEnvironment = false,
        EncryptionConfig = new Gcp.Composer.Inputs.EnvironmentConfigEncryptionConfigArgs
        {
            KmsKeyName = "string",
        },
        EnvironmentSize = "string",
        GkeCluster = "string",
        MaintenanceWindow = new Gcp.Composer.Inputs.EnvironmentConfigMaintenanceWindowArgs
        {
            EndTime = "string",
            Recurrence = "string",
            StartTime = "string",
        },
        MasterAuthorizedNetworksConfig = new Gcp.Composer.Inputs.EnvironmentConfigMasterAuthorizedNetworksConfigArgs
        {
            Enabled = false,
            CidrBlocks = new[]
            {
                new Gcp.Composer.Inputs.EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlockArgs
                {
                    CidrBlock = "string",
                    DisplayName = "string",
                },
            },
        },
        NodeConfig = new Gcp.Composer.Inputs.EnvironmentConfigNodeConfigArgs
        {
            ComposerInternalIpv4CidrBlock = "string",
            ComposerNetworkAttachment = "string",
            DiskSizeGb = 0,
            EnableIpMasqAgent = false,
            IpAllocationPolicy = new Gcp.Composer.Inputs.EnvironmentConfigNodeConfigIpAllocationPolicyArgs
            {
                ClusterIpv4CidrBlock = "string",
                ClusterSecondaryRangeName = "string",
                ServicesIpv4CidrBlock = "string",
                ServicesSecondaryRangeName = "string",
                UseIpAliases = false,
            },
            MachineType = "string",
            MaxPodsPerNode = 0,
            Network = "string",
            OauthScopes = new[]
            {
                "string",
            },
            ServiceAccount = "string",
            Subnetwork = "string",
            Tags = new[]
            {
                "string",
            },
            Zone = "string",
        },
        NodeCount = 0,
        PrivateEnvironmentConfig = new Gcp.Composer.Inputs.EnvironmentConfigPrivateEnvironmentConfigArgs
        {
            CloudComposerConnectionSubnetwork = "string",
            CloudComposerNetworkIpv4CidrBlock = "string",
            CloudSqlIpv4CidrBlock = "string",
            ConnectionType = "string",
            EnablePrivateEndpoint = false,
            EnablePrivatelyUsedPublicIps = false,
            MasterIpv4CidrBlock = "string",
            WebServerIpv4CidrBlock = "string",
        },
        RecoveryConfig = new Gcp.Composer.Inputs.EnvironmentConfigRecoveryConfigArgs
        {
            ScheduledSnapshotsConfig = new Gcp.Composer.Inputs.EnvironmentConfigRecoveryConfigScheduledSnapshotsConfigArgs
            {
                Enabled = false,
                SnapshotCreationSchedule = "string",
                SnapshotLocation = "string",
                TimeZone = "string",
            },
        },
        ResilienceMode = "string",
        SoftwareConfig = new Gcp.Composer.Inputs.EnvironmentConfigSoftwareConfigArgs
        {
            AirflowConfigOverrides = 
            {
                { "string", "string" },
            },
            CloudDataLineageIntegration = new Gcp.Composer.Inputs.EnvironmentConfigSoftwareConfigCloudDataLineageIntegrationArgs
            {
                Enabled = false,
            },
            EnvVariables = 
            {
                { "string", "string" },
            },
            ImageVersion = "string",
            PypiPackages = 
            {
                { "string", "string" },
            },
            PythonVersion = "string",
            SchedulerCount = 0,
            WebServerPluginsMode = "string",
        },
        WebServerConfig = new Gcp.Composer.Inputs.EnvironmentConfigWebServerConfigArgs
        {
            MachineType = "string",
        },
        WebServerNetworkAccessControl = new Gcp.Composer.Inputs.EnvironmentConfigWebServerNetworkAccessControlArgs
        {
            AllowedIpRanges = new[]
            {
                new Gcp.Composer.Inputs.EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArgs
                {
                    Value = "string",
                    Description = "string",
                },
            },
        },
        WorkloadsConfig = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigArgs
        {
            DagProcessor = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigDagProcessorArgs
            {
                Count = 0,
                Cpu = 0,
                MemoryGb = 0,
                StorageGb = 0,
            },
            Scheduler = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigSchedulerArgs
            {
                Count = 0,
                Cpu = 0,
                MemoryGb = 0,
                StorageGb = 0,
            },
            Triggerer = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigTriggererArgs
            {
                Count = 0,
                Cpu = 0,
                MemoryGb = 0,
            },
            WebServer = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigWebServerArgs
            {
                Cpu = 0,
                MemoryGb = 0,
                StorageGb = 0,
            },
            Worker = new Gcp.Composer.Inputs.EnvironmentConfigWorkloadsConfigWorkerArgs
            {
                Cpu = 0,
                MaxCount = 0,
                MemoryGb = 0,
                MinCount = 0,
                StorageGb = 0,
            },
        },
    },
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
    Region = "string",
    StorageConfig = new Gcp.Composer.Inputs.EnvironmentStorageConfigArgs
    {
        Bucket = "string",
    },
});
Copy
example, err := composer.NewEnvironment(ctx, "gcpEnvironmentResource", &composer.EnvironmentArgs{
	Config: &composer.EnvironmentConfigArgs{
		AirflowUri:   pulumi.String("string"),
		DagGcsPrefix: pulumi.String("string"),
		DataRetentionConfig: &composer.EnvironmentConfigDataRetentionConfigArgs{
			AirflowMetadataRetentionConfigs: composer.EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfigArray{
				&composer.EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfigArgs{
					RetentionDays: pulumi.Int(0),
					RetentionMode: pulumi.String("string"),
				},
			},
			TaskLogsRetentionConfigs: composer.EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfigArray{
				&composer.EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfigArgs{
					StorageMode: pulumi.String("string"),
				},
			},
		},
		DatabaseConfig: &composer.EnvironmentConfigDatabaseConfigArgs{
			MachineType: pulumi.String("string"),
			Zone:        pulumi.String("string"),
		},
		EnablePrivateBuildsOnly:  pulumi.Bool(false),
		EnablePrivateEnvironment: pulumi.Bool(false),
		EncryptionConfig: &composer.EnvironmentConfigEncryptionConfigArgs{
			KmsKeyName: pulumi.String("string"),
		},
		EnvironmentSize: pulumi.String("string"),
		GkeCluster:      pulumi.String("string"),
		MaintenanceWindow: &composer.EnvironmentConfigMaintenanceWindowArgs{
			EndTime:    pulumi.String("string"),
			Recurrence: pulumi.String("string"),
			StartTime:  pulumi.String("string"),
		},
		MasterAuthorizedNetworksConfig: &composer.EnvironmentConfigMasterAuthorizedNetworksConfigArgs{
			Enabled: pulumi.Bool(false),
			CidrBlocks: composer.EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlockArray{
				&composer.EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlockArgs{
					CidrBlock:   pulumi.String("string"),
					DisplayName: pulumi.String("string"),
				},
			},
		},
		NodeConfig: &composer.EnvironmentConfigNodeConfigArgs{
			ComposerInternalIpv4CidrBlock: pulumi.String("string"),
			ComposerNetworkAttachment:     pulumi.String("string"),
			DiskSizeGb:                    pulumi.Int(0),
			EnableIpMasqAgent:             pulumi.Bool(false),
			IpAllocationPolicy: &composer.EnvironmentConfigNodeConfigIpAllocationPolicyArgs{
				ClusterIpv4CidrBlock:       pulumi.String("string"),
				ClusterSecondaryRangeName:  pulumi.String("string"),
				ServicesIpv4CidrBlock:      pulumi.String("string"),
				ServicesSecondaryRangeName: pulumi.String("string"),
				UseIpAliases:               pulumi.Bool(false),
			},
			MachineType:    pulumi.String("string"),
			MaxPodsPerNode: pulumi.Int(0),
			Network:        pulumi.String("string"),
			OauthScopes: pulumi.StringArray{
				pulumi.String("string"),
			},
			ServiceAccount: pulumi.String("string"),
			Subnetwork:     pulumi.String("string"),
			Tags: pulumi.StringArray{
				pulumi.String("string"),
			},
			Zone: pulumi.String("string"),
		},
		NodeCount: pulumi.Int(0),
		PrivateEnvironmentConfig: &composer.EnvironmentConfigPrivateEnvironmentConfigArgs{
			CloudComposerConnectionSubnetwork: pulumi.String("string"),
			CloudComposerNetworkIpv4CidrBlock: pulumi.String("string"),
			CloudSqlIpv4CidrBlock:             pulumi.String("string"),
			ConnectionType:                    pulumi.String("string"),
			EnablePrivateEndpoint:             pulumi.Bool(false),
			EnablePrivatelyUsedPublicIps:      pulumi.Bool(false),
			MasterIpv4CidrBlock:               pulumi.String("string"),
			WebServerIpv4CidrBlock:            pulumi.String("string"),
		},
		RecoveryConfig: &composer.EnvironmentConfigRecoveryConfigArgs{
			ScheduledSnapshotsConfig: &composer.EnvironmentConfigRecoveryConfigScheduledSnapshotsConfigArgs{
				Enabled:                  pulumi.Bool(false),
				SnapshotCreationSchedule: pulumi.String("string"),
				SnapshotLocation:         pulumi.String("string"),
				TimeZone:                 pulumi.String("string"),
			},
		},
		ResilienceMode: pulumi.String("string"),
		SoftwareConfig: &composer.EnvironmentConfigSoftwareConfigArgs{
			AirflowConfigOverrides: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			CloudDataLineageIntegration: &composer.EnvironmentConfigSoftwareConfigCloudDataLineageIntegrationArgs{
				Enabled: pulumi.Bool(false),
			},
			EnvVariables: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			ImageVersion: pulumi.String("string"),
			PypiPackages: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			PythonVersion:        pulumi.String("string"),
			SchedulerCount:       pulumi.Int(0),
			WebServerPluginsMode: pulumi.String("string"),
		},
		WebServerConfig: &composer.EnvironmentConfigWebServerConfigArgs{
			MachineType: pulumi.String("string"),
		},
		WebServerNetworkAccessControl: &composer.EnvironmentConfigWebServerNetworkAccessControlArgs{
			AllowedIpRanges: composer.EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArray{
				&composer.EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArgs{
					Value:       pulumi.String("string"),
					Description: pulumi.String("string"),
				},
			},
		},
		WorkloadsConfig: &composer.EnvironmentConfigWorkloadsConfigArgs{
			DagProcessor: &composer.EnvironmentConfigWorkloadsConfigDagProcessorArgs{
				Count:     pulumi.Int(0),
				Cpu:       pulumi.Float64(0),
				MemoryGb:  pulumi.Float64(0),
				StorageGb: pulumi.Float64(0),
			},
			Scheduler: &composer.EnvironmentConfigWorkloadsConfigSchedulerArgs{
				Count:     pulumi.Int(0),
				Cpu:       pulumi.Float64(0),
				MemoryGb:  pulumi.Float64(0),
				StorageGb: pulumi.Float64(0),
			},
			Triggerer: &composer.EnvironmentConfigWorkloadsConfigTriggererArgs{
				Count:    pulumi.Int(0),
				Cpu:      pulumi.Float64(0),
				MemoryGb: pulumi.Float64(0),
			},
			WebServer: &composer.EnvironmentConfigWorkloadsConfigWebServerArgs{
				Cpu:       pulumi.Float64(0),
				MemoryGb:  pulumi.Float64(0),
				StorageGb: pulumi.Float64(0),
			},
			Worker: &composer.EnvironmentConfigWorkloadsConfigWorkerArgs{
				Cpu:       pulumi.Float64(0),
				MaxCount:  pulumi.Int(0),
				MemoryGb:  pulumi.Float64(0),
				MinCount:  pulumi.Int(0),
				StorageGb: pulumi.Float64(0),
			},
		},
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
	Region:  pulumi.String("string"),
	StorageConfig: &composer.EnvironmentStorageConfigArgs{
		Bucket: pulumi.String("string"),
	},
})
Copy
var gcpEnvironmentResource = new Environment("gcpEnvironmentResource", EnvironmentArgs.builder()
    .config(EnvironmentConfigArgs.builder()
        .airflowUri("string")
        .dagGcsPrefix("string")
        .dataRetentionConfig(EnvironmentConfigDataRetentionConfigArgs.builder()
            .airflowMetadataRetentionConfigs(EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfigArgs.builder()
                .retentionDays(0)
                .retentionMode("string")
                .build())
            .taskLogsRetentionConfigs(EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfigArgs.builder()
                .storageMode("string")
                .build())
            .build())
        .databaseConfig(EnvironmentConfigDatabaseConfigArgs.builder()
            .machineType("string")
            .zone("string")
            .build())
        .enablePrivateBuildsOnly(false)
        .enablePrivateEnvironment(false)
        .encryptionConfig(EnvironmentConfigEncryptionConfigArgs.builder()
            .kmsKeyName("string")
            .build())
        .environmentSize("string")
        .gkeCluster("string")
        .maintenanceWindow(EnvironmentConfigMaintenanceWindowArgs.builder()
            .endTime("string")
            .recurrence("string")
            .startTime("string")
            .build())
        .masterAuthorizedNetworksConfig(EnvironmentConfigMasterAuthorizedNetworksConfigArgs.builder()
            .enabled(false)
            .cidrBlocks(EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlockArgs.builder()
                .cidrBlock("string")
                .displayName("string")
                .build())
            .build())
        .nodeConfig(EnvironmentConfigNodeConfigArgs.builder()
            .composerInternalIpv4CidrBlock("string")
            .composerNetworkAttachment("string")
            .diskSizeGb(0)
            .enableIpMasqAgent(false)
            .ipAllocationPolicy(EnvironmentConfigNodeConfigIpAllocationPolicyArgs.builder()
                .clusterIpv4CidrBlock("string")
                .clusterSecondaryRangeName("string")
                .servicesIpv4CidrBlock("string")
                .servicesSecondaryRangeName("string")
                .useIpAliases(false)
                .build())
            .machineType("string")
            .maxPodsPerNode(0)
            .network("string")
            .oauthScopes("string")
            .serviceAccount("string")
            .subnetwork("string")
            .tags("string")
            .zone("string")
            .build())
        .nodeCount(0)
        .privateEnvironmentConfig(EnvironmentConfigPrivateEnvironmentConfigArgs.builder()
            .cloudComposerConnectionSubnetwork("string")
            .cloudComposerNetworkIpv4CidrBlock("string")
            .cloudSqlIpv4CidrBlock("string")
            .connectionType("string")
            .enablePrivateEndpoint(false)
            .enablePrivatelyUsedPublicIps(false)
            .masterIpv4CidrBlock("string")
            .webServerIpv4CidrBlock("string")
            .build())
        .recoveryConfig(EnvironmentConfigRecoveryConfigArgs.builder()
            .scheduledSnapshotsConfig(EnvironmentConfigRecoveryConfigScheduledSnapshotsConfigArgs.builder()
                .enabled(false)
                .snapshotCreationSchedule("string")
                .snapshotLocation("string")
                .timeZone("string")
                .build())
            .build())
        .resilienceMode("string")
        .softwareConfig(EnvironmentConfigSoftwareConfigArgs.builder()
            .airflowConfigOverrides(Map.of("string", "string"))
            .cloudDataLineageIntegration(EnvironmentConfigSoftwareConfigCloudDataLineageIntegrationArgs.builder()
                .enabled(false)
                .build())
            .envVariables(Map.of("string", "string"))
            .imageVersion("string")
            .pypiPackages(Map.of("string", "string"))
            .pythonVersion("string")
            .schedulerCount(0)
            .webServerPluginsMode("string")
            .build())
        .webServerConfig(EnvironmentConfigWebServerConfigArgs.builder()
            .machineType("string")
            .build())
        .webServerNetworkAccessControl(EnvironmentConfigWebServerNetworkAccessControlArgs.builder()
            .allowedIpRanges(EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArgs.builder()
                .value("string")
                .description("string")
                .build())
            .build())
        .workloadsConfig(EnvironmentConfigWorkloadsConfigArgs.builder()
            .dagProcessor(EnvironmentConfigWorkloadsConfigDagProcessorArgs.builder()
                .count(0)
                .cpu(0)
                .memoryGb(0)
                .storageGb(0)
                .build())
            .scheduler(EnvironmentConfigWorkloadsConfigSchedulerArgs.builder()
                .count(0)
                .cpu(0)
                .memoryGb(0)
                .storageGb(0)
                .build())
            .triggerer(EnvironmentConfigWorkloadsConfigTriggererArgs.builder()
                .count(0)
                .cpu(0)
                .memoryGb(0)
                .build())
            .webServer(EnvironmentConfigWorkloadsConfigWebServerArgs.builder()
                .cpu(0)
                .memoryGb(0)
                .storageGb(0)
                .build())
            .worker(EnvironmentConfigWorkloadsConfigWorkerArgs.builder()
                .cpu(0)
                .maxCount(0)
                .memoryGb(0)
                .minCount(0)
                .storageGb(0)
                .build())
            .build())
        .build())
    .labels(Map.of("string", "string"))
    .name("string")
    .project("string")
    .region("string")
    .storageConfig(EnvironmentStorageConfigArgs.builder()
        .bucket("string")
        .build())
    .build());
Copy
gcp_environment_resource = gcp.composer.Environment("gcpEnvironmentResource",
    config={
        "airflow_uri": "string",
        "dag_gcs_prefix": "string",
        "data_retention_config": {
            "airflow_metadata_retention_configs": [{
                "retention_days": 0,
                "retention_mode": "string",
            }],
            "task_logs_retention_configs": [{
                "storage_mode": "string",
            }],
        },
        "database_config": {
            "machine_type": "string",
            "zone": "string",
        },
        "enable_private_builds_only": False,
        "enable_private_environment": False,
        "encryption_config": {
            "kms_key_name": "string",
        },
        "environment_size": "string",
        "gke_cluster": "string",
        "maintenance_window": {
            "end_time": "string",
            "recurrence": "string",
            "start_time": "string",
        },
        "master_authorized_networks_config": {
            "enabled": False,
            "cidr_blocks": [{
                "cidr_block": "string",
                "display_name": "string",
            }],
        },
        "node_config": {
            "composer_internal_ipv4_cidr_block": "string",
            "composer_network_attachment": "string",
            "disk_size_gb": 0,
            "enable_ip_masq_agent": False,
            "ip_allocation_policy": {
                "cluster_ipv4_cidr_block": "string",
                "cluster_secondary_range_name": "string",
                "services_ipv4_cidr_block": "string",
                "services_secondary_range_name": "string",
                "use_ip_aliases": False,
            },
            "machine_type": "string",
            "max_pods_per_node": 0,
            "network": "string",
            "oauth_scopes": ["string"],
            "service_account": "string",
            "subnetwork": "string",
            "tags": ["string"],
            "zone": "string",
        },
        "node_count": 0,
        "private_environment_config": {
            "cloud_composer_connection_subnetwork": "string",
            "cloud_composer_network_ipv4_cidr_block": "string",
            "cloud_sql_ipv4_cidr_block": "string",
            "connection_type": "string",
            "enable_private_endpoint": False,
            "enable_privately_used_public_ips": False,
            "master_ipv4_cidr_block": "string",
            "web_server_ipv4_cidr_block": "string",
        },
        "recovery_config": {
            "scheduled_snapshots_config": {
                "enabled": False,
                "snapshot_creation_schedule": "string",
                "snapshot_location": "string",
                "time_zone": "string",
            },
        },
        "resilience_mode": "string",
        "software_config": {
            "airflow_config_overrides": {
                "string": "string",
            },
            "cloud_data_lineage_integration": {
                "enabled": False,
            },
            "env_variables": {
                "string": "string",
            },
            "image_version": "string",
            "pypi_packages": {
                "string": "string",
            },
            "python_version": "string",
            "scheduler_count": 0,
            "web_server_plugins_mode": "string",
        },
        "web_server_config": {
            "machine_type": "string",
        },
        "web_server_network_access_control": {
            "allowed_ip_ranges": [{
                "value": "string",
                "description": "string",
            }],
        },
        "workloads_config": {
            "dag_processor": {
                "count": 0,
                "cpu": 0,
                "memory_gb": 0,
                "storage_gb": 0,
            },
            "scheduler": {
                "count": 0,
                "cpu": 0,
                "memory_gb": 0,
                "storage_gb": 0,
            },
            "triggerer": {
                "count": 0,
                "cpu": 0,
                "memory_gb": 0,
            },
            "web_server": {
                "cpu": 0,
                "memory_gb": 0,
                "storage_gb": 0,
            },
            "worker": {
                "cpu": 0,
                "max_count": 0,
                "memory_gb": 0,
                "min_count": 0,
                "storage_gb": 0,
            },
        },
    },
    labels={
        "string": "string",
    },
    name="string",
    project="string",
    region="string",
    storage_config={
        "bucket": "string",
    })
Copy
const gcpEnvironmentResource = new gcp.composer.Environment("gcpEnvironmentResource", {
    config: {
        airflowUri: "string",
        dagGcsPrefix: "string",
        dataRetentionConfig: {
            airflowMetadataRetentionConfigs: [{
                retentionDays: 0,
                retentionMode: "string",
            }],
            taskLogsRetentionConfigs: [{
                storageMode: "string",
            }],
        },
        databaseConfig: {
            machineType: "string",
            zone: "string",
        },
        enablePrivateBuildsOnly: false,
        enablePrivateEnvironment: false,
        encryptionConfig: {
            kmsKeyName: "string",
        },
        environmentSize: "string",
        gkeCluster: "string",
        maintenanceWindow: {
            endTime: "string",
            recurrence: "string",
            startTime: "string",
        },
        masterAuthorizedNetworksConfig: {
            enabled: false,
            cidrBlocks: [{
                cidrBlock: "string",
                displayName: "string",
            }],
        },
        nodeConfig: {
            composerInternalIpv4CidrBlock: "string",
            composerNetworkAttachment: "string",
            diskSizeGb: 0,
            enableIpMasqAgent: false,
            ipAllocationPolicy: {
                clusterIpv4CidrBlock: "string",
                clusterSecondaryRangeName: "string",
                servicesIpv4CidrBlock: "string",
                servicesSecondaryRangeName: "string",
                useIpAliases: false,
            },
            machineType: "string",
            maxPodsPerNode: 0,
            network: "string",
            oauthScopes: ["string"],
            serviceAccount: "string",
            subnetwork: "string",
            tags: ["string"],
            zone: "string",
        },
        nodeCount: 0,
        privateEnvironmentConfig: {
            cloudComposerConnectionSubnetwork: "string",
            cloudComposerNetworkIpv4CidrBlock: "string",
            cloudSqlIpv4CidrBlock: "string",
            connectionType: "string",
            enablePrivateEndpoint: false,
            enablePrivatelyUsedPublicIps: false,
            masterIpv4CidrBlock: "string",
            webServerIpv4CidrBlock: "string",
        },
        recoveryConfig: {
            scheduledSnapshotsConfig: {
                enabled: false,
                snapshotCreationSchedule: "string",
                snapshotLocation: "string",
                timeZone: "string",
            },
        },
        resilienceMode: "string",
        softwareConfig: {
            airflowConfigOverrides: {
                string: "string",
            },
            cloudDataLineageIntegration: {
                enabled: false,
            },
            envVariables: {
                string: "string",
            },
            imageVersion: "string",
            pypiPackages: {
                string: "string",
            },
            pythonVersion: "string",
            schedulerCount: 0,
            webServerPluginsMode: "string",
        },
        webServerConfig: {
            machineType: "string",
        },
        webServerNetworkAccessControl: {
            allowedIpRanges: [{
                value: "string",
                description: "string",
            }],
        },
        workloadsConfig: {
            dagProcessor: {
                count: 0,
                cpu: 0,
                memoryGb: 0,
                storageGb: 0,
            },
            scheduler: {
                count: 0,
                cpu: 0,
                memoryGb: 0,
                storageGb: 0,
            },
            triggerer: {
                count: 0,
                cpu: 0,
                memoryGb: 0,
            },
            webServer: {
                cpu: 0,
                memoryGb: 0,
                storageGb: 0,
            },
            worker: {
                cpu: 0,
                maxCount: 0,
                memoryGb: 0,
                minCount: 0,
                storageGb: 0,
            },
        },
    },
    labels: {
        string: "string",
    },
    name: "string",
    project: "string",
    region: "string",
    storageConfig: {
        bucket: "string",
    },
});
Copy
type: gcp:composer:Environment
properties:
    config:
        airflowUri: string
        dagGcsPrefix: string
        dataRetentionConfig:
            airflowMetadataRetentionConfigs:
                - retentionDays: 0
                  retentionMode: string
            taskLogsRetentionConfigs:
                - storageMode: string
        databaseConfig:
            machineType: string
            zone: string
        enablePrivateBuildsOnly: false
        enablePrivateEnvironment: false
        encryptionConfig:
            kmsKeyName: string
        environmentSize: string
        gkeCluster: string
        maintenanceWindow:
            endTime: string
            recurrence: string
            startTime: string
        masterAuthorizedNetworksConfig:
            cidrBlocks:
                - cidrBlock: string
                  displayName: string
            enabled: false
        nodeConfig:
            composerInternalIpv4CidrBlock: string
            composerNetworkAttachment: string
            diskSizeGb: 0
            enableIpMasqAgent: false
            ipAllocationPolicy:
                clusterIpv4CidrBlock: string
                clusterSecondaryRangeName: string
                servicesIpv4CidrBlock: string
                servicesSecondaryRangeName: string
                useIpAliases: false
            machineType: string
            maxPodsPerNode: 0
            network: string
            oauthScopes:
                - string
            serviceAccount: string
            subnetwork: string
            tags:
                - string
            zone: string
        nodeCount: 0
        privateEnvironmentConfig:
            cloudComposerConnectionSubnetwork: string
            cloudComposerNetworkIpv4CidrBlock: string
            cloudSqlIpv4CidrBlock: string
            connectionType: string
            enablePrivateEndpoint: false
            enablePrivatelyUsedPublicIps: false
            masterIpv4CidrBlock: string
            webServerIpv4CidrBlock: string
        recoveryConfig:
            scheduledSnapshotsConfig:
                enabled: false
                snapshotCreationSchedule: string
                snapshotLocation: string
                timeZone: string
        resilienceMode: string
        softwareConfig:
            airflowConfigOverrides:
                string: string
            cloudDataLineageIntegration:
                enabled: false
            envVariables:
                string: string
            imageVersion: string
            pypiPackages:
                string: string
            pythonVersion: string
            schedulerCount: 0
            webServerPluginsMode: string
        webServerConfig:
            machineType: string
        webServerNetworkAccessControl:
            allowedIpRanges:
                - description: string
                  value: string
        workloadsConfig:
            dagProcessor:
                count: 0
                cpu: 0
                memoryGb: 0
                storageGb: 0
            scheduler:
                count: 0
                cpu: 0
                memoryGb: 0
                storageGb: 0
            triggerer:
                count: 0
                cpu: 0
                memoryGb: 0
            webServer:
                cpu: 0
                memoryGb: 0
                storageGb: 0
            worker:
                cpu: 0
                maxCount: 0
                memoryGb: 0
                minCount: 0
                storageGb: 0
    labels:
        string: string
    name: string
    project: string
    region: string
    storageConfig:
        bucket: string
Copy

Environment Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Environment resource accepts the following input properties:

Config EnvironmentConfig
Configuration parameters for this environment.
Labels Dictionary<string, string>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Name Changes to this property will trigger replacement. string
Name of the environment.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
StorageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
Config EnvironmentConfigArgs
Configuration parameters for this environment.
Labels map[string]string
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Name Changes to this property will trigger replacement. string
Name of the environment.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
StorageConfig EnvironmentStorageConfigArgs
Configuration options for storage used by Composer environment.
config EnvironmentConfig
Configuration parameters for this environment.
labels Map<String,String>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. String
Name of the environment.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region Changes to this property will trigger replacement. String
The location or Compute Engine region for the environment.
storageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
config EnvironmentConfig
Configuration parameters for this environment.
labels {[key: string]: string}
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. string
Name of the environment.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
storageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
config EnvironmentConfigArgs
Configuration parameters for this environment.
labels Mapping[str, str]
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. str
Name of the environment.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region Changes to this property will trigger replacement. str
The location or Compute Engine region for the environment.
storage_config EnvironmentStorageConfigArgs
Configuration options for storage used by Composer environment.
config Property Map
Configuration parameters for this environment.
labels Map<String>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. String
Name of the environment.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region Changes to this property will trigger replacement. String
The location or Compute Engine region for the environment.
storageConfig Property Map
Configuration options for storage used by Composer environment.

Outputs

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

EffectiveLabels Dictionary<string, string>
Id string
The provider-assigned unique ID for this managed resource.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
EffectiveLabels map[string]string
Id string
The provider-assigned unique ID for this managed resource.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
effectiveLabels Map<String,String>
id String
The provider-assigned unique ID for this managed resource.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
effectiveLabels {[key: string]: string}
id string
The provider-assigned unique ID for this managed resource.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
effective_labels Mapping[str, str]
id str
The provider-assigned unique ID for this managed resource.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
effectiveLabels Map<String>
id String
The provider-assigned unique ID for this managed resource.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.

Look up Existing Environment Resource

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

public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[EnvironmentConfigArgs] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        region: Optional[str] = None,
        storage_config: Optional[EnvironmentStorageConfigArgs] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
resources:  _:    type: gcp:composer:Environment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config EnvironmentConfig
Configuration parameters for this environment.
EffectiveLabels Dictionary<string, string>
Labels Dictionary<string, string>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Name Changes to this property will trigger replacement. string
Name of the environment.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
Region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
StorageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
Config EnvironmentConfigArgs
Configuration parameters for this environment.
EffectiveLabels map[string]string
Labels map[string]string
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
Name Changes to this property will trigger replacement. string
Name of the environment.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
Region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
StorageConfig EnvironmentStorageConfigArgs
Configuration options for storage used by Composer environment.
config EnvironmentConfig
Configuration parameters for this environment.
effectiveLabels Map<String,String>
labels Map<String,String>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. String
Name of the environment.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. String
The location or Compute Engine region for the environment.
storageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
config EnvironmentConfig
Configuration parameters for this environment.
effectiveLabels {[key: string]: string}
labels {[key: string]: string}
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. string
Name of the environment.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. string
The location or Compute Engine region for the environment.
storageConfig EnvironmentStorageConfig
Configuration options for storage used by Composer environment.
config EnvironmentConfigArgs
Configuration parameters for this environment.
effective_labels Mapping[str, str]
labels Mapping[str, str]
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. str
Name of the environment.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. str
The location or Compute Engine region for the environment.
storage_config EnvironmentStorageConfigArgs
Configuration options for storage used by Composer environment.
config Property Map
Configuration parameters for this environment.
effectiveLabels Map<String>
labels Map<String>
User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: a-z?. Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?. No more than 64 labels can be associated with a given environment. Both keys and values must be <= 128 bytes in size. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field 'effective_labels' for all of the labels present on the resource.
name Changes to this property will trigger replacement. String
Name of the environment.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. String
The location or Compute Engine region for the environment.
storageConfig Property Map
Configuration options for storage used by Composer environment.

Supporting Types

EnvironmentConfig
, EnvironmentConfigArgs

AirflowUri string
The URI of the Apache Airflow Web UI hosted within this environment.
DagGcsPrefix string
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
DataRetentionConfig EnvironmentConfigDataRetentionConfig
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
DatabaseConfig EnvironmentConfigDatabaseConfig
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.
EncryptionConfig EnvironmentConfigEncryptionConfig
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 this environment.
MaintenanceWindow EnvironmentConfigMaintenanceWindow
The configuration for Cloud Composer maintenance window.
MasterAuthorizedNetworksConfig EnvironmentConfigMasterAuthorizedNetworksConfig
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.
NodeConfig EnvironmentConfigNodeConfig
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-..*.
PrivateEnvironmentConfig Changes to this property will trigger replacement. EnvironmentConfigPrivateEnvironmentConfig
The configuration used for the Private IP Cloud Composer environment.
RecoveryConfig EnvironmentConfigRecoveryConfig
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.
SoftwareConfig EnvironmentConfigSoftwareConfig
The configuration settings for software inside the environment.
WebServerConfig EnvironmentConfigWebServerConfig
The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
WebServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
WorkloadsConfig EnvironmentConfigWorkloadsConfig
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 this environment.
DagGcsPrefix string
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
DataRetentionConfig EnvironmentConfigDataRetentionConfig
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
DatabaseConfig EnvironmentConfigDatabaseConfig
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.
EncryptionConfig EnvironmentConfigEncryptionConfig
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 this environment.
MaintenanceWindow EnvironmentConfigMaintenanceWindow
The configuration for Cloud Composer maintenance window.
MasterAuthorizedNetworksConfig EnvironmentConfigMasterAuthorizedNetworksConfig
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.
NodeConfig EnvironmentConfigNodeConfig
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-..*.
PrivateEnvironmentConfig Changes to this property will trigger replacement. EnvironmentConfigPrivateEnvironmentConfig
The configuration used for the Private IP Cloud Composer environment.
RecoveryConfig EnvironmentConfigRecoveryConfig
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.
SoftwareConfig EnvironmentConfigSoftwareConfig
The configuration settings for software inside the environment.
WebServerConfig EnvironmentConfigWebServerConfig
The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
WebServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
WorkloadsConfig EnvironmentConfigWorkloadsConfig
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 this environment.
dagGcsPrefix String
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
dataRetentionConfig EnvironmentConfigDataRetentionConfig
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
databaseConfig EnvironmentConfigDatabaseConfig
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.
encryptionConfig EnvironmentConfigEncryptionConfig
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 this environment.
maintenanceWindow EnvironmentConfigMaintenanceWindow
The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfig EnvironmentConfigMasterAuthorizedNetworksConfig
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.
nodeConfig EnvironmentConfigNodeConfig
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-..*.
privateEnvironmentConfig Changes to this property will trigger replacement. EnvironmentConfigPrivateEnvironmentConfig
The configuration used for the Private IP Cloud Composer environment.
recoveryConfig EnvironmentConfigRecoveryConfig
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.
softwareConfig EnvironmentConfigSoftwareConfig
The configuration settings for software inside the environment.
webServerConfig EnvironmentConfigWebServerConfig
The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
webServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
workloadsConfig EnvironmentConfigWorkloadsConfig
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 this environment.
dagGcsPrefix string
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
dataRetentionConfig EnvironmentConfigDataRetentionConfig
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
databaseConfig EnvironmentConfigDatabaseConfig
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.
encryptionConfig EnvironmentConfigEncryptionConfig
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 this environment.
maintenanceWindow EnvironmentConfigMaintenanceWindow
The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfig EnvironmentConfigMasterAuthorizedNetworksConfig
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.
nodeConfig EnvironmentConfigNodeConfig
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-..*.
privateEnvironmentConfig Changes to this property will trigger replacement. EnvironmentConfigPrivateEnvironmentConfig
The configuration used for the Private IP Cloud Composer environment.
recoveryConfig EnvironmentConfigRecoveryConfig
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.
softwareConfig EnvironmentConfigSoftwareConfig
The configuration settings for software inside the environment.
webServerConfig EnvironmentConfigWebServerConfig
The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
webServerNetworkAccessControl EnvironmentConfigWebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
workloadsConfig EnvironmentConfigWorkloadsConfig
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 this environment.
dag_gcs_prefix str
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
data_retention_config EnvironmentConfigDataRetentionConfig
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_config EnvironmentConfigDatabaseConfig
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_config EnvironmentConfigEncryptionConfig
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 this environment.
maintenance_window EnvironmentConfigMaintenanceWindow
The configuration for Cloud Composer maintenance window.
master_authorized_networks_config EnvironmentConfigMasterAuthorizedNetworksConfig
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_config EnvironmentConfigNodeConfig
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_config Changes to this property will trigger replacement. EnvironmentConfigPrivateEnvironmentConfig
The configuration used for the Private IP Cloud Composer environment.
recovery_config EnvironmentConfigRecoveryConfig
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_config EnvironmentConfigSoftwareConfig
The configuration settings for software inside the environment.
web_server_config EnvironmentConfigWebServerConfig
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_control EnvironmentConfigWebServerNetworkAccessControl
Network-level access control policy for the Airflow web server.
workloads_config EnvironmentConfigWorkloadsConfig
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 this environment.
dagGcsPrefix String
The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using '/'-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with this prefix.
dataRetentionConfig 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
databaseConfig 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.
encryptionConfig 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 this environment.
maintenanceWindow Property Map
The configuration for Cloud Composer maintenance window.
masterAuthorizedNetworksConfig 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.
nodeConfig 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-..*.
privateEnvironmentConfig Changes to this property will trigger replacement. Property Map
The configuration used for the Private IP Cloud Composer environment.
recoveryConfig 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.
softwareConfig Property Map
The configuration settings for software inside the environment.
webServerConfig 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-..*.
webServerNetworkAccessControl Property Map
Network-level access control policy for the Airflow web server.
workloadsConfig 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.

EnvironmentConfigDataRetentionConfig
, EnvironmentConfigDataRetentionConfigArgs

airflowMetadataRetentionConfigs List<Property Map>
Optional. The policy for airflow metadata database retention.
taskLogsRetentionConfigs List<Property Map>
Optional. The configuration setting for Task Logs.

EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfig
, EnvironmentConfigDataRetentionConfigAirflowMetadataRetentionConfigArgs

RetentionDays int
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
RetentionMode string
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.
RetentionDays int
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
RetentionMode string
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionDays Integer
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionMode String
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionDays number
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionMode string
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.
retention_days int
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
retention_mode str
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionDays Number
How many days data should be retained for. This field is supported for Cloud Composer environments in composer 3 and newer.
retentionMode String
Whether database retention is enabled or not. This field is supported for Cloud Composer environments in composer 3 and newer.

EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig
, EnvironmentConfigDataRetentionConfigTaskLogsRetentionConfigArgs

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 but not in composer-3*
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 but not in composer-3*
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 but not in composer-3*
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 but not in composer-3*
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 but not in composer-3*
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 but not in composer-3*

EnvironmentConfigDatabaseConfig
, EnvironmentConfigDatabaseConfigArgs

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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Optional. Cloud SQL database preferred zone.

EnvironmentConfigEncryptionConfig
, EnvironmentConfigEncryptionConfigArgs

KmsKeyName
This property is required.
Changes to this property will trigger replacement.
string
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
KmsKeyName
This property is required.
Changes to this property will trigger replacement.
string
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
kmsKeyName
This property is required.
Changes to this property will trigger replacement.
String
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
kmsKeyName
This property is required.
Changes to this property will trigger replacement.
string
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
kms_key_name
This property is required.
Changes to this property will trigger replacement.
str
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
kmsKeyName
This property is required.
Changes to this property will trigger replacement.
String
Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.

EnvironmentConfigMaintenanceWindow
, EnvironmentConfigMaintenanceWindowArgs

EndTime This property is required. 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 This property is required. 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 This property is required. string
Start time of the first recurrence of the maintenance window.
EndTime This property is required. 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 This property is required. 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 This property is required. string
Start time of the first recurrence of the maintenance window.
endTime This property is required. 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 This property is required. 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 This property is required. String
Start time of the first recurrence of the maintenance window.
endTime This property is required. 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 This property is required. 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 This property is required. string
Start time of the first recurrence of the maintenance window.
end_time This property is required. 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 This property is required. 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 This property is required. str
Start time of the first recurrence of the maintenance window.
endTime This property is required. 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 This property is required. 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 This property is required. String
Start time of the first recurrence of the maintenance window.

EnvironmentConfigMasterAuthorizedNetworksConfig
, EnvironmentConfigMasterAuthorizedNetworksConfigArgs

Enabled This property is required. bool
Whether or not master authorized networks is enabled.
CidrBlocks List<EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock>
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
Enabled This property is required. bool
Whether or not master authorized networks is enabled.
CidrBlocks []EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled This property is required. Boolean
Whether or not master authorized networks is enabled.
cidrBlocks List<EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock>
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled This property is required. boolean
Whether or not master authorized networks is enabled.
cidrBlocks EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock[]
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled This property is required. bool
Whether or not master authorized networks is enabled.
cidr_blocks Sequence[EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock]
cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
enabled This property is required. Boolean
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.

EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock
, EnvironmentConfigMasterAuthorizedNetworksConfigCidrBlockArgs

CidrBlock This property is required. string
cidr_block must be specified in CIDR notation.
DisplayName string
display_name is a field for users to identify CIDR blocks.
CidrBlock This property is required. string
cidr_block must be specified in CIDR notation.
DisplayName string
display_name is a field for users to identify CIDR blocks.
cidrBlock This property is required. String
cidr_block must be specified in CIDR notation.
displayName String
display_name is a field for users to identify CIDR blocks.
cidrBlock This property is required. string
cidr_block must be specified in CIDR notation.
displayName string
display_name is a field for users to identify CIDR blocks.
cidr_block This property is required. str
cidr_block must be specified in CIDR notation.
display_name str
display_name is a field for users to identify CIDR blocks.
cidrBlock This property is required. String
cidr_block must be specified in CIDR notation.
displayName String
display_name is a field for users to identify CIDR blocks.

EnvironmentConfigNodeConfig
, EnvironmentConfigNodeConfigArgs

ComposerInternalIpv4CidrBlock Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
IpAllocationPolicy Changes to this property will trigger replacement. EnvironmentConfigNodeConfigIpAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
MachineType Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
IpAllocationPolicy Changes to this property will trigger replacement. EnvironmentConfigNodeConfigIpAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
MachineType Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. []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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. []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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
ipAllocationPolicy Changes to this property will trigger replacement. EnvironmentConfigNodeConfigIpAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
machineType Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
ipAllocationPolicy Changes to this property will trigger replacement. EnvironmentConfigNodeConfigIpAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
machineType Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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_policy Changes to this property will trigger replacement. EnvironmentConfigNodeConfigIpAllocationPolicy
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
machine_type Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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
ipAllocationPolicy Changes to this property will trigger replacement. Property Map
Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
machineType Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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-..*.

EnvironmentConfigNodeConfigIpAllocationPolicy
, EnvironmentConfigNodeConfigIpAllocationPolicyArgs

ClusterIpv4CidrBlock Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

EnvironmentConfigPrivateEnvironmentConfig
, EnvironmentConfigPrivateEnvironmentConfigArgs

CloudComposerConnectionSubnetwork Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
EnablePrivateEndpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
EnablePrivateEndpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enable_private_endpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
enablePrivateEndpoint Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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-..*.

EnvironmentConfigRecoveryConfig
, EnvironmentConfigRecoveryConfigArgs

scheduledSnapshotsConfig Property Map
The configuration settings for scheduled snapshots.

EnvironmentConfigRecoveryConfigScheduledSnapshotsConfig
, EnvironmentConfigRecoveryConfigScheduledSnapshotsConfigArgs

Enabled This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

EnvironmentConfigSoftwareConfig
, EnvironmentConfigSoftwareConfigArgs

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.
CloudDataLineageIntegration EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
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 Changes to this property will trigger replacement. 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.
CloudDataLineageIntegration EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
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 Changes to this property will trigger replacement. 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.
cloudDataLineageIntegration EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
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 Changes to this property will trigger replacement. 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.
cloudDataLineageIntegration EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
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 Changes to this property will trigger replacement. 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_integration EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
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 Changes to this property will trigger replacement. 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.
cloudDataLineageIntegration 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 Changes to this property will trigger replacement. 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.

EnvironmentConfigSoftwareConfigCloudDataLineageIntegration
, EnvironmentConfigSoftwareConfigCloudDataLineageIntegrationArgs

Enabled This property is required. bool
Whether or not Cloud Data Lineage integration is enabled.
Enabled This property is required. bool
Whether or not Cloud Data Lineage integration is enabled.
enabled This property is required. Boolean
Whether or not Cloud Data Lineage integration is enabled.
enabled This property is required. boolean
Whether or not Cloud Data Lineage integration is enabled.
enabled This property is required. bool
Whether or not Cloud Data Lineage integration is enabled.
enabled This property is required. Boolean
Whether or not Cloud Data Lineage integration is enabled.

EnvironmentConfigWebServerConfig
, EnvironmentConfigWebServerConfigArgs

MachineType This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

EnvironmentConfigWebServerNetworkAccessControl
, EnvironmentConfigWebServerNetworkAccessControlArgs

AllowedIpRanges []EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange
A collection of allowed IP ranges with descriptions.
allowedIpRanges EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange[]
A collection of allowed IP ranges with descriptions.
allowedIpRanges List<Property Map>
A collection of allowed IP ranges with descriptions.

EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange
, EnvironmentConfigWebServerNetworkAccessControlAllowedIpRangeArgs

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

EnvironmentConfigWorkloadsConfig
, EnvironmentConfigWorkloadsConfigArgs

DagProcessor EnvironmentConfigWorkloadsConfigDagProcessor
Configuration for resources used by DAG processor.
Scheduler EnvironmentConfigWorkloadsConfigScheduler
Configuration for resources used by Airflow schedulers.
Triggerer EnvironmentConfigWorkloadsConfigTriggerer
Configuration for resources used by Airflow triggerers.
WebServer EnvironmentConfigWorkloadsConfigWebServer
Configuration for resources used by Airflow web server.
Worker EnvironmentConfigWorkloadsConfigWorker
Configuration for resources used by Airflow workers.
DagProcessor EnvironmentConfigWorkloadsConfigDagProcessor
Configuration for resources used by DAG processor.
Scheduler EnvironmentConfigWorkloadsConfigScheduler
Configuration for resources used by Airflow schedulers.
Triggerer EnvironmentConfigWorkloadsConfigTriggerer
Configuration for resources used by Airflow triggerers.
WebServer EnvironmentConfigWorkloadsConfigWebServer
Configuration for resources used by Airflow web server.
Worker EnvironmentConfigWorkloadsConfigWorker
Configuration for resources used by Airflow workers.
dagProcessor EnvironmentConfigWorkloadsConfigDagProcessor
Configuration for resources used by DAG processor.
scheduler EnvironmentConfigWorkloadsConfigScheduler
Configuration for resources used by Airflow schedulers.
triggerer EnvironmentConfigWorkloadsConfigTriggerer
Configuration for resources used by Airflow triggerers.
webServer EnvironmentConfigWorkloadsConfigWebServer
Configuration for resources used by Airflow web server.
worker EnvironmentConfigWorkloadsConfigWorker
Configuration for resources used by Airflow workers.
dagProcessor EnvironmentConfigWorkloadsConfigDagProcessor
Configuration for resources used by DAG processor.
scheduler EnvironmentConfigWorkloadsConfigScheduler
Configuration for resources used by Airflow schedulers.
triggerer EnvironmentConfigWorkloadsConfigTriggerer
Configuration for resources used by Airflow triggerers.
webServer EnvironmentConfigWorkloadsConfigWebServer
Configuration for resources used by Airflow web server.
worker EnvironmentConfigWorkloadsConfigWorker
Configuration for resources used by Airflow workers.
dag_processor EnvironmentConfigWorkloadsConfigDagProcessor
Configuration for resources used by DAG processor.
scheduler EnvironmentConfigWorkloadsConfigScheduler
Configuration for resources used by Airflow schedulers.
triggerer EnvironmentConfigWorkloadsConfigTriggerer
Configuration for resources used by Airflow triggerers.
web_server EnvironmentConfigWorkloadsConfigWebServer
Configuration for resources used by Airflow web server.
worker EnvironmentConfigWorkloadsConfigWorker
Configuration for resources used by Airflow workers.
dagProcessor Property Map
Configuration for resources used by DAG processor.
scheduler Property Map
Configuration for resources used by Airflow schedulers.
triggerer Property Map
Configuration for resources used by Airflow triggerers.
webServer Property Map
Configuration for resources used by Airflow web server.
worker Property Map
Configuration for resources used by Airflow workers.

EnvironmentConfigWorkloadsConfigDagProcessor
, EnvironmentConfigWorkloadsConfigDagProcessorArgs

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.

EnvironmentConfigWorkloadsConfigScheduler
, EnvironmentConfigWorkloadsConfigSchedulerArgs

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.

EnvironmentConfigWorkloadsConfigTriggerer
, EnvironmentConfigWorkloadsConfigTriggererArgs

Count This property is required. int
The number of triggerers.
Cpu This property is required. double
CPU request and limit for a single Airflow triggerer replica.
MemoryGb This property is required. double
Memory (GB) request and limit for a single Airflow triggerer replica.
Count This property is required. int
The number of triggerers.
Cpu This property is required. float64
CPU request and limit for a single Airflow triggerer replica.
MemoryGb This property is required. float64
Memory (GB) request and limit for a single Airflow triggerer replica.
count This property is required. Integer
The number of triggerers.
cpu This property is required. Double
CPU request and limit for a single Airflow triggerer replica.
memoryGb This property is required. Double
Memory (GB) request and limit for a single Airflow triggerer replica.
count This property is required. number
The number of triggerers.
cpu This property is required. number
CPU request and limit for a single Airflow triggerer replica.
memoryGb This property is required. number
Memory (GB) request and limit for a single Airflow triggerer replica.
count This property is required. int
The number of triggerers.
cpu This property is required. float
CPU request and limit for a single Airflow triggerer replica.
memory_gb This property is required. float
Memory (GB) request and limit for a single Airflow triggerer replica.
count This property is required. Number
The number of triggerers.
cpu This property is required. Number
CPU request and limit for a single Airflow triggerer replica.
memoryGb This property is required. Number
Memory (GB) request and limit for a single Airflow triggerer replica.

EnvironmentConfigWorkloadsConfigWebServer
, EnvironmentConfigWorkloadsConfigWebServerArgs

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.

EnvironmentConfigWorkloadsConfigWorker
, EnvironmentConfigWorkloadsConfigWorkerArgs

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.

EnvironmentStorageConfig
, EnvironmentStorageConfigArgs

Bucket
This property is required.
Changes to this property will trigger replacement.
string
Optional. Name of an existing Cloud Storage bucket to be used by the environment.
Bucket
This property is required.
Changes to this property will trigger replacement.
string
Optional. Name of an existing Cloud Storage bucket to be used by the environment.
bucket
This property is required.
Changes to this property will trigger replacement.
String
Optional. Name of an existing Cloud Storage bucket to be used by the environment.
bucket
This property is required.
Changes to this property will trigger replacement.
string
Optional. Name of an existing Cloud Storage bucket to be used by the environment.
bucket
This property is required.
Changes to this property will trigger replacement.
str
Optional. Name of an existing Cloud Storage bucket to be used by the environment.
bucket
This property is required.
Changes to this property will trigger replacement.
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 v8.26.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-gcp