composer

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.composer.AwaitableGetImageVersionsResult(image_versions=None, project=None, region=None, id=None)
class pulumi_gcp.composer.Environment(resource_name, opts=None, config=None, labels=None, name=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)

An environment for running orchestration tasks.

Environments run Apache Airflow software on Google infrastructure.

To get more information about Environments, see:

Warning: We STRONGLY recommend you read the GCP guides

as the Environment resource requires a long deployment process and involves several layers of GCP infrastructure, including a Kubernetes Engine cluster, Cloud Storage, and Compute networking resources. Due to limitations of the API, this provider will not be able to automatically find or manage many of these underlying resources. In particular:

  • It can take up to one hour to create or update an environment resource. In addition, GCP may only detect some errors in configuration when they are used (e.g. ~40-50 minutes into the creation process), and is prone to limited error reporting. If you encounter confusing or uninformative errors, please verify your configuration is valid against GCP Cloud Composer before filing bugs against this provider.

  • Environments create Google Cloud Storage buckets that do not get cleaned up automatically on environment deletion. More about Composer’s use of Cloud Storage.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The config object supports the following:

  • airflowUri (pulumi.Input[str])

  • dagGcsPrefix (pulumi.Input[str])

  • gkeCluster (pulumi.Input[str])

  • nodeConfig (pulumi.Input[dict])

    • diskSizeGb (pulumi.Input[float])

    • ipAllocationPolicy (pulumi.Input[dict])

      • clusterIpv4CidrBlock (pulumi.Input[str])

      • clusterSecondaryRangeName (pulumi.Input[str])

      • servicesIpv4CidrBlock (pulumi.Input[str])

      • servicesSecondaryRangeName (pulumi.Input[str])

      • useIpAliases (pulumi.Input[bool])

    • machineType (pulumi.Input[str])

    • network (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

    • serviceAccount (pulumi.Input[str])

    • subnetwork (pulumi.Input[str])

    • tags (pulumi.Input[list])

    • zone (pulumi.Input[str])

  • nodeCount (pulumi.Input[float])

  • privateEnvironmentConfig (pulumi.Input[dict])

    • enablePrivateEndpoint (pulumi.Input[bool])

    • masterIpv4CidrBlock (pulumi.Input[str])

  • softwareConfig (pulumi.Input[dict])

    • airflowConfigOverrides (pulumi.Input[dict])

    • envVariables (pulumi.Input[dict])

    • imageVersion (pulumi.Input[str])

    • pypiPackages (pulumi.Input[dict])

    • pythonVersion (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, config=None, labels=None, name=None, project=None, region=None)

Get an existing Environment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The config object supports the following:

  • airflowUri (pulumi.Input[str])

  • dagGcsPrefix (pulumi.Input[str])

  • gkeCluster (pulumi.Input[str])

  • nodeConfig (pulumi.Input[dict])

    • diskSizeGb (pulumi.Input[float])

    • ipAllocationPolicy (pulumi.Input[dict])

      • clusterIpv4CidrBlock (pulumi.Input[str])

      • clusterSecondaryRangeName (pulumi.Input[str])

      • servicesIpv4CidrBlock (pulumi.Input[str])

      • servicesSecondaryRangeName (pulumi.Input[str])

      • useIpAliases (pulumi.Input[bool])

    • machineType (pulumi.Input[str])

    • network (pulumi.Input[str])

    • oauthScopes (pulumi.Input[list])

    • serviceAccount (pulumi.Input[str])

    • subnetwork (pulumi.Input[str])

    • tags (pulumi.Input[list])

    • zone (pulumi.Input[str])

  • nodeCount (pulumi.Input[float])

  • privateEnvironmentConfig (pulumi.Input[dict])

    • enablePrivateEndpoint (pulumi.Input[bool])

    • masterIpv4CidrBlock (pulumi.Input[str])

  • softwareConfig (pulumi.Input[dict])

    • airflowConfigOverrides (pulumi.Input[dict])

    • envVariables (pulumi.Input[dict])

    • imageVersion (pulumi.Input[str])

    • pypiPackages (pulumi.Input[dict])

    • pythonVersion (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.composer.GetImageVersionsResult(image_versions=None, project=None, region=None, id=None)

A collection of values returned by getImageVersions.

image_versions = None

A list of composer image versions available in the given project and location. Each image_version contains:

id = None

id is the provider-assigned unique ID for this managed resource.

pulumi_gcp.composer.get_image_versions(project=None, region=None, opts=None)

Provides access to available Cloud Composer versions in a region for a given project.

Parameters
  • project (str) – The ID of the project to list versions in. If it is not provided, the provider project is used.

  • region (str) – The location to list versions in. If it is not provider, the provider region is used.