Module datafusion

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.

Resources

Instance

Others

InstanceArgs
InstanceState

Resources

Resource Instance

class Instance extends CustomResource

Represents a Data Fusion instance.

To get more information about Instance, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Data Fusion Instance Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basicInstance = new gcp.datafusion.Instance("basicInstance", {
    region: "us-central1",
    type: "BASIC",
});

Example Usage - Data Fusion Instance Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const extendedInstance = new gcp.datafusion.Instance("extendedInstance", {
    description: "My Data Fusion instance",
    region: "us-central1",
    type: "BASIC",
    enableStackdriverLogging: true,
    enableStackdriverMonitoring: true,
    labels: {
        example_key: "exampleValue",
    },
    privateInstance: true,
    network_config: {
        network: "default",
        ipAllocation: "10.89.48.0/22",
    },
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Instance

Returns true if the given object is an instance of Instance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property createTime

public createTime: pulumi.Output<string>;

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

property description

public description: pulumi.Output<string | undefined>;

An optional description of the instance.

property enableStackdriverLogging

public enableStackdriverLogging: pulumi.Output<boolean | undefined>;

Option to enable Stackdriver Logging.

property enableStackdriverMonitoring

public enableStackdriverMonitoring: pulumi.Output<boolean | undefined>;

Option to enable Stackdriver Monitoring.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: string} | undefined>;

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

property name

public name: pulumi.Output<string>;

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

property networkConfig

public networkConfig: pulumi.Output<InstanceNetworkConfig | undefined>;

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

property options

public options: pulumi.Output<{[key: string]: string} | undefined>;

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

property privateInstance

public privateInstance: pulumi.Output<boolean | undefined>;

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.

property project

public project: pulumi.Output<string>;

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

property region

public region: pulumi.Output<string>;

The region of the Data Fusion instance.

property serviceAccount

public serviceAccount: pulumi.Output<string>;

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

property serviceEndpoint

public serviceEndpoint: pulumi.Output<string>;

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

property state

public state: pulumi.Output<string>;

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

property stateMessage

public stateMessage: pulumi.Output<string>;

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

property type

public type: pulumi.Output<string>;

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.

property updateTime

public updateTime: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

Current version of the Data Fusion.

Others

interface InstanceArgs

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property description

description?: pulumi.Input<string>;

An optional description of the instance.

property enableStackdriverLogging

enableStackdriverLogging?: pulumi.Input<boolean>;

Option to enable Stackdriver Logging.

property enableStackdriverMonitoring

enableStackdriverMonitoring?: pulumi.Input<boolean>;

Option to enable Stackdriver Monitoring.

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property name

name?: pulumi.Input<string>;

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

property networkConfig

networkConfig?: pulumi.Input<InstanceNetworkConfig>;

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

property options

options?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property privateInstance

privateInstance?: pulumi.Input<boolean>;

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.

property project

project?: pulumi.Input<string>;

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

property region

region?: pulumi.Input<string>;

The region of the Data Fusion instance.

property type

type: pulumi.Input<string>;

interface InstanceState

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property createTime

createTime?: pulumi.Input<string>;

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

property description

description?: pulumi.Input<string>;

An optional description of the instance.

property enableStackdriverLogging

enableStackdriverLogging?: pulumi.Input<boolean>;

Option to enable Stackdriver Logging.

property enableStackdriverMonitoring

enableStackdriverMonitoring?: pulumi.Input<boolean>;

Option to enable Stackdriver Monitoring.

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property name

name?: pulumi.Input<string>;

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

property networkConfig

networkConfig?: pulumi.Input<InstanceNetworkConfig>;

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

property options

options?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property privateInstance

privateInstance?: pulumi.Input<boolean>;

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.