Google Cloud Classic v8.10.2 published on Tuesday, Dec 10, 2024 by Pulumi
gcp.composer.getEnvironment
Explore with Pulumi AI
Provides access to Cloud Composer environment configuration in a region for a given project.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const composerEnvEnvironment = new gcp.composer.Environment("composer_env", {name: "composer-environment"});
const composerEnv = gcp.composer.getEnvironment({
name: test.name,
});
export const debug = composerEnv.then(composerEnv => composerEnv.configs);
import pulumi
import pulumi_gcp as gcp
composer_env_environment = gcp.composer.Environment("composer_env", name="composer-environment")
composer_env = gcp.composer.get_environment(name=test["name"])
pulumi.export("debug", composer_env.configs)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/composer"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := composer.NewEnvironment(ctx, "composer_env", &composer.EnvironmentArgs{
Name: pulumi.String("composer-environment"),
})
if err != nil {
return err
}
composerEnv, err := composer.LookupEnvironment(ctx, &composer.LookupEnvironmentArgs{
Name: test.Name,
}, nil)
if err != nil {
return err
}
ctx.Export("debug", composerEnv.Configs)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var composerEnvEnvironment = new Gcp.Composer.Environment("composer_env", new()
{
Name = "composer-environment",
});
var composerEnv = Gcp.Composer.GetEnvironment.Invoke(new()
{
Name = test.Name,
});
return new Dictionary<string, object?>
{
["debug"] = composerEnv.Apply(getEnvironmentResult => getEnvironmentResult.Configs),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.composer.Environment;
import com.pulumi.gcp.composer.EnvironmentArgs;
import com.pulumi.gcp.composer.ComposerFunctions;
import com.pulumi.gcp.composer.inputs.GetEnvironmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var composerEnvEnvironment = new Environment("composerEnvEnvironment", EnvironmentArgs.builder()
.name("composer-environment")
.build());
final var composerEnv = ComposerFunctions.getEnvironment(GetEnvironmentArgs.builder()
.name(test.name())
.build());
ctx.export("debug", composerEnv.applyValue(getEnvironmentResult -> getEnvironmentResult.configs()));
}
}
resources:
composerEnvEnvironment:
type: gcp:composer:Environment
name: composer_env
properties:
name: composer-environment
variables:
composerEnv:
fn::invoke:
function: gcp:composer:getEnvironment
arguments:
name: ${test.name}
outputs:
debug: ${composerEnv.configs}
Using getEnvironment
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
def get_environment(name: Optional[str] = None,
project: Optional[str] = None,
region: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(name: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
> Note: This function is named LookupEnvironment
in the Go SDK.
public static class GetEnvironment
{
public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: gcp:composer/getEnvironment:getEnvironment
arguments:
# arguments dictionary
The following arguments are supported:
getEnvironment Result
The following output properties are available:
- Configs
List<Get
Environment Config> - Configuration parameters for the environment.
- Effective
Labels Dictionary<string, string> - Id string
- The provider-assigned unique ID for this managed resource.
- Labels Dictionary<string, string>
- Name string
- Pulumi
Labels Dictionary<string, string> - Storage
Configs List<GetEnvironment Storage Config> - Project string
- Region string
- Configs
[]Get
Environment Config - Configuration parameters for the environment.
- Effective
Labels map[string]string - Id string
- The provider-assigned unique ID for this managed resource.
- Labels map[string]string
- Name string
- Pulumi
Labels map[string]string - Storage
Configs []GetEnvironment Storage Config - Project string
- Region string
- configs
List<Get
Environment Config> - Configuration parameters for the environment.
- effective
Labels Map<String,String> - id String
- The provider-assigned unique ID for this managed resource.
- labels Map<String,String>
- name String
- pulumi
Labels Map<String,String> - storage
Configs List<GetEnvironment Storage Config> - project String
- region String
- configs
Get
Environment Config[] - Configuration parameters for the environment.
- effective
Labels {[key: string]: string} - id string
- The provider-assigned unique ID for this managed resource.
- labels {[key: string]: string}
- name string
- pulumi
Labels {[key: string]: string} - storage
Configs GetEnvironment Storage Config[] - project string
- region string
- configs
Sequence[Get
Environment Config] - Configuration parameters for the environment.
- effective_
labels Mapping[str, str] - id str
- The provider-assigned unique ID for this managed resource.
- labels Mapping[str, str]
- name str
- pulumi_
labels Mapping[str, str] - storage_
configs Sequence[GetEnvironment Storage Config] - project str
- region str
- configs List<Property Map>
- Configuration parameters for the environment.
- effective
Labels Map<String> - id String
- The provider-assigned unique ID for this managed resource.
- labels Map<String>
- name String
- pulumi
Labels Map<String> - storage
Configs List<Property Map> - project String
- region String
Supporting Types
GetEnvironmentConfig
- Airflow
Uri string - The URI of the Apache Airflow Web UI hosted within the environment.
- Dag
Gcs stringPrefix - The Cloud Storage prefix of the DAGs for the environment.
- Data
Retention List<GetConfigs Environment Config Data Retention Config> - 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
- Database
Configs List<GetEnvironment Config Database Config> - 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-..*.
- Enable
Private boolBuilds Only - 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.
- Enable
Private boolEnvironment - Optional. If true, a private Composer environment will be created.
- Encryption
Configs List<GetEnvironment Config Encryption Config> - The encryption options for the Composer environment and its dependencies.
- Environment
Size string - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Gke
Cluster string - The Kubernetes Engine cluster used to run the environment.
- Maintenance
Windows List<GetEnvironment Config Maintenance Window> - The configuration for Cloud Composer maintenance window.
- List<Get
Environment Config Master Authorized Networks Config> - 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.
- Node
Configs List<GetEnvironment Config Node Config> - The configuration used for the Kubernetes Engine cluster.
- Node
Count 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-..*.
- Private
Environment List<GetConfigs Environment Config Private Environment Config> - The configuration used for the Private IP Cloud Composer environment.
- Recovery
Configs List<GetEnvironment Config Recovery Config> - The recovery configuration settings for the Cloud Composer environment
- Resilience
Mode 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.
- Software
Configs List<GetEnvironment Config Software Config> - The configuration settings for software inside the environment.
- Web
Server List<GetConfigs Environment Config Web Server Config> - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Web
Server List<GetNetwork Access Controls Environment Config Web Server Network Access Control> - Network-level access control policy for the Airflow web server.
- Workloads
Configs List<GetEnvironment Config Workloads Config> - 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.
- Airflow
Uri string - The URI of the Apache Airflow Web UI hosted within the environment.
- Dag
Gcs stringPrefix - The Cloud Storage prefix of the DAGs for the environment.
- Data
Retention []GetConfigs Environment Config Data Retention Config - 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
- Database
Configs []GetEnvironment Config Database Config - 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-..*.
- Enable
Private boolBuilds Only - 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.
- Enable
Private boolEnvironment - Optional. If true, a private Composer environment will be created.
- Encryption
Configs []GetEnvironment Config Encryption Config - The encryption options for the Composer environment and its dependencies.
- Environment
Size string - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Gke
Cluster string - The Kubernetes Engine cluster used to run the environment.
- Maintenance
Windows []GetEnvironment Config Maintenance Window - The configuration for Cloud Composer maintenance window.
- []Get
Environment Config Master Authorized Networks Config - 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.
- Node
Configs []GetEnvironment Config Node Config - The configuration used for the Kubernetes Engine cluster.
- Node
Count 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-..*.
- Private
Environment []GetConfigs Environment Config Private Environment Config - The configuration used for the Private IP Cloud Composer environment.
- Recovery
Configs []GetEnvironment Config Recovery Config - The recovery configuration settings for the Cloud Composer environment
- Resilience
Mode 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.
- Software
Configs []GetEnvironment Config Software Config - The configuration settings for software inside the environment.
- Web
Server []GetConfigs Environment Config Web Server Config - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Web
Server []GetNetwork Access Controls Environment Config Web Server Network Access Control - Network-level access control policy for the Airflow web server.
- Workloads
Configs []GetEnvironment Config Workloads Config - 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.
- airflow
Uri String - The URI of the Apache Airflow Web UI hosted within the environment.
- dag
Gcs StringPrefix - The Cloud Storage prefix of the DAGs for the environment.
- data
Retention List<GetConfigs Environment Config Data Retention Config> - 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
- database
Configs List<GetEnvironment Config Database Config> - 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-..*.
- enable
Private BooleanBuilds Only - 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.
- enable
Private BooleanEnvironment - Optional. If true, a private Composer environment will be created.
- encryption
Configs List<GetEnvironment Config Encryption Config> - The encryption options for the Composer environment and its dependencies.
- environment
Size String - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- gke
Cluster String - The Kubernetes Engine cluster used to run the environment.
- maintenance
Windows List<GetEnvironment Config Maintenance Window> - The configuration for Cloud Composer maintenance window.
- List<Get
Environment Config Master Authorized Networks Config> - 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.
- node
Configs List<GetEnvironment Config Node Config> - The configuration used for the Kubernetes Engine cluster.
- node
Count Integer - 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-..*.
- private
Environment List<GetConfigs Environment Config Private Environment Config> - The configuration used for the Private IP Cloud Composer environment.
- recovery
Configs List<GetEnvironment Config Recovery Config> - The recovery configuration settings for the Cloud Composer environment
- resilience
Mode 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.
- software
Configs List<GetEnvironment Config Software Config> - The configuration settings for software inside the environment.
- web
Server List<GetConfigs Environment Config Web Server Config> - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- web
Server List<GetNetwork Access Controls Environment Config Web Server Network Access Control> - Network-level access control policy for the Airflow web server.
- workloads
Configs List<GetEnvironment Config Workloads Config> - 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.
- airflow
Uri string - The URI of the Apache Airflow Web UI hosted within the environment.
- dag
Gcs stringPrefix - The Cloud Storage prefix of the DAGs for the environment.
- data
Retention GetConfigs Environment Config Data Retention Config[] - 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
- database
Configs GetEnvironment Config Database Config[] - 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-..*.
- enable
Private booleanBuilds Only - 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.
- enable
Private booleanEnvironment - Optional. If true, a private Composer environment will be created.
- encryption
Configs GetEnvironment Config Encryption Config[] - The encryption options for the Composer environment and its dependencies.
- environment
Size string - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- gke
Cluster string - The Kubernetes Engine cluster used to run the environment.
- maintenance
Windows GetEnvironment Config Maintenance Window[] - The configuration for Cloud Composer maintenance window.
- Get
Environment Config Master Authorized Networks Config[] - 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.
- node
Configs GetEnvironment Config Node Config[] - The configuration used for the Kubernetes Engine cluster.
- node
Count number - 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-..*.
- private
Environment GetConfigs Environment Config Private Environment Config[] - The configuration used for the Private IP Cloud Composer environment.
- recovery
Configs GetEnvironment Config Recovery Config[] - The recovery configuration settings for the Cloud Composer environment
- resilience
Mode 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.
- software
Configs GetEnvironment Config Software Config[] - The configuration settings for software inside the environment.
- web
Server GetConfigs Environment Config Web Server Config[] - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- web
Server GetNetwork Access Controls Environment Config Web Server Network Access Control[] - Network-level access control policy for the Airflow web server.
- workloads
Configs GetEnvironment Config Workloads Config[] - 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.
- airflow_
uri str - The URI of the Apache Airflow Web UI hosted within the environment.
- dag_
gcs_ strprefix - The Cloud Storage prefix of the DAGs for the environment.
- data_
retention_ Sequence[Getconfigs Environment Config Data Retention Config] - 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
- database_
configs Sequence[GetEnvironment Config Database Config] - 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-..*.
- enable_
private_ boolbuilds_ only - 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.
- enable_
private_ boolenvironment - Optional. If true, a private Composer environment will be created.
- encryption_
configs Sequence[GetEnvironment Config Encryption Config] - The encryption options for the Composer environment and its dependencies.
- environment_
size str - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- gke_
cluster str - The Kubernetes Engine cluster used to run the environment.
- maintenance_
windows Sequence[GetEnvironment Config Maintenance Window] - The configuration for Cloud Composer maintenance window.
- Sequence[Get
Environment Config Master Authorized Networks Config] - 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.
- node_
configs Sequence[GetEnvironment Config Node Config] - The configuration used for the Kubernetes Engine cluster.
- node_
count 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-..*.
- private_
environment_ Sequence[Getconfigs Environment Config Private Environment Config] - The configuration used for the Private IP Cloud Composer environment.
- recovery_
configs Sequence[GetEnvironment Config Recovery Config] - The recovery configuration settings for the Cloud Composer environment
- resilience_
mode str - Whether high resilience is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.1.15-airflow-..* and newer.
- software_
configs Sequence[GetEnvironment Config Software Config] - The configuration settings for software inside the environment.
- web_
server_ Sequence[Getconfigs Environment Config Web Server Config] - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- web_
server_ Sequence[Getnetwork_ access_ controls Environment Config Web Server Network Access Control] - Network-level access control policy for the Airflow web server.
- workloads_
configs Sequence[GetEnvironment Config Workloads Config] - 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.
- airflow
Uri String - The URI of the Apache Airflow Web UI hosted within the environment.
- dag
Gcs StringPrefix - The Cloud Storage prefix of the DAGs for the environment.
- data
Retention List<Property Map>Configs - 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
- database
Configs List<Property Map> - 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-..*.
- enable
Private BooleanBuilds Only - 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.
- enable
Private BooleanEnvironment - Optional. If true, a private Composer environment will be created.
- encryption
Configs List<Property Map> - The encryption options for the Composer environment and its dependencies.
- environment
Size String - The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- gke
Cluster String - The Kubernetes Engine cluster used to run the environment.
- maintenance
Windows List<Property Map> - The configuration for Cloud Composer maintenance window.
- List<Property Map>
- 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.
- node
Configs List<Property Map> - The configuration used for the Kubernetes Engine cluster.
- node
Count Number - 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-..*.
- private
Environment List<Property Map>Configs - The configuration used for the Private IP Cloud Composer environment.
- recovery
Configs List<Property Map> - The recovery configuration settings for the Cloud Composer environment
- resilience
Mode 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.
- software
Configs List<Property Map> - The configuration settings for software inside the environment.
- web
Server List<Property Map>Configs - The configuration settings for the Airflow web server App Engine instance. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- web
Server List<Property Map>Network Access Controls - Network-level access control policy for the Airflow web server.
- workloads
Configs List<Property Map> - 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.
GetEnvironmentConfigDataRetentionConfig
- Task
Logs List<GetRetention Configs Environment Config Data Retention Config Task Logs Retention Config> - Optional. The configuration setting for Task Logs.
- Task
Logs []GetRetention Configs Environment Config Data Retention Config Task Logs Retention Config - Optional. The configuration setting for Task Logs.
- task
Logs List<GetRetention Configs Environment Config Data Retention Config Task Logs Retention Config> - Optional. The configuration setting for Task Logs.
- task
Logs GetRetention Configs Environment Config Data Retention Config Task Logs Retention Config[] - Optional. The configuration setting for Task Logs.
- task_
logs_ Sequence[Getretention_ configs Environment Config Data Retention Config Task Logs Retention Config] - Optional. The configuration setting for Task Logs.
- task
Logs List<Property Map>Retention Configs - Optional. The configuration setting for Task Logs.
GetEnvironmentConfigDataRetentionConfigTaskLogsRetentionConfig
- Storage
Mode string - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
- Storage
Mode string - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
- storage
Mode String - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
- storage
Mode string - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
- storage_
mode str - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
- storage
Mode String - Whether logs in cloud logging only is enabled or not. This field is supported for Cloud Composer environments in versions composer-2.0.32-airflow-2.1.4 and newer.
GetEnvironmentConfigDatabaseConfig
- Machine
Type string - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- Zone string
- Optional. Cloud SQL database preferred zone.
- Machine
Type string - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- Zone string
- Optional. Cloud SQL database preferred zone.
- machine
Type String - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- zone String
- Optional. Cloud SQL database preferred zone.
- machine
Type string - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- zone string
- Optional. Cloud SQL database preferred zone.
- machine_
type str - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- zone str
- Optional. Cloud SQL database preferred zone.
- machine
Type String - Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used.
- zone String
- Optional. Cloud SQL database preferred zone.
GetEnvironmentConfigEncryptionConfig
- Kms
Key stringName - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
- Kms
Key stringName - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
- kms
Key StringName - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
- kms
Key stringName - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
- kms_
key_ strname - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
- kms
Key StringName - Optional. Customer-managed Encryption Key available through Google's Key Management Service. Cannot be updated.
GetEnvironmentConfigMaintenanceWindow
- End
Time string - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- Recurrence string
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- Start
Time string - Start time of the first recurrence of the maintenance window.
- End
Time string - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- Recurrence string
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- Start
Time string - Start time of the first recurrence of the maintenance window.
- end
Time String - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- recurrence String
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- start
Time String - Start time of the first recurrence of the maintenance window.
- end
Time string - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- recurrence string
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- start
Time string - Start time of the first recurrence of the maintenance window.
- end_
time str - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- recurrence str
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- start_
time str - Start time of the first recurrence of the maintenance window.
- end
Time String - Maintenance window end time. It is used only to calculate the duration of the maintenance window. The value for end-time must be in the future, relative to 'start_time'.
- recurrence String
- Maintenance window recurrence. Format is a subset of RFC-5545 (https://tools.ietf.org/html/rfc5545) 'RRULE'. The only allowed values for 'FREQ' field are 'FREQ=DAILY' and 'FREQ=WEEKLY;BYDAY=...'. Example values: 'FREQ=WEEKLY;BYDAY=TU,WE', 'FREQ=DAILY'.
- start
Time String - Start time of the first recurrence of the maintenance window.
GetEnvironmentConfigMasterAuthorizedNetworksConfig
- Cidr
Blocks List<GetEnvironment Config Master Authorized Networks Config Cidr Block> - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- Enabled bool
- Whether or not master authorized networks is enabled.
- Cidr
Blocks []GetEnvironment Config Master Authorized Networks Config Cidr Block - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- Enabled bool
- Whether or not master authorized networks is enabled.
- cidr
Blocks List<GetEnvironment Config Master Authorized Networks Config Cidr Block> - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- enabled Boolean
- Whether or not master authorized networks is enabled.
- cidr
Blocks GetEnvironment Config Master Authorized Networks Config Cidr Block[] - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- enabled boolean
- Whether or not master authorized networks is enabled.
- cidr_
blocks Sequence[GetEnvironment Config Master Authorized Networks Config Cidr Block] - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- enabled bool
- Whether or not master authorized networks is enabled.
- cidr
Blocks List<Property Map> - cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
- enabled Boolean
- Whether or not master authorized networks is enabled.
GetEnvironmentConfigMasterAuthorizedNetworksConfigCidrBlock
- Cidr
Block string - cidr_block must be specified in CIDR notation.
- Display
Name string - display_name is a field for users to identify CIDR blocks.
- Cidr
Block string - cidr_block must be specified in CIDR notation.
- Display
Name string - display_name is a field for users to identify CIDR blocks.
- cidr
Block String - cidr_block must be specified in CIDR notation.
- display
Name String - display_name is a field for users to identify CIDR blocks.
- cidr
Block string - cidr_block must be specified in CIDR notation.
- display
Name string - display_name is a field for users to identify CIDR blocks.
- cidr_
block str - cidr_block must be specified in CIDR notation.
- display_
name str - display_name is a field for users to identify CIDR blocks.
- cidr
Block String - cidr_block must be specified in CIDR notation.
- display
Name String - display_name is a field for users to identify CIDR blocks.
GetEnvironmentConfigNodeConfig
- Composer
Internal stringIpv4Cidr Block - IPv4 cidr range that will be used by Composer internal components.
- Composer
Network stringAttachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- Disk
Size intGb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Enable
Ip boolMasq Agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- Ip
Allocation List<GetPolicies Environment Config Node Config Ip Allocation Policy> - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- Machine
Type string - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Max
Pods intPer Node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Network string
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- Oauth
Scopes List<string> - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Service
Account string - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- Subnetwork string
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- List<string>
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- Zone string
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Composer
Internal stringIpv4Cidr Block - IPv4 cidr range that will be used by Composer internal components.
- Composer
Network stringAttachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- Disk
Size intGb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Enable
Ip boolMasq Agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- Ip
Allocation []GetPolicies Environment Config Node Config Ip Allocation Policy - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- Machine
Type string - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Max
Pods intPer Node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Network string
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- Oauth
Scopes []string - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Service
Account string - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- Subnetwork string
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- []string
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- Zone string
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- composer
Internal StringIpv4Cidr Block - IPv4 cidr range that will be used by Composer internal components.
- composer
Network StringAttachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- disk
Size IntegerGb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Ip BooleanMasq Agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- ip
Allocation List<GetPolicies Environment Config Node Config Ip Allocation Policy> - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- machine
Type String - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- max
Pods IntegerPer Node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- network String
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- oauth
Scopes List<String> - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- service
Account String - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- subnetwork String
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- List<String>
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- zone String
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- composer
Internal stringIpv4Cidr Block - IPv4 cidr range that will be used by Composer internal components.
- composer
Network stringAttachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- disk
Size numberGb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Ip booleanMasq Agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- ip
Allocation GetPolicies Environment Config Node Config Ip Allocation Policy[] - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- machine
Type string - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- max
Pods numberPer Node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- network string
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- oauth
Scopes string[] - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- service
Account string - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- subnetwork string
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- string[]
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- zone string
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- composer_
internal_ stripv4_ cidr_ block - IPv4 cidr range that will be used by Composer internal components.
- composer_
network_ strattachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- disk_
size_ intgb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable_
ip_ boolmasq_ agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- ip_
allocation_ Sequence[Getpolicies Environment Config Node Config Ip Allocation Policy] - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- machine_
type str - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- max_
pods_ intper_ node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- network str
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- oauth_
scopes Sequence[str] - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- service_
account str - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- subnetwork str
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- Sequence[str]
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- zone str
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- composer
Internal StringIpv4Cidr Block - IPv4 cidr range that will be used by Composer internal components.
- composer
Network StringAttachment - PSC (Private Service Connect) Network entry point. Customers can pre-create the Network Attachment and point Cloud Composer environment to use. It is possible to share network attachment among many environments, provided enough IP addresses are available.
- disk
Size NumberGb - The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Ip BooleanMasq Agent - Deploys 'ip-masq-agent' daemon set in the GKE cluster and defines nonMasqueradeCIDRs equals to pod IP range so IP masquerading is used for all destination addresses, except between pods traffic. See: https://cloud.google.com/kubernetes-engine/docs/how-to/ip-masquerade-agent
- ip
Allocation List<Property Map>Policies - Configuration for controlling how IPs are allocated in the GKE cluster. Cannot be updated.
- machine
Type String - The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- max
Pods NumberPer Node - The maximum pods per node in the GKE cluster allocated during environment creation. Lowering this value reduces IP address consumption by the Cloud Composer Kubernetes cluster. This value can only be set during environment creation, and only if the environment is VPC-Native. The range of possible values is 8-110, and the default is 32. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- network String
- The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: "projects/{project}/zones/{zone}/machineTypes/{machineType}". Must belong to the enclosing environment's project and region/zone. The network must belong to the environment's project. If unspecified, the "default" network ID in the environment's project is used. If a Custom Subnet Network is provided, subnetwork must also be provided.
- oauth
Scopes List<String> - The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- service
Account String - The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the "default" Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.
- subnetwork String
- The Compute Engine subnetwork to be used for machine communications, specified as a self-link, relative resource name (e.g. "projects/{project}/regions/{region}/subnetworks/{subnetwork}"), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment's project and region.
- List<String>
- The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.
- zone String
- The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. "projects/{project}/zones/{zone}"). Must belong to the enclosing environment's project and region. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
GetEnvironmentConfigNodeConfigIpAllocationPolicy
- Cluster
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- Cluster
Secondary stringRange Name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- Services
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- Services
Secondary stringRange Name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- Use
Ip boolAliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- Cluster
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- Cluster
Secondary stringRange Name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- Services
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- Services
Secondary stringRange Name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- Use
Ip boolAliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- cluster
Ipv4Cidr StringBlock - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- cluster
Secondary StringRange Name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- services
Ipv4Cidr StringBlock - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- services
Secondary StringRange Name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- use
Ip BooleanAliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- cluster
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- cluster
Secondary stringRange Name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- services
Ipv4Cidr stringBlock - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- services
Secondary stringRange Name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- use
Ip booleanAliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- cluster_
ipv4_ strcidr_ block - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- cluster_
secondary_ strrange_ name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- services_
ipv4_ strcidr_ block - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- services_
secondary_ strrange_ name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- use_
ip_ boolaliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
- cluster
Ipv4Cidr StringBlock - The IP address range used to allocate IP addresses to pods in the cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both.
- cluster
Secondary StringRange Name - The name of the cluster's secondary range used to allocate IP addresses to pods. Specify either cluster_secondary_range_name or cluster_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- services
Ipv4Cidr StringBlock - The IP address range used to allocate IP addresses in this cluster. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both.
- services
Secondary StringRange Name - The name of the services' secondary range used to allocate IP addresses to the cluster. Specify either services_secondary_range_name or services_ipv4_cidr_block but not both. For Cloud Composer environments in versions composer-1..-airflow-..*, this field is applicable only when use_ip_aliases is true.
- use
Ip BooleanAliases - Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ip_allocation_policy block is present in config. This field is only supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use VPC-native GKE clusters.
GetEnvironmentConfigPrivateEnvironmentConfig
- Cloud
Composer stringConnection Subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Cloud
Composer stringNetwork Ipv4Cidr Block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Cloud
Sql stringIpv4Cidr Block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- Connection
Type string - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- Enable
Private boolEndpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- Enable
Privately boolUsed Public Ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- Master
Ipv4Cidr stringBlock - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- Web
Server stringIpv4Cidr Block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- Cloud
Composer stringConnection Subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Cloud
Composer stringNetwork Ipv4Cidr Block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- Cloud
Sql stringIpv4Cidr Block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- Connection
Type string - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- Enable
Private boolEndpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- Enable
Privately boolUsed Public Ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- Master
Ipv4Cidr stringBlock - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- Web
Server stringIpv4Cidr Block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- cloud
Composer StringConnection Subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Composer StringNetwork Ipv4Cidr Block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Sql StringIpv4Cidr Block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- connection
Type String - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- enable
Private BooleanEndpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Privately BooleanUsed Public Ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- master
Ipv4Cidr StringBlock - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- web
Server StringIpv4Cidr Block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- cloud
Composer stringConnection Subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Composer stringNetwork Ipv4Cidr Block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Sql stringIpv4Cidr Block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- connection
Type string - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- enable
Private booleanEndpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Privately booleanUsed Public Ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- master
Ipv4Cidr stringBlock - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- web
Server stringIpv4Cidr Block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- cloud_
composer_ strconnection_ subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud_
composer_ strnetwork_ ipv4_ cidr_ block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud_
sql_ stripv4_ cidr_ block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- connection_
type str - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- enable_
private_ boolendpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable_
privately_ boolused_ public_ ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- master_
ipv4_ strcidr_ block - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- web_
server_ stripv4_ cidr_ block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
- cloud
Composer StringConnection Subnetwork - When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Composer StringNetwork Ipv4Cidr Block - The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
- cloud
Sql StringIpv4Cidr Block - The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block.
- connection
Type String - Mode of internal communication within the Composer environment. Must be one of "VPC_PEERING" or "PRIVATE_SERVICE_CONNECT".
- enable
Private BooleanEndpoint - If true, access to the public endpoint of the GKE cluster is denied. If this field is set to true, ip_allocation_policy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*.
- enable
Privately BooleanUsed Public Ips - When enabled, IPs from public (non-RFC1918) ranges can be used for ip_allocation_policy.cluster_ipv4_cidr_block and ip_allocation_policy.service_ipv4_cidr_block.
- master
Ipv4Cidr StringBlock - The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster's network. If left blank, the default value of '172.16.0.0/28' is used.
- web
Server StringIpv4Cidr Block - The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*.
GetEnvironmentConfigRecoveryConfig
- Scheduled
Snapshots List<GetConfigs Environment Config Recovery Config Scheduled Snapshots Config> - The configuration settings for scheduled snapshots.
- Scheduled
Snapshots []GetConfigs Environment Config Recovery Config Scheduled Snapshots Config - The configuration settings for scheduled snapshots.
- scheduled
Snapshots List<GetConfigs Environment Config Recovery Config Scheduled Snapshots Config> - The configuration settings for scheduled snapshots.
- scheduled
Snapshots GetConfigs Environment Config Recovery Config Scheduled Snapshots Config[] - The configuration settings for scheduled snapshots.
- scheduled_
snapshots_ Sequence[Getconfigs Environment Config Recovery Config Scheduled Snapshots Config] - The configuration settings for scheduled snapshots.
- scheduled
Snapshots List<Property Map>Configs - The configuration settings for scheduled snapshots.
GetEnvironmentConfigRecoveryConfigScheduledSnapshotsConfig
- Enabled bool
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- Snapshot
Creation stringSchedule - Snapshot schedule, in the unix-cron format.
- Snapshot
Location string - the URI of a bucket folder where to save the snapshot.
- Time
Zone string - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
- Enabled bool
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- Snapshot
Creation stringSchedule - Snapshot schedule, in the unix-cron format.
- Snapshot
Location string - the URI of a bucket folder where to save the snapshot.
- Time
Zone string - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
- enabled Boolean
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- snapshot
Creation StringSchedule - Snapshot schedule, in the unix-cron format.
- snapshot
Location String - the URI of a bucket folder where to save the snapshot.
- time
Zone String - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
- enabled boolean
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- snapshot
Creation stringSchedule - Snapshot schedule, in the unix-cron format.
- snapshot
Location string - the URI of a bucket folder where to save the snapshot.
- time
Zone string - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
- enabled bool
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- snapshot_
creation_ strschedule - Snapshot schedule, in the unix-cron format.
- snapshot_
location str - the URI of a bucket folder where to save the snapshot.
- time_
zone str - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
- enabled Boolean
- When enabled, Cloud Composer periodically saves snapshots of your environment to a Cloud Storage bucket.
- snapshot
Creation StringSchedule - Snapshot schedule, in the unix-cron format.
- snapshot
Location String - the URI of a bucket folder where to save the snapshot.
- time
Zone String - A time zone for the schedule. This value is a time offset and does not take into account daylight saving time changes. Valid values are from UTC-12 to UTC+12. Examples: UTC, UTC-01, UTC+03.
GetEnvironmentConfigSoftwareConfig
- Airflow
Config Dictionary<string, string>Overrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- Cloud
Data List<GetLineage Integrations Environment Config Software Config Cloud Data Lineage Integration> - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- Env
Variables Dictionary<string, string> - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- Image
Version string - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- Pypi
Packages Dictionary<string, string> - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- Python
Version string - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- Scheduler
Count int - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- Web
Server stringPlugins Mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
- Airflow
Config map[string]stringOverrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- Cloud
Data []GetLineage Integrations Environment Config Software Config Cloud Data Lineage Integration - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- Env
Variables map[string]string - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- Image
Version string - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- Pypi
Packages map[string]string - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- Python
Version string - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- Scheduler
Count int - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- Web
Server stringPlugins Mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
- airflow
Config Map<String,String>Overrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- cloud
Data List<GetLineage Integrations Environment Config Software Config Cloud Data Lineage Integration> - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- env
Variables Map<String,String> - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- image
Version String - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- pypi
Packages Map<String,String> - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- python
Version String - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- scheduler
Count Integer - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- web
Server StringPlugins Mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
- airflow
Config {[key: string]: string}Overrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- cloud
Data GetLineage Integrations Environment Config Software Config Cloud Data Lineage Integration[] - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- env
Variables {[key: string]: string} - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- image
Version string - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- pypi
Packages {[key: string]: string} - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- python
Version string - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- scheduler
Count number - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- web
Server stringPlugins Mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
- airflow_
config_ Mapping[str, str]overrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- cloud_
data_ Sequence[Getlineage_ integrations Environment Config Software Config Cloud Data Lineage Integration] - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- env_
variables Mapping[str, str] - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- image_
version str - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- pypi_
packages Mapping[str, str] - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- python_
version str - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- scheduler_
count int - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- web_
server_ strplugins_ mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
- airflow
Config Map<String>Overrides - Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and cannot contain "=" or ";". Section and property names cannot contain characters: "." Apache Airflow configuration property names must be written in snake_case. Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are blacklisted, and cannot be overridden.
- cloud
Data List<Property Map>Lineage Integrations - The configuration for Cloud Data Lineage integration. Supported for Cloud Composer environments in versions composer-2.1.2-airflow-..* and newer
- env
Variables Map<String> - Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names: AIRFLOW_HOME C_FORCE_ROOT CONTAINER_NAME DAGS_FOLDER GCP_PROJECT GCS_BUCKET GKE_CLUSTER_NAME SQL_DATABASE SQL_INSTANCE SQL_PASSWORD SQL_PROJECT SQL_REGION SQL_USER.
- image
Version String - The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-([0-9]+(.[0-9]+.[0-9]+(-preview.[0-9]+)?)?|latest)-airflow-([0-9]+(.[0-9]+(.[0-9]+)?)?). The Cloud Composer portion of the image version is a full semantic version, or an alias in the form of major version number or 'latest'. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. See documentation for more details and version list.
- pypi
Packages Map<String> - Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. "numpy"). Values are the lowercase extras and version specifier (e.g. "==1.12.0", "[devel,gcp_api]", "[devel]>=1.8.2, <1.9.2"). To specify a package without pinning it to a version specifier, use the empty string as the value.
- python
Version String - The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to '2' or '3'. If not specified, the default is '2'. Cannot be updated. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Environments in newer versions always use Python major version 3.
- scheduler
Count Number - The number of schedulers for Airflow. This field is supported for Cloud Composer environments in versions composer-1..-airflow-2...
- web
Server StringPlugins Mode - Should be either 'ENABLED' or 'DISABLED'. Defaults to 'ENABLED'. Used in Composer 3.
GetEnvironmentConfigSoftwareConfigCloudDataLineageIntegration
- Enabled bool
- Whether or not Cloud Data Lineage integration is enabled.
- Enabled bool
- Whether or not Cloud Data Lineage integration is enabled.
- enabled Boolean
- Whether or not Cloud Data Lineage integration is enabled.
- enabled boolean
- Whether or not Cloud Data Lineage integration is enabled.
- enabled bool
- Whether or not Cloud Data Lineage integration is enabled.
- enabled Boolean
- Whether or not Cloud Data Lineage integration is enabled.
GetEnvironmentConfigWebServerConfig
- Machine
Type string - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
- Machine
Type string - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
- machine
Type String - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
- machine
Type string - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
- machine_
type str - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
- machine
Type String - Optional. Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1-webserver-4 or composer-n1-webserver-8. If not specified, composer-n1-webserver-2 will be used. Value custom is returned only in response, if Airflow web server parameters were manually changed to a non-standard values.
GetEnvironmentConfigWebServerNetworkAccessControl
- Allowed
Ip List<GetRanges Environment Config Web Server Network Access Control Allowed Ip Range> - A collection of allowed IP ranges with descriptions.
- Allowed
Ip []GetRanges Environment Config Web Server Network Access Control Allowed Ip Range - A collection of allowed IP ranges with descriptions.
- allowed
Ip List<GetRanges Environment Config Web Server Network Access Control Allowed Ip Range> - A collection of allowed IP ranges with descriptions.
- allowed
Ip GetRanges Environment Config Web Server Network Access Control Allowed Ip Range[] - A collection of allowed IP ranges with descriptions.
- allowed_
ip_ Sequence[Getranges Environment Config Web Server Network Access Control Allowed Ip Range] - A collection of allowed IP ranges with descriptions.
- allowed
Ip List<Property Map>Ranges - A collection of allowed IP ranges with descriptions.
GetEnvironmentConfigWebServerNetworkAccessControlAllowedIpRange
- Description string
- A description of this ip range.
- Value string
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
- Description string
- A description of this ip range.
- Value string
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
- description String
- A description of this ip range.
- value String
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
- description string
- A description of this ip range.
- value string
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
- description str
- A description of this ip range.
- value str
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
- description String
- A description of this ip range.
- value String
- IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.
GetEnvironmentConfigWorkloadsConfig
- Dag
Processors List<GetEnvironment Config Workloads Config Dag Processor> - Configuration for resources used by DAG processor.
- Schedulers
List<Get
Environment Config Workloads Config Scheduler> - Configuration for resources used by Airflow schedulers.
- Triggerers
List<Get
Environment Config Workloads Config Triggerer> - Configuration for resources used by Airflow triggerers.
- Web
Servers List<GetEnvironment Config Workloads Config Web Server> - Configuration for resources used by Airflow web server.
- Workers
List<Get
Environment Config Workloads Config Worker> - Configuration for resources used by Airflow workers.
- Dag
Processors []GetEnvironment Config Workloads Config Dag Processor - Configuration for resources used by DAG processor.
- Schedulers
[]Get
Environment Config Workloads Config Scheduler - Configuration for resources used by Airflow schedulers.
- Triggerers
[]Get
Environment Config Workloads Config Triggerer - Configuration for resources used by Airflow triggerers.
- Web
Servers []GetEnvironment Config Workloads Config Web Server - Configuration for resources used by Airflow web server.
- Workers
[]Get
Environment Config Workloads Config Worker - Configuration for resources used by Airflow workers.
- dag
Processors List<GetEnvironment Config Workloads Config Dag Processor> - Configuration for resources used by DAG processor.
- schedulers
List<Get
Environment Config Workloads Config Scheduler> - Configuration for resources used by Airflow schedulers.
- triggerers
List<Get
Environment Config Workloads Config Triggerer> - Configuration for resources used by Airflow triggerers.
- web
Servers List<GetEnvironment Config Workloads Config Web Server> - Configuration for resources used by Airflow web server.
- workers
List<Get
Environment Config Workloads Config Worker> - Configuration for resources used by Airflow workers.
- dag
Processors GetEnvironment Config Workloads Config Dag Processor[] - Configuration for resources used by DAG processor.
- schedulers
Get
Environment Config Workloads Config Scheduler[] - Configuration for resources used by Airflow schedulers.
- triggerers
Get
Environment Config Workloads Config Triggerer[] - Configuration for resources used by Airflow triggerers.
- web
Servers GetEnvironment Config Workloads Config Web Server[] - Configuration for resources used by Airflow web server.
- workers
Get
Environment Config Workloads Config Worker[] - Configuration for resources used by Airflow workers.
- dag_
processors Sequence[GetEnvironment Config Workloads Config Dag Processor] - Configuration for resources used by DAG processor.
- schedulers
Sequence[Get
Environment Config Workloads Config Scheduler] - Configuration for resources used by Airflow schedulers.
- triggerers
Sequence[Get
Environment Config Workloads Config Triggerer] - Configuration for resources used by Airflow triggerers.
- web_
servers Sequence[GetEnvironment Config Workloads Config Web Server] - Configuration for resources used by Airflow web server.
- workers
Sequence[Get
Environment Config Workloads Config Worker] - Configuration for resources used by Airflow workers.
- dag
Processors List<Property Map> - Configuration for resources used by DAG processor.
- schedulers List<Property Map>
- Configuration for resources used by Airflow schedulers.
- triggerers List<Property Map>
- Configuration for resources used by Airflow triggerers.
- web
Servers List<Property Map> - Configuration for resources used by Airflow web server.
- workers List<Property Map>
- Configuration for resources used by Airflow workers.
GetEnvironmentConfigWorkloadsConfigDagProcessor
- count int
- Number of DAG processors.
- cpu float
- CPU request and limit for DAG processor.
- memory_
gb float - Memory (GB) request and limit for DAG processor.
- storage_
gb float - Storage (GB) request and limit for DAG processor.
GetEnvironmentConfigWorkloadsConfigScheduler
- count int
- The number of schedulers.
- cpu float
- CPU request and limit for a single Airflow scheduler replica
- memory_
gb float - Memory (GB) request and limit for a single Airflow scheduler replica.
- storage_
gb float - Storage (GB) request and limit for a single Airflow scheduler replica.
GetEnvironmentConfigWorkloadsConfigTriggerer
GetEnvironmentConfigWorkloadsConfigWebServer
- cpu float
- CPU request and limit for Airflow web server.
- memory_
gb float - Memory (GB) request and limit for Airflow web server.
- storage_
gb float - Storage (GB) request and limit for Airflow web server.
GetEnvironmentConfigWorkloadsConfigWorker
- Cpu double
- CPU request and limit for a single Airflow worker replica.
- Max
Count int - Maximum number of workers for autoscaling.
- Memory
Gb double - Memory (GB) request and limit for a single Airflow worker replica.
- Min
Count int - Minimum number of workers for autoscaling.
- Storage
Gb double - Storage (GB) request and limit for a single Airflow worker replica.
- Cpu float64
- CPU request and limit for a single Airflow worker replica.
- Max
Count int - Maximum number of workers for autoscaling.
- Memory
Gb float64 - Memory (GB) request and limit for a single Airflow worker replica.
- Min
Count int - Minimum number of workers for autoscaling.
- Storage
Gb float64 - Storage (GB) request and limit for a single Airflow worker replica.
- cpu Double
- CPU request and limit for a single Airflow worker replica.
- max
Count Integer - Maximum number of workers for autoscaling.
- memory
Gb Double - Memory (GB) request and limit for a single Airflow worker replica.
- min
Count Integer - Minimum number of workers for autoscaling.
- storage
Gb Double - Storage (GB) request and limit for a single Airflow worker replica.
- cpu number
- CPU request and limit for a single Airflow worker replica.
- max
Count number - Maximum number of workers for autoscaling.
- memory
Gb number - Memory (GB) request and limit for a single Airflow worker replica.
- min
Count number - Minimum number of workers for autoscaling.
- storage
Gb number - Storage (GB) request and limit for a single Airflow worker replica.
- cpu float
- CPU request and limit for a single Airflow worker replica.
- max_
count int - Maximum number of workers for autoscaling.
- memory_
gb float - Memory (GB) request and limit for a single Airflow worker replica.
- min_
count int - Minimum number of workers for autoscaling.
- storage_
gb float - Storage (GB) request and limit for a single Airflow worker replica.
- cpu Number
- CPU request and limit for a single Airflow worker replica.
- max
Count Number - Maximum number of workers for autoscaling.
- memory
Gb Number - Memory (GB) request and limit for a single Airflow worker replica.
- min
Count Number - Minimum number of workers for autoscaling.
- storage
Gb Number - Storage (GB) request and limit for a single Airflow worker replica.
GetEnvironmentStorageConfig
- Bucket string
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
- Bucket string
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
- bucket String
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
- bucket string
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
- bucket str
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
- bucket String
- Optional. Name of an existing Cloud Storage bucket to be used by the environment.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.