This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

datafusion

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.datafusion.Instance(resource_name, opts=None, description=None, enable_stackdriver_logging=None, enable_stackdriver_monitoring=None, labels=None, name=None, network_config=None, options=None, private_instance=None, project=None, region=None, type=None, __props__=None, __name__=None, __opts__=None)

Represents a Data Fusion instance.

To get more information about Instance, see:

import pulumi
import pulumi_gcp as gcp

basic_instance = gcp.datafusion.Instance("basicInstance",
    region="us-central1",
    type="BASIC")
import pulumi
import pulumi_gcp as gcp

extended_instance = gcp.datafusion.Instance("extendedInstance",
    description="My Data Fusion instance",
    enable_stackdriver_logging=True,
    enable_stackdriver_monitoring=True,
    labels={
        "example_key": "example_value",
    },
    network_config={
        "ipAllocation": "10.89.48.0/22",
        "network": "default",
    },
    private_instance=True,
    region="us-central1",
    type="BASIC")
Parameters
  • resource_name (str) – The name of the resource.

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

  • description (pulumi.Input[str]) – An optional description of the instance.

  • enable_stackdriver_logging (pulumi.Input[bool]) – Option to enable Stackdriver Logging.

  • enable_stackdriver_monitoring (pulumi.Input[bool]) – Option to enable Stackdriver Monitoring.

  • labels (pulumi.Input[dict]) – The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.

  • name (pulumi.Input[str]) – The ID of the instance or a fully qualified identifier for the instance.

  • network_config (pulumi.Input[dict]) – Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.

  • options (pulumi.Input[dict]) – Map of additional options used to configure the behavior of Data Fusion instance.

  • private_instance (pulumi.Input[bool]) – Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.

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

  • region (pulumi.Input[str]) – The region of the Data Fusion instance.

  • type (pulumi.Input[str]) – Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.

- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines
using point and click UI. However, there are certain limitations, such as fewer number
of concurrent pipelines, no support for streaming pipelines, etc.
- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features
available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.

The network_config object supports the following:

  • ipAllocation (pulumi.Input[str]) - The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network.

  • network (pulumi.Input[str]) - Name of the network in the project with which the tenant project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}

create_time: pulumi.Output[str] = None

The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.

description: pulumi.Output[str] = None

An optional description of the instance.

enable_stackdriver_logging: pulumi.Output[bool] = None

Option to enable Stackdriver Logging.

enable_stackdriver_monitoring: pulumi.Output[bool] = None

Option to enable Stackdriver Monitoring.

labels: pulumi.Output[dict] = None

The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.

name: pulumi.Output[str] = None

The ID of the instance or a fully qualified identifier for the instance.

network_config: pulumi.Output[dict] = None

Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.

  • ipAllocation (str) - The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network.

  • network (str) - Name of the network in the project with which the tenant project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}

options: pulumi.Output[dict] = None

Map of additional options used to configure the behavior of Data Fusion instance.

private_instance: pulumi.Output[bool] = None

Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.

project: pulumi.Output[str] = None

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

region: pulumi.Output[str] = None

The region of the Data Fusion instance.

service_account: pulumi.Output[str] = None

Service account which will be used to access resources in the customer project.

service_endpoint: pulumi.Output[str] = None

Endpoint on which the Data Fusion UI and REST APIs are accessible.

state: pulumi.Output[str] = None

The current state of this Data Fusion instance. - CREATING: Instance is being created - RUNNING: Instance is running and ready for requests - FAILED: Instance creation failed - DELETING: Instance is being deleted - UPGRADING: Instance is being upgraded - RESTARTING: Instance is being restarted

state_message: pulumi.Output[str] = None

Additional information about the current state of this Data Fusion instance if available.

type: pulumi.Output[str] = None

Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.

  • BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines using point and click UI. However, there are certain limitations, such as fewer number of concurrent pipelines, no support for streaming pipelines, etc.

  • ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.

update_time: pulumi.Output[str] = None

The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.

version: pulumi.Output[str] = None

Current version of the Data Fusion.

static get(resource_name, id, opts=None, create_time=None, description=None, enable_stackdriver_logging=None, enable_stackdriver_monitoring=None, labels=None, name=None, network_config=None, options=None, private_instance=None, project=None, region=None, service_account=None, service_endpoint=None, state=None, state_message=None, type=None, update_time=None, version=None)

Get an existing Instance 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.

  • create_time (pulumi.Input[str]) – The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.

  • description (pulumi.Input[str]) – An optional description of the instance.

  • enable_stackdriver_logging (pulumi.Input[bool]) – Option to enable Stackdriver Logging.

  • enable_stackdriver_monitoring (pulumi.Input[bool]) – Option to enable Stackdriver Monitoring.

  • labels (pulumi.Input[dict]) – The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.

  • name (pulumi.Input[str]) – The ID of the instance or a fully qualified identifier for the instance.

  • network_config (pulumi.Input[dict]) – Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.

  • options (pulumi.Input[dict]) – Map of additional options used to configure the behavior of Data Fusion instance.

  • private_instance (pulumi.Input[bool]) – Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.

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

  • region (pulumi.Input[str]) – The region of the Data Fusion instance.

  • service_account (pulumi.Input[str]) – Service account which will be used to access resources in the customer project.

  • service_endpoint (pulumi.Input[str]) – Endpoint on which the Data Fusion UI and REST APIs are accessible.

  • state (pulumi.Input[str]) – The current state of this Data Fusion instance. - CREATING: Instance is being created - RUNNING: Instance is running and ready for requests - FAILED: Instance creation failed - DELETING: Instance is being deleted - UPGRADING: Instance is being upgraded - RESTARTING: Instance is being restarted

  • state_message (pulumi.Input[str]) – Additional information about the current state of this Data Fusion instance if available.

  • type (pulumi.Input[str]) – Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.

- BASIC: Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines
using point and click UI. However, there are certain limitations, such as fewer number
of concurrent pipelines, no support for streaming pipelines, etc.
- ENTERPRISE: Enterprise Data Fusion instance. In Enterprise type, the user will have more features
available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.
Parameters
  • update_time (pulumi.Input[str]) – The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.

  • version (pulumi.Input[str]) – Current version of the Data Fusion.

The network_config object supports the following:

  • ipAllocation (pulumi.Input[str]) - The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the Data Fusion instance network.

  • network (pulumi.Input[str]) - Name of the network in the project with which the tenant project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}

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