EnvironmentConfig

import type { EnvironmentConfig } from "https://googleapis.deno.dev/v1/composer:v1.ts";

Configuration information for an environment.

interface EnvironmentConfig {

readonly airflowByoidUri?: string;

airflowUri?: string;

dagGcsPrefix?: string;

databaseConfig?: DatabaseConfig;

dataRetentionConfig?: DataRetentionConfig;

encryptionConfig?: EncryptionConfig;

environmentSize?:

| "ENVIRONMENT_SIZE_UNSPECIFIED"

| "ENVIRONMENT_SIZE_SMALL"

| "ENVIRONMENT_SIZE_MEDIUM"

| "ENVIRONMENT_SIZE_LARGE";

gkeCluster?: string;

maintenanceWindow?: MaintenanceWindow;

masterAuthorizedNetworksConfig?: MasterAuthorizedNetworksConfig;

nodeConfig?: NodeConfig;

nodeCount?: number;

privateEnvironmentConfig?: PrivateEnvironmentConfig;

recoveryConfig?: RecoveryConfig;

resilienceMode?: "RESILIENCE_MODE_UNSPECIFIED" | "HIGH_RESILIENCE";

softwareConfig?: SoftwareConfig;

webServerConfig?: WebServerConfig;

webServerNetworkAccessControl?: WebServerNetworkAccessControl;

workloadsConfig?: WorkloadsConfig;

}

§Properties

readonly airflowByoidUri?: string

[src]

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).

airflowUri?: string

[src]

Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface).

dagGcsPrefix?: string

[src]

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.

databaseConfig?: DatabaseConfig

[src]

Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software.

dataRetentionConfig?: DataRetentionConfig

[src]

Optional. The configuration setting for Airflow database data retention mechanism.

encryptionConfig?: EncryptionConfig

[src]

Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated.

environmentSize?: "ENVIRONMENT_SIZE_UNSPECIFIED" | "ENVIRONMENT_SIZE_SMALL" | "ENVIRONMENT_SIZE_MEDIUM" | "ENVIRONMENT_SIZE_LARGE"

[src]

Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

gkeCluster?: string

[src]

Output only. The Kubernetes Engine cluster used to run this environment.

maintenanceWindow?: MaintenanceWindow

[src]

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.

masterAuthorizedNetworksConfig?: MasterAuthorizedNetworksConfig

[src]

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.

nodeConfig?: NodeConfig

[src]

The configuration used for the Kubernetes Engine cluster.

nodeCount?: number

[src]

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?: PrivateEnvironmentConfig

[src]

The configuration used for the Private IP Cloud Composer environment.

recoveryConfig?: RecoveryConfig

[src]

Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

resilienceMode?: "RESILIENCE_MODE_UNSPECIFIED" | "HIGH_RESILIENCE"

[src]

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.

softwareConfig?: SoftwareConfig

[src]

The configuration settings for software inside the environment.

webServerConfig?: WebServerConfig

[src]

Optional. The configuration settings for the Airflow web server App Engine instance.

webServerNetworkAccessControl?: WebServerNetworkAccessControl

[src]

Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

workloadsConfig?: WorkloadsConfig

[src]

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.