Class EnvironmentConfig (1.12.0)

Version 1.12.0

• 1.15.1 (latest)
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.11.1
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.1
• 1.6.1
• 1.5.0
• 1.4.4
• 1.3.2
• 1.2.1
• 1.1.0
• 1.0.0
• 0.1.3

EnvironmentConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration information for an environment.

Attributes
Name	Description
gke_cluster	str Output only. The Kubernetes Engine cluster used to run this environment.
dag_gcs_prefix	str 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.
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-*.*.*.
software_config	google.cloud.orchestration.airflow.service_v1beta1.types.SoftwareConfig The configuration settings for software inside the environment.
node_config	google.cloud.orchestration.airflow.service_v1beta1.types.NodeConfig The configuration used for the Kubernetes Engine cluster.
private_environment_config	google.cloud.orchestration.airflow.service_v1beta1.types.PrivateEnvironmentConfig The configuration used for the Private IP Cloud Composer environment.
web_server_network_access_control	google.cloud.orchestration.airflow.service_v1beta1.types.WebServerNetworkAccessControl Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.
database_config	google.cloud.orchestration.airflow.service_v1beta1.types.DatabaseConfig Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.
web_server_config	google.cloud.orchestration.airflow.service_v1beta1.types.WebServerConfig 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-*.*.*.
airflow_uri	str Output only. The URI of the Apache Airflow Web UI hosted within this environment (see `Airflow web interface `__).
airflow_byoid_uri	str 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 `__).
encryption_config	google.cloud.orchestration.airflow.service_v1beta1.types.EncryptionConfig Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.
maintenance_window	google.cloud.orchestration.airflow.service_v1beta1.types.MaintenanceWindow 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, Cloud Composer components may be subject to maintenance at any time.
workloads_config	google.cloud.orchestration.airflow.service_v1beta1.types.WorkloadsConfig 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.
environment_size	google.cloud.orchestration.airflow.service_v1beta1.types.EnvironmentConfig.EnvironmentSize Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2.\ *.*-airflow-*.*.\* and newer.
master_authorized_networks_config	google.cloud.orchestration.airflow.service_v1beta1.types.MasterAuthorizedNetworksConfig 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.
recovery_config	google.cloud.orchestration.airflow.service_v1beta1.types.RecoveryConfig Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.\ *.*-airflow-*.*.\* and newer.
data_retention_config	google.cloud.orchestration.airflow.service_v1beta1.types.DataRetentionConfig Optional. The configuration setting for Airflow database data retention mechanism.
resilience_mode	google.cloud.orchestration.airflow.service_v1beta1.types.EnvironmentConfig.ResilienceMode 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.

Classes

EnvironmentSize

EnvironmentSize(value)

The size of the Cloud Composer environment.

Values: ENVIRONMENT_SIZE_UNSPECIFIED (0): The size of the environment is unspecified. ENVIRONMENT_SIZE_SMALL (1): The environment size is small. ENVIRONMENT_SIZE_MEDIUM (2): The environment size is medium. ENVIRONMENT_SIZE_LARGE (3): The environment size is large.

ResilienceMode

ResilienceMode(value)

Resilience mode of the Cloud Composer Environment.

Values: RESILIENCE_MODE_UNSPECIFIED (0): Default mode doesn't change environment parameters. HIGH_RESILIENCE (1): Enabled High Resilience mode, including Cloud SQL HA.