EnvironmentConfig class

Configuration information for an environment.

Constructors

EnvironmentConfig({Input<DatabaseConfig>? databaseConfig, Input<EncryptionConfig>? encryptionConfig, Input<EnvironmentConfigEnvironmentSize>? environmentSize, Input<MaintenanceWindow>? maintenanceWindow, Input<MasterAuthorizedNetworksConfig>? masterAuthorizedNetworksConfig, Input<NodeConfig>? nodeConfig, Input<int>? nodeCount, Input<PrivateEnvironmentConfig>? privateEnvironmentConfig, Input<RecoveryConfig>? recoveryConfig, Input<EnvironmentConfigResilienceMode>? resilienceMode, Input<SoftwareConfig>? softwareConfig, Input<WebServerConfig>? webServerConfig, Input<WebServerNetworkAccessControl>? webServerNetworkAccessControl, Input<WorkloadsConfig>? workloadsConfig})

Creates a new EnvironmentConfig. databaseConfig Optional. The configuration settings for Cloud SQL instance used internally by Apache Airflow software. encryptionConfig Optional. The encryption options for the Cloud Composer environment and its dependencies. Cannot be updated. environmentSize Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer. 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, the default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT. 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. nodeConfig The configuration used for the Kubernetes Engine cluster. nodeCount 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 The configuration used for the Private IP Cloud Composer environment. recoveryConfig Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-.. and newer. 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. softwareConfig The configuration settings for software inside the environment. webServerConfig Optional. The configuration settings for the Airflow web server App Engine instance. webServerNetworkAccessControl Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. 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.

const

EnvironmentConfig.fromMap(Map<String, dynamic> map)

factory

Properties

databaseConfig → Input<DatabaseConfig>?

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

final

encryptionConfig → Input<EncryptionConfig>?

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

final

environmentSize → Input<EnvironmentConfigEnvironmentSize>?

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

final

hashCode → int

The hash code for this object.

no setter, inherited

maintenanceWindow → Input<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, the default value for maintenance window will be applied. The default value is Saturday and Sunday 00-06 GMT.

final

masterAuthorizedNetworksConfig → Input<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.

final

nodeConfig → Input<NodeConfig>?

The configuration used for the Kubernetes Engine cluster.

final

nodeCount → Input<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-..*.

final

privateEnvironmentConfig → Input<PrivateEnvironmentConfig>?

The configuration used for the Private IP Cloud Composer environment.

final

recoveryConfig → Input<RecoveryConfig>?

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

final

resilienceMode → Input<EnvironmentConfigResilienceMode>?

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

softwareConfig → Input<SoftwareConfig>?

The configuration settings for software inside the environment.

final

webServerConfig → Input<WebServerConfig>?

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

final

webServerNetworkAccessControl → Input<WebServerNetworkAccessControl>?

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

final

workloadsConfig → Input<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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited