Cloud Composer v1 API - Class EnvironmentConfig (2.5.0)

public sealed class EnvironmentConfig : IMessage<EnvironmentConfig>, IEquatable<EnvironmentConfig>, IDeepCloneable<EnvironmentConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Composer v1 API class EnvironmentConfig.

Configuration information for an environment.

Inheritance

object > EnvironmentConfig

Implements

IMessage EnvironmentConfig, IEquatable EnvironmentConfig, IDeepCloneable EnvironmentConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Orchestration.Airflow.Service.V1

Assembly

Google.Cloud.Orchestration.Airflow.Service.V1.dll

Constructors

EnvironmentConfig()

public EnvironmentConfig()

EnvironmentConfig(EnvironmentConfig)

public EnvironmentConfig(EnvironmentConfig other)

Parameter
Name	Description
`other`	`EnvironmentConfig`

Properties

AirflowByoidUri

public string AirflowByoidUri { get; set; }

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

Property Value
Type	Description
`string`

AirflowUri

public string AirflowUri { get; set; }

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

Property Value
Type	Description
`string`

DagGcsPrefix

public string DagGcsPrefix { get; set; }

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.

Property Value
Type	Description
`string`

DataRetentionConfig

public DataRetentionConfig DataRetentionConfig { get; set; }

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

Property Value
Type	Description
`DataRetentionConfig`

DatabaseConfig

public DatabaseConfig DatabaseConfig { get; set; }

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

Property Value
Type	Description
`DatabaseConfig`

EncryptionConfig

public EncryptionConfig EncryptionConfig { get; set; }

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

Property Value
Type	Description
`EncryptionConfig`

EnvironmentSize

public EnvironmentConfig.Types.EnvironmentSize EnvironmentSize { get; set; }

Optional. The size of the Cloud Composer environment.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

Property Value
Type	Description
`EnvironmentConfigTypesEnvironmentSize`

GkeCluster

public string GkeCluster { get; set; }

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

Property Value
Type	Description
`string`

MaintenanceWindow

public MaintenanceWindow MaintenanceWindow { get; set; }

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.

Property Value
Type	Description
`MaintenanceWindow`

MasterAuthorizedNetworksConfig

public MasterAuthorizedNetworksConfig MasterAuthorizedNetworksConfig { get; set; }

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.

Property Value
Type	Description
`MasterAuthorizedNetworksConfig`

NodeConfig

public NodeConfig NodeConfig { get; set; }

The configuration used for the Kubernetes Engine cluster.

Property Value
Type	Description
`NodeConfig`

NodeCount

public int NodeCount { get; set; }

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

Property Value
Type	Description
`int`

PrivateEnvironmentConfig

public PrivateEnvironmentConfig PrivateEnvironmentConfig { get; set; }

The configuration used for the Private IP Cloud Composer environment.

Property Value
Type	Description
`PrivateEnvironmentConfig`

RecoveryConfig

public RecoveryConfig RecoveryConfig { get; set; }

Optional. The Recovery settings configuration of an environment.

This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.

Property Value
Type	Description
`RecoveryConfig`

ResilienceMode

public EnvironmentConfig.Types.ResilienceMode ResilienceMode { get; set; }

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.

Property Value
Type	Description
`EnvironmentConfigTypesResilienceMode`

SoftwareConfig

public SoftwareConfig SoftwareConfig { get; set; }

The configuration settings for software inside the environment.

Property Value
Type	Description
`SoftwareConfig`

WebServerConfig

public WebServerConfig WebServerConfig { get; set; }

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

Property Value
Type	Description
`WebServerConfig`

WebServerNetworkAccessControl

public WebServerNetworkAccessControl WebServerNetworkAccessControl { get; set; }

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

Property Value
Type	Description
`WebServerNetworkAccessControl`

WorkloadsConfig

public WorkloadsConfig WorkloadsConfig { get; set; }

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.

Property Value
Type	Description
`WorkloadsConfig`