gcp_composer_environment
ancestors
Type: UNORDERED_LIST_STRING
config
Type: STRUCT
Provider name: config
Description: Optional. Configuration parameters for this environment.
airflow_byoid_uri
Type: STRING
Provider name: airflowByoidUri
Description: Output only. The ‘bring your own identity’ variant of the URI of the Apache Airflow Web UI hosted within this environment, to be accessed with external identities using workforce identity federation (see Access environments with workforce identity federation).
airflow_uri
Type: STRING
Provider name: airflowUri
Description: Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).
dag_gcs_prefix
Type: STRING
Provider name: dagGcsPrefix
Description: Output only. 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 the given prefix.
data_retention_config
Type: STRUCT
Provider name: dataRetentionConfig
Description: Optional. The configuration setting for Airflow database data retention mechanism.
airflow_database_retention_days
Type: INT32
Provider name: airflowDatabaseRetentionDays
Description: Optional. The number of days describing for how long to store event-based records in airflow database. If the retention mechanism is enabled this value must be a positive integer otherwise, value should be set to 0.
airflow_metadata_retention_config
Type: STRUCT
Provider name: airflowMetadataRetentionConfig
Description: Optional. The retention policy for airflow metadata database.
retention_days
Type: INT32
Provider name: retentionDays
Description: Optional. How many days data should be retained for.
retention_mode
Type: STRING
Provider name: retentionMode
Description: Optional. Retention can be either enabled or disabled.
Possible values:
RETENTION_MODE_UNSPECIFIED
- Default mode doesn’t change environment parameters.
RETENTION_MODE_ENABLED
- Retention policy is enabled.
RETENTION_MODE_DISABLED
- Retention policy is disabled.
task_logs_retention_config
Type: STRUCT
Provider name: taskLogsRetentionConfig
Description: Optional. The configuration settings for task logs retention
storage_mode
Type: STRING
Provider name: storageMode
Description: Optional. The mode of storage for Airflow workers task logs.
Possible values:
TASK_LOGS_STORAGE_MODE_UNSPECIFIED
- This configuration is not specified by the user.
CLOUD_LOGGING_AND_CLOUD_STORAGE
- Store task logs in Cloud Logging and in the environment’s Cloud Storage bucket.
CLOUD_LOGGING_ONLY
- Store task logs in Cloud Logging only.
database_config
Type: STRUCT
Provider name: databaseConfig
Description: Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
machine_type
Type: STRING
Provider name: machineType
Description: 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. Supported for Cloud Composer environments in versions composer-1..-airflow-..*.
zone
Type: STRING
Provider name: zone
Description: Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2..-airflow-..*.
encryption_config
Type: STRUCT
Provider name: encryptionConfig
Description: Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
kms_key_name
Type: STRING
Provider name: kmsKeyName
Description: Optional. Customer-managed Encryption Key available through Google’s Key Management Service. Cannot be updated. If not specified, Google-managed key will be used.
environment_size
Type: STRING
Provider name: environmentSize
Description: Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
Possible values:
ENVIRONMENT_SIZE_UNSPECIFIED
- The size of the environment is unspecified.
ENVIRONMENT_SIZE_SMALL
- The environment size is small.
ENVIRONMENT_SIZE_MEDIUM
- The environment size is medium.
ENVIRONMENT_SIZE_LARGE
- The environment size is large.
gke_cluster
Type: STRING
Provider name: gkeCluster
Description: Output only. The Kubernetes Engine cluster used to run this environment.
maintenance_window
Type: STRUCT
Provider name: maintenanceWindow
Description: Optional. The maintenance window is the period when Cloud Composer components may undergo maintenance. It is defined so that maintenance is not executed during peak hours or critical time periods. The system will not be under maintenance for every occurrence of this window, but when maintenance is planned, it will be scheduled during the window. The maintenance window period must encompass at least 12 hours per week. This may be split into multiple chunks, each with a size of at least 4 hours. If this value is omitted, the default value for maintenance window is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week.
end_time
Type: TIMESTAMP
Provider name: endTime
Description: Required. 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
Type: STRING
Provider name: recurrence
Description: Required. Maintenance window recurrence. Format is a subset of RFC-5545 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
Type: TIMESTAMP
Provider name: startTime
Description: Required. Start time of the first recurrence of the maintenance window.
master_authorized_networks_config
Type: STRUCT
Provider name: masterAuthorizedNetworksConfig
Description: Optional. The configuration options for GKE cluster master authorized networks. By default master authorized networks feature is: - in case of private environment: enabled with no external networks allowlisted. - in case of public environment: disabled.
cidr_blocks
Type: UNORDERED_LIST_STRUCT
Provider name: cidrBlocks
Description: Up to 50 external networks that could access Kubernetes master through HTTPS.
cidr_block
Type: STRING
Provider name: cidrBlock
Description: CIDR block that must be specified in CIDR notation.
gcp_display_name
Type: STRING
Provider name: displayName
Description: User-defined name that identifies the CIDR block.
enabled
Type: BOOLEAN
Provider name: enabled
Description: Optional. Whether or not master authorized networks feature is enabled.
node_config
Type: STRUCT
Provider name: nodeConfig
Description: Optional. The configuration used for the Kubernetes Engine cluster.
composer_internal_ipv4_cidr_block
Type: STRING
Provider name: composerInternalIpv4CidrBlock
Description: Optional. The IP range in CIDR notation to use internally by Cloud Composer. IP addresses are not reserved - and the same range can be used by multiple Cloud Composer environments. In case of overlap, IPs from this range will not be accessible in the user’s VPC network. Cannot be updated. If not specified, the default value of ‘100.64.128.0/20’ is used. This field is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
composer_network_attachment
Type: STRING
Provider name: composerNetworkAttachment
Description: Optional. Network Attachment that Cloud Composer environment is connected to, which provides connectivity with a user’s VPC network. Takes precedence over network and subnetwork settings. If not provided, but network and subnetwork are defined during environment, it will be provisioned. If not provided and network and subnetwork are also empty, then connectivity to user’s VPC network is disabled. Network attachment must be provided in format projects/{project}/regions/{region}/networkAttachments/{networkAttachment}. This field is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
disk_size_gb
Type: INT32
Provider name: diskSizeGb
Description: Optional. The disk size in GB used for node VMs. Minimum size is 30GB. 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
Type: BOOLEAN
Provider name: enableIpMasqAgent
Description: Optional. 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
Type: STRUCT
Provider name: ipAllocationPolicy
Description: Optional. The IPAllocationPolicy fields for the GKE cluster.
cluster_ipv4_cidr_block
Type: STRING
Provider name: clusterIpv4CidrBlock
Description: Optional. 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 cluster_secondary_range_name
or cluster_ipv4_cidr_block
but not both.
cluster_secondary_range_name
Type: STRING
Provider name: clusterSecondaryRangeName
Description: Optional. 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
Type: STRING
Provider name: servicesIpv4CidrBlock
Description: Optional. The IP address range of the services 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 services_secondary_range_name
or services_ipv4_cidr_block
but not both.
services_secondary_range_name
Type: STRING
Provider name: servicesSecondaryRangeName
Description: Optional. 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
Type: BOOLEAN
Provider name: useIpAliases
Description: Optional. Whether or not to enable Alias IPs in the GKE cluster. If true
, a VPC-native cluster is created. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
location
Type: STRING
Provider name: location
Description: Optional. The Compute Engine zone in which to deploy the VMs used to run the Apache Airflow software, specified as a relative resource name. For example: “projects/{projectId}/zones/{zoneId}”. This location
must belong to the enclosing environment’s project and location. If both this field and nodeConfig.machineType
are specified, nodeConfig.machineType
must belong to this location
; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If only one field (location
or nodeConfig.machineType
) is specified, the location information from the specified field will be propagated to the unspecified field. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
machine_type
Type: STRING
Provider name: machineType
Description: Optional. The Compute Engine machine type used for cluster instances, specified as a relative resource name. For example: “projects/{projectId}/zones/{zoneId}/machineTypes/{machineTypeId}”. The machineType
must belong to the enclosing environment’s project and location. If both this field and nodeConfig.location
are specified, this machineType
must belong to the nodeConfig.location
; if both are unspecified, the service will pick a zone in the Compute Engine region corresponding to the Cloud Composer location, and propagate that choice to both fields. If exactly one of this field and nodeConfig.location
is specified, the location information from the specified field will be propagated to the unspecified field. The machineTypeId
must not be a shared-core machine type. If this field is unspecified, the machineTypeId
defaults to “n1-standard-1”. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
max_pods_per_node
Type: INT32
Provider name: maxPodsPerNode
Description: Optional. The maximum number of pods per node in the Cloud Composer GKE cluster. The value must be between 8 and 110 and it can be set only if the environment is VPC-native. The default value is 32. Values of this field will be propagated both to the default-pool
node pool of the newly created GKE cluster, and to the default “Maximum Pods per Node” value which is used for newly created node pools if their value is not explicitly set during node pool creation. For more information, see [Optimizing IP address allocation] (https://cloud.google.com/kubernetes-engine/docs/how-to/flexible-pod-cidr). Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
network
Type: STRING
Provider name: network
Description: Optional. The Compute Engine network to be used for machine communications, specified as a relative resource name. For example: “projects/{projectId}/global/networks/{networkId}”. If unspecified, the default network in the environment’s project is used. If a Custom Subnet Network is provided, nodeConfig.subnetwork
must also be provided. For Shared VPC subnetwork requirements, see nodeConfig.subnetwork
.
oauth_scopes
Type: UNORDERED_LIST_STRING
Provider name: oauthScopes
Description: Optional. The set of Google API scopes to be made available on all node VMs. If oauth_scopes
is empty, defaults to [“https://www.googleapis.com/auth/cloud-platform”]. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
service_account
Type: STRING
Provider name: serviceAccount
Description: Optional. The Google Cloud Platform Service Account to be used by the workloads. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated.
subnetwork
Type: STRING
Provider name: subnetwork
Description: Optional. The Compute Engine subnetwork to be used for machine communications, specified as a relative resource name. For example: “projects/{projectId}/regions/{regionId}/subnetworks/{subnetworkId}” If a subnetwork is provided, nodeConfig.network
must also be provided, and the subnetwork must belong to the enclosing environment’s project and location.
node_count
Type: INT32
Provider name: nodeCount
Description: 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
Type: STRUCT
Provider name: privateEnvironmentConfig
Description: Optional. The configuration used for the Private IP Cloud Composer environment.
cloud_composer_connection_subnetwork
Type: STRING
Provider name: cloudComposerConnectionSubnetwork
Description: Optional. 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.
cloud_composer_network_ipv4_cidr_block
Type: STRING
Provider name: cloudComposerNetworkIpv4CidrBlock
Description: Optional. 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_composer_network_ipv4_reserved_range
Type: STRING
Provider name: cloudComposerNetworkIpv4ReservedRange
Description: Output only. The IP range reserved for the tenant project’s Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
cloud_sql_ipv4_cidr_block
Type: STRING
Provider name: cloudSqlIpv4CidrBlock
Description: Optional. 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
enable_private_builds_only
Type: BOOLEAN
Provider name: enablePrivateBuildsOnly
Description: Optional. If true
, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either NodeConfig.network
and NodeConfig.subnetwork
fields or NodeConfig.composer_network_attachment
field are specified). If false
, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
enable_private_environment
Type: BOOLEAN
Provider name: enablePrivateEnvironment
Description: Optional. If true
, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases
must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
enable_privately_used_public_ips
Type: BOOLEAN
Provider name: enablePrivatelyUsedPublicIps
Description: Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block
and IPAllocationPolicy.service_ipv4_cidr_block
.
networking_config
Type: STRUCT
Provider name: networkingConfig
Description: Optional. Configuration for the network connections configuration in the environment.
connection_type
Type: STRING
Provider name: connectionType
Description: Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
Possible values:
CONNECTION_TYPE_UNSPECIFIED
- No specific connection type was requested, so the environment uses the default value corresponding to the rest of its configuration.
VPC_PEERING
- Requests the use of VPC peerings for connecting the Customer and Tenant projects.
PRIVATE_SERVICE_CONNECT
- Requests the use of Private Service Connect for connecting the Customer and Tenant projects.
private_cluster_config
Type: STRUCT
Provider name: privateClusterConfig
Description: Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
enable_private_endpoint
Type: BOOLEAN
Provider name: enablePrivateEndpoint
Description: Optional. If true
, access to the public endpoint of the GKE cluster is denied.
master_ipv4_cidr_block
Type: STRING
Provider name: masterIpv4CidrBlock
Description: Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of ‘172.16.0.0/23’ is used.
master_ipv4_reserved_range
Type: STRING
Provider name: masterIpv4ReservedRange
Description: Output only. 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.
web_server_ipv4_cidr_block
Type: STRING
Provider name: webServerIpv4CidrBlock
Description: Optional. The CIDR block from which IP range for web server 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-1..-airflow-..*.
web_server_ipv4_reserved_range
Type: STRING
Provider name: webServerIpv4ReservedRange
Description: Output only. The IP range reserved for the tenant project’s App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
recovery_config
Type: STRUCT
Provider name: recoveryConfig
Description: Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
scheduled_snapshots_config
Type: STRUCT
Provider name: scheduledSnapshotsConfig
Description: Optional. The configuration for scheduled snapshot creation mechanism.
enabled
Type: BOOLEAN
Provider name: enabled
Description: Optional. Whether scheduled snapshots creation is enabled.
snapshot_creation_schedule
Type: STRING
Provider name: snapshotCreationSchedule
Description: Optional. The cron expression representing the time when snapshots creation mechanism runs. This field is subject to additional validation around frequency of execution.
snapshot_location
Type: STRING
Provider name: snapshotLocation
Description: Optional. The Cloud Storage location for storing automatically created snapshots.
time_zone
Type: STRING
Provider name: timeZone
Description: Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
resilience_mode
Type: STRING
Provider name: resilienceMode
Description: Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-..* and newer.
Possible values:
RESILIENCE_MODE_UNSPECIFIED
- Default mode doesn’t change environment parameters.
HIGH_RESILIENCE
- Enabled High Resilience mode, including Cloud SQL HA.
software_config
Type: STRUCT
Provider name: softwareConfig
Description: Optional. The configuration settings for software inside the environment.
cloud_data_lineage_integration
Type: STRUCT
Provider name: cloudDataLineageIntegration
Description: Optional. The configuration for Cloud Data Lineage integration.
enabled
Type: BOOLEAN
Provider name: enabled
Description: Optional. Whether or not Cloud Data Lineage integration is enabled.
image_version
Type: STRING
Provider name: imageVersion
Description: Optional. 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]+)?)?)
. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. 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
. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. 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. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also version list and versioning overview.
python_version
Type: STRING
Provider name: pythonVersion
Description: Optional. 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 ‘3’. Cannot be updated. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
scheduler_count
Type: INT32
Provider name: schedulerCount
Description: Optional. The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
web_server_plugins_mode
Type: STRING
Provider name: webServerPluginsMode
Description: Optional. Whether or not the web server uses custom plugins. If unspecified, the field defaults to PLUGINS_ENABLED
. This field is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
Possible values:
WEB_SERVER_PLUGINS_MODE_UNSPECIFIED
- Default mode.
PLUGINS_DISABLED
- Web server plugins are not supported.
PLUGINS_ENABLED
- Web server plugins are supported.
web_server_config
Type: STRUCT
Provider name: webServerConfig
Description: Optional. The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
machine_type
Type: STRING
Provider name: machineType
Description: 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.
web_server_network_access_control
Type: STRUCT
Provider name: webServerNetworkAccessControl
Description: Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
allowed_ip_ranges
Type: UNORDERED_LIST_STRUCT
Provider name: allowedIpRanges
Description: A collection of allowed IP ranges with descriptions.
description
Type: STRING
Provider name: description
Description: Optional. User-provided description. It must contain at most 300 characters.
value
Type: STRING
Provider name: value
Description: 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
.
workloads_config
Type: STRUCT
Provider name: workloadsConfig
Description: Optional. The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. The GKE cluster runs Airflow scheduler, web server and workers workloads. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
dag_processor
Type: STRUCT
Provider name: dagProcessor
Description: Optional. Resources used by Airflow DAG processors. This field is supported for Cloud Composer environments in versions composer-3-airflow-..-build. and newer.
count
Type: INT32
Provider name: count
Description: Optional. The number of DAG processors. If not provided or set to 0, a single DAG processor instance will be created.
cpu
Type: FLOAT
Provider name: cpu
Description: Optional. CPU request and limit for a single Airflow DAG processor replica.
memory_gb
Type: FLOAT
Provider name: memoryGb
Description: Optional. Memory (GB) request and limit for a single Airflow DAG processor replica.
storage_gb
Type: FLOAT
Provider name: storageGb
Description: Optional. Storage (GB) request and limit for a single Airflow DAG processor replica.
scheduler
Type: STRUCT
Provider name: scheduler
Description: Optional. Resources used by Airflow schedulers.
count
Type: INT32
Provider name: count
Description: Optional. The number of schedulers.
cpu
Type: FLOAT
Provider name: cpu
Description: Optional. CPU request and limit for a single Airflow scheduler replica.
memory_gb
Type: FLOAT
Provider name: memoryGb
Description: Optional. Memory (GB) request and limit for a single Airflow scheduler replica.
storage_gb
Type: FLOAT
Provider name: storageGb
Description: Optional. Storage (GB) request and limit for a single Airflow scheduler replica.
triggerer
Type: STRUCT
Provider name: triggerer
Description: Optional. Resources used by Airflow triggerers.
count
Type: INT32
Provider name: count
Description: Optional. The number of triggerers.
cpu
Type: FLOAT
Provider name: cpu
Description: Optional. CPU request and limit for a single Airflow triggerer replica.
memory_gb
Type: FLOAT
Provider name: memoryGb
Description: Optional. Memory (GB) request and limit for a single Airflow triggerer replica.
web_server
Type: STRUCT
Provider name: webServer
Description: Optional. Resources used by Airflow web server.
cpu
Type: FLOAT
Provider name: cpu
Description: Optional. CPU request and limit for Airflow web server.
memory_gb
Type: FLOAT
Provider name: memoryGb
Description: Optional. Memory (GB) request and limit for Airflow web server.
storage_gb
Type: FLOAT
Provider name: storageGb
Description: Optional. Storage (GB) request and limit for Airflow web server.
worker
Type: STRUCT
Provider name: worker
Description: Optional. Resources used by Airflow workers.
cpu
Type: FLOAT
Provider name: cpu
Description: Optional. CPU request and limit for a single Airflow worker replica.
max_count
Type: INT32
Provider name: maxCount
Description: Optional. Maximum number of workers for autoscaling.
memory_gb
Type: FLOAT
Provider name: memoryGb
Description: Optional. Memory (GB) request and limit for a single Airflow worker replica.
min_count
Type: INT32
Provider name: minCount
Description: Optional. Minimum number of workers for autoscaling.
storage_gb
Type: FLOAT
Provider name: storageGb
Description: Optional. Storage (GB) request and limit for a single Airflow worker replica.
create_time
Type: TIMESTAMP
Provider name: createTime
Description: Output only. The time at which this environment was created.
labels
Type: UNORDERED_LIST_STRING
name
Type: STRING
Provider name: name
Description: Identifier. The resource name of the environment, in the form: “projects/{projectId}/locations/{locationId}/environments/{environmentId}” EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
organization_id
Type: STRING
parent
Type: STRING
project_id
Type: STRING
project_number
Type: STRING
resource_name
Type: STRING
satisfies_pzi
Type: BOOLEAN
Provider name: satisfiesPzi
Description: Output only. Reserved for future use.
satisfies_pzs
Type: BOOLEAN
Provider name: satisfiesPzs
Description: Output only. Reserved for future use.
state
Type: STRING
Provider name: state
Description: The current state of the environment.
Possible values:
STATE_UNSPECIFIED
- The state of the environment is unknown.
CREATING
- The environment is in the process of being created.
RUNNING
- The environment is currently running and healthy. It is ready for use.
UPDATING
- The environment is being updated. It remains usable but cannot receive additional update requests or be deleted at this time.
DELETING
- The environment is undergoing deletion. It cannot be used.
ERROR
- The environment has encountered an error and cannot be used.
storage_config
Type: STRUCT
Provider name: storageConfig
Description: Optional. Storage configuration for this environment.
bucket
Type: STRING
Provider name: bucket
Description: Optional. The name of the Cloud Storage bucket used by the environment. No gs://
prefix.
Type: UNORDERED_LIST_STRING
update_time
Type: TIMESTAMP
Provider name: updateTime
Description: Output only. The time at which this environment was last modified.
uuid
Type: STRING
Provider name: uuid
Description: Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created.