Class EnvironmentConfig

Configuration information for an environment.

Inheritance
object
EnvironmentConfig
Implements
Inherited Members
Namespace: Google.Apis.CloudComposer.v1.Data
Assembly: Google.Apis.CloudComposer.v1.dll
Syntax
public class EnvironmentConfig : IDirectResponseSchema

Properties

AirflowByoidUri

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

Declaration
[JsonProperty("airflowByoidUri")]
public virtual string AirflowByoidUri { get; set; }
Property Value
Type Description
string

AirflowUri

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

Declaration
[JsonProperty("airflowUri")]
public virtual string AirflowUri { get; set; }
Property Value
Type Description
string

DagGcsPrefix

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.

Declaration
[JsonProperty("dagGcsPrefix")]
public virtual string DagGcsPrefix { get; set; }
Property Value
Type Description
string

DataRetentionConfig

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

Declaration
[JsonProperty("dataRetentionConfig")]
public virtual DataRetentionConfig DataRetentionConfig { get; set; }
Property Value
Type Description
DataRetentionConfig

DatabaseConfig

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

Declaration
[JsonProperty("databaseConfig")]
public virtual DatabaseConfig DatabaseConfig { get; set; }
Property Value
Type Description
DatabaseConfig

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionConfig

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

Declaration
[JsonProperty("encryptionConfig")]
public virtual EncryptionConfig EncryptionConfig { get; set; }
Property Value
Type Description
EncryptionConfig

EnvironmentSize

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

Declaration
[JsonProperty("environmentSize")]
public virtual string EnvironmentSize { get; set; }
Property Value
Type Description
string

GkeCluster

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

Declaration
[JsonProperty("gkeCluster")]
public virtual string GkeCluster { get; set; }
Property Value
Type Description
string

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 is applied. By default, maintenance windows are from 00:00:00 to 04:00:00 (GMT) on Friday, Saturday, and Sunday every week.

Declaration
[JsonProperty("maintenanceWindow")]
public virtual MaintenanceWindow MaintenanceWindow { get; set; }
Property Value
Type Description
MaintenanceWindow

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.

Declaration
[JsonProperty("masterAuthorizedNetworksConfig")]
public virtual MasterAuthorizedNetworksConfig MasterAuthorizedNetworksConfig { get; set; }
Property Value
Type Description
MasterAuthorizedNetworksConfig

NodeConfig

Optional. The configuration used for the Kubernetes Engine cluster.

Declaration
[JsonProperty("nodeConfig")]
public virtual NodeConfig NodeConfig { get; set; }
Property Value
Type Description
NodeConfig

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

Declaration
[JsonProperty("nodeCount")]
public virtual int? NodeCount { get; set; }
Property Value
Type Description
int?

PrivateEnvironmentConfig

Optional. The configuration used for the Private IP Cloud Composer environment.

Declaration
[JsonProperty("privateEnvironmentConfig")]
public virtual PrivateEnvironmentConfig PrivateEnvironmentConfig { get; set; }
Property Value
Type Description
PrivateEnvironmentConfig

RecoveryConfig

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

Declaration
[JsonProperty("recoveryConfig")]
public virtual RecoveryConfig RecoveryConfig { get; set; }
Property Value
Type Description
RecoveryConfig

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.

Declaration
[JsonProperty("resilienceMode")]
public virtual string ResilienceMode { get; set; }
Property Value
Type Description
string

SoftwareConfig

Optional. The configuration settings for software inside the environment.

Declaration
[JsonProperty("softwareConfig")]
public virtual SoftwareConfig SoftwareConfig { get; set; }
Property Value
Type Description
SoftwareConfig

WebServerConfig

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

Declaration
[JsonProperty("webServerConfig")]
public virtual WebServerConfig WebServerConfig { get; set; }
Property Value
Type Description
WebServerConfig

WebServerNetworkAccessControl

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

Declaration
[JsonProperty("webServerNetworkAccessControl")]
public virtual WebServerNetworkAccessControl WebServerNetworkAccessControl { get; set; }
Property Value
Type Description
WebServerNetworkAccessControl

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.

Declaration
[JsonProperty("workloadsConfig")]
public virtual WorkloadsConfig WorkloadsConfig { get; set; }
Property Value
Type Description
WorkloadsConfig

Implements