composer

Documentation

Index

• type Environment
  • func GetEnvironment(ctx *pulumi.Context, name string, id pulumi.ID, state *EnvironmentState, ...) (*Environment, error)
  • func NewEnvironment(ctx *pulumi.Context, name string, args *EnvironmentArgs, ...) (*Environment, error)
  • func (r *Environment) Config() *pulumi.Output
  • func (r *Environment) ID() *pulumi.IDOutput
  • func (r *Environment) Labels() *pulumi.MapOutput
  • func (r *Environment) Name() *pulumi.StringOutput
  • func (r *Environment) Project() *pulumi.StringOutput
  • func (r *Environment) Region() *pulumi.StringOutput
  • func (r *Environment) URN() *pulumi.URNOutput
• type EnvironmentArgs
• type EnvironmentState

Types

type Environment

type Environment struct {
	// contains filtered or unexported fields
}

An environment for running orchestration tasks.

Environments run Apache Airflow software on Google infrastructure.

To get more information about Environments, see:

* [API documentation](https://cloud.google.com/composer/docs/reference/rest/) * How-to Guides

• [Official Documentation](https://cloud.google.com/composer/docs)
• [Configuring Shared VPC for Composer Environments](https://cloud.google.com/composer/docs/how-to/managing/configuring-shared-vpc)

* [Apache Airflow Documentation](http://airflow.apache.org/)

> **Warning:** We **STRONGLY** recommend you read the [GCP guides](https://cloud.google.com/composer/docs/how-to)

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,
Terraform 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 the Terraform 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](https://cloud.google.com/composer/docs/concepts/cloud-storage).

func GetEnvironment

func GetEnvironment(ctx *pulumi.Context,
	name string, id pulumi.ID, state *EnvironmentState, opts ...pulumi.ResourceOpt) (*Environment, error)

GetEnvironment gets an existing Environment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewEnvironment

func NewEnvironment(ctx *pulumi.Context,
	name string, args *EnvironmentArgs, opts ...pulumi.ResourceOpt) (*Environment, error)

NewEnvironment registers a new resource with the given unique name, arguments, and options.

func (*Environment) Config

func (r *Environment) Config() *pulumi.Output

func (*Environment) ID

func (r *Environment) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Environment) Labels

func (r *Environment) Labels() *pulumi.MapOutput

func (*Environment) Name

func (r *Environment) Name() *pulumi.StringOutput

func (*Environment) Project

func (r *Environment) Project() *pulumi.StringOutput

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

func (*Environment) Region

func (r *Environment) Region() *pulumi.StringOutput

func (*Environment) URN

func (r *Environment) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type EnvironmentArgs

type EnvironmentArgs struct {
	Config interface{}
	Labels interface{}
	Name   interface{}
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project interface{}
	Region  interface{}
}

The set of arguments for constructing a Environment resource.

type EnvironmentState

type EnvironmentState struct {
	Config interface{}
	Labels interface{}
	Name   interface{}
	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project interface{}
	Region  interface{}
}

Input properties used for looking up and filtering Environment resources.