EnvironmentConfig class

Constructors

EnvironmentConfig({Input<String?>? airflowUri, Input<String?>? dagGcsPrefix, Input<EnvironmentConfigDataRetentionConfig?>? dataRetentionConfig, Input<EnvironmentConfigDatabaseConfig?>? databaseConfig, Input<bool?>? enablePrivateBuildsOnly, Input<bool?>? enablePrivateEnvironment, Input<EnvironmentConfigEncryptionConfig?>? encryptionConfig, Input<String?>? environmentSize, Input<String?>? gkeCluster, Input<EnvironmentConfigMaintenanceWindow?>? maintenanceWindow, Input<EnvironmentConfigMasterAuthorizedNetworksConfig?>? masterAuthorizedNetworksConfig, Input<EnvironmentConfigNodeConfig?>? nodeConfig, Input<int?>? nodeCount, Input<EnvironmentConfigPrivateEnvironmentConfig?>? privateEnvironmentConfig, Input<EnvironmentConfigRecoveryConfig?>? recoveryConfig, Input<String?>? resilienceMode, Input<EnvironmentConfigSoftwareConfig?>? softwareConfig, Input<EnvironmentConfigWebServerConfig?>? webServerConfig, Input<EnvironmentConfigWebServerNetworkAccessControl?>? webServerNetworkAccessControl, Input<EnvironmentConfigWorkloadsConfig?>? workloadsConfig})
Creates a new EnvironmentConfig. airflowUri The URI of the Apache Airflow Web UI hosted within this dagGcsPrefix The Cloud Storage prefix of the DAGs for this environment. dataRetentionConfig 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 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 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 Optional. If true, a private Composer environment will be created. encryptionConfig The encryption options for the Composer environment and its dependencies. environmentSize The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-.. and newer. gkeCluster The Kubernetes Engine cluster used to run this environment. maintenanceWindow The configuration for Cloud Composer maintenance window. masterAuthorizedNetworksConfig 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 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 The recovery configuration settings for the Cloud Composer environment resilienceMode 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 The configuration settings for software inside the environment. webServerConfig 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 Network-level access control policy for the Airflow web server. workloadsConfig 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.
const
EnvironmentConfig.fromMap(Map<String, dynamic> map)
factory

Properties

airflowUri → Input<String?>?
The URI of the Apache Airflow Web UI hosted within this environment.
final
dagGcsPrefix → Input<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.
final
databaseConfig → Input<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-..*.
final
dataRetentionConfig → Input<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
final
enablePrivateBuildsOnly → Input<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.
final
enablePrivateEnvironment → Input<bool?>?
Optional. If true, a private Composer environment will be created.
final
encryptionConfig → Input<EnvironmentConfigEncryptionConfig?>?
The encryption options for the Composer environment and its dependencies.
final
environmentSize → Input<String?>?
The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
final
gkeCluster → Input<String?>?
The Kubernetes Engine cluster used to run this environment.
final
hashCode → int
The hash code for this object.
no setterinherited
maintenanceWindow → Input<EnvironmentConfigMaintenanceWindow?>?
The configuration for Cloud Composer maintenance window.
final
masterAuthorizedNetworksConfig → Input<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.
final
nodeConfig → Input<EnvironmentConfigNodeConfig?>?
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<EnvironmentConfigPrivateEnvironmentConfig?>?
The configuration used for the Private IP Cloud Composer environment.
final
recoveryConfig → Input<EnvironmentConfigRecoveryConfig?>?
The recovery configuration settings for the Cloud Composer environment
final
resilienceMode → Input<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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
softwareConfig → Input<EnvironmentConfigSoftwareConfig?>?
The configuration settings for software inside the environment.
final
webServerConfig → Input<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-..*.
final
webServerNetworkAccessControl → Input<EnvironmentConfigWebServerNetworkAccessControl?>?
Network-level access control policy for the Airflow web server.
final
workloadsConfig → Input<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.
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