GetEnvironmentConfig class
Constructors
-
GetEnvironmentConfig({required Input<
String> airflowUri, required Input<String> dagGcsPrefix, required Input<List< dataRetentionConfigs, required Input<GetEnvironmentConfigDataRetentionConfig> >List< databaseConfigs, required Input<GetEnvironmentConfigDatabaseConfig> >bool> enablePrivateBuildsOnly, required Input<bool> enablePrivateEnvironment, required Input<List< encryptionConfigs, required Input<GetEnvironmentConfigEncryptionConfig> >String> environmentSize, required Input<String> gkeCluster, required Input<List< maintenanceWindows, required Input<GetEnvironmentConfigMaintenanceWindow> >List< masterAuthorizedNetworksConfigs, required Input<GetEnvironmentConfigMasterAuthorizedNetworksConfig> >List< nodeConfigs, required Input<GetEnvironmentConfigNodeConfig> >int> nodeCount, required Input<List< privateEnvironmentConfigs, required Input<GetEnvironmentConfigPrivateEnvironmentConfig> >List< recoveryConfigs, required Input<GetEnvironmentConfigRecoveryConfig> >String> resilienceMode, required Input<List< softwareConfigs, required Input<GetEnvironmentConfigSoftwareConfig> >List< webServerConfigs, required Input<GetEnvironmentConfigWebServerConfig> >List< webServerNetworkAccessControls, required Input<GetEnvironmentConfigWebServerNetworkAccessControl> >List< workloadsConfigs})GetEnvironmentConfigWorkloadsConfig> > -
Creates a new GetEnvironmentConfig.
airflowUriThe URI of the Apache Airflow Web UI hosted within thedagGcsPrefixThe Cloud Storage prefix of the DAGs for the environment.dataRetentionConfigsThe 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 newerdatabaseConfigsThe 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-...enablePrivateBuildsOnlyOptional. 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.enablePrivateEnvironmentOptional. If true, a private Composer environment will be created.encryptionConfigsThe encryption options for the Composer environment and its dependencies.environmentSizeThe size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-.. and newer.gkeClusterThe Kubernetes Engine cluster used to run the environment.maintenanceWindowsThe configuration for Cloud Composer maintenance window.masterAuthorizedNetworksConfigsConfiguration 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.nodeConfigsThe configuration used for the Kubernetes Engine cluster.nodeCountThe 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-...privateEnvironmentConfigsThe configuration used for the Private IP Cloud Composer environment.recoveryConfigsThe recovery configuration settings for the Cloud Composer environmentresilienceModeWhether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-.. and newer.softwareConfigsThe configuration settings for software inside the environment.webServerConfigsThe configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-...webServerNetworkAccessControlsNetwork-level access control policy for the Airflow web server.workloadsConfigsThe 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 -
GetEnvironmentConfig.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
airflowUri
→ Input<
String> -
The URI of the Apache Airflow Web UI hosted within the
environment.
final
-
dagGcsPrefix
→ Input<
String> -
The Cloud Storage prefix of the DAGs for the environment.
final
-
databaseConfigs
→ Input<
List< GetEnvironmentConfigDatabaseConfig> > -
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
-
dataRetentionConfigs
→ Input<
List< GetEnvironmentConfigDataRetentionConfig> > -
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
-
encryptionConfigs
→ Input<
List< GetEnvironmentConfigEncryptionConfig> > -
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 the environment.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
maintenanceWindows
→ Input<
List< GetEnvironmentConfigMaintenanceWindow> > -
The configuration for Cloud Composer maintenance window.
final
-
masterAuthorizedNetworksConfigs
→ Input<
List< GetEnvironmentConfigMasterAuthorizedNetworksConfig> > -
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
-
nodeConfigs
→ Input<
List< GetEnvironmentConfigNodeConfig> > -
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
-
privateEnvironmentConfigs
→ Input<
List< GetEnvironmentConfigPrivateEnvironmentConfig> > -
The configuration used for the Private IP Cloud Composer environment.
final
-
recoveryConfigs
→ Input<
List< GetEnvironmentConfigRecoveryConfig> > -
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
-
softwareConfigs
→ Input<
List< GetEnvironmentConfigSoftwareConfig> > -
The configuration settings for software inside the environment.
final
-
webServerConfigs
→ Input<
List< GetEnvironmentConfigWebServerConfig> > -
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
-
webServerNetworkAccessControls
→ Input<
List< GetEnvironmentConfigWebServerNetworkAccessControl> > -
Network-level access control policy for the Airflow web server.
final
-
workloadsConfigs
→ Input<
List< GetEnvironmentConfigWorkloadsConfig> > -
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