Google Cloud (GCP) Classic
Instance
Represents a Data Fusion instance.
To get more information about Instance, see:
- API documentation
- How-to Guides
Example Usage
Data Fusion Instance Basic
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var basicInstance = new Gcp.DataFusion.Instance("basicInstance", new Gcp.DataFusion.InstanceArgs
{
Region = "us-central1",
Type = "BASIC",
});
}
}
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/datafusion"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datafusion.NewInstance(ctx, "basicInstance", &datafusion.InstanceArgs{
Region: pulumi.String("us-central1"),
Type: pulumi.String("BASIC"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var basicInstance = new Instance("basicInstance", InstanceArgs.builder()
.region("us-central1")
.type("BASIC")
.build());
}
}
import pulumi
import pulumi_gcp as gcp
basic_instance = gcp.datafusion.Instance("basicInstance",
region="us-central1",
type="BASIC")
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basicInstance = new gcp.datafusion.Instance("basic_instance", {
region: "us-central1",
type: "BASIC",
});
resources:
basicInstance:
type: gcp:datafusion:Instance
properties:
region: us-central1
type: BASIC
Data Fusion Instance Full
using Pulumi;
using Gcp = Pulumi.Gcp;
class MyStack : Stack
{
public MyStack()
{
var @default = Output.Create(Gcp.AppEngine.GetDefaultServiceAccount.InvokeAsync());
var extendedInstance = new Gcp.DataFusion.Instance("extendedInstance", new Gcp.DataFusion.InstanceArgs
{
Description = "My Data Fusion instance",
Region = "us-central1",
Type = "BASIC",
EnableStackdriverLogging = true,
EnableStackdriverMonitoring = true,
Labels =
{
{ "example_key", "example_value" },
},
PrivateInstance = true,
NetworkConfig = new Gcp.DataFusion.Inputs.InstanceNetworkConfigArgs
{
Network = "default",
IpAllocation = "10.89.48.0/22",
},
Version = "6.3.0",
DataprocServiceAccount = @default.Apply(@default => @default.Email),
});
}
}
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/appengine"
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/datafusion"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := appengine.GetDefaultServiceAccount(ctx, nil, nil)
if err != nil {
return err
}
_, err = datafusion.NewInstance(ctx, "extendedInstance", &datafusion.InstanceArgs{
Description: pulumi.String("My Data Fusion instance"),
Region: pulumi.String("us-central1"),
Type: pulumi.String("BASIC"),
EnableStackdriverLogging: pulumi.Bool(true),
EnableStackdriverMonitoring: pulumi.Bool(true),
Labels: pulumi.StringMap{
"example_key": pulumi.String("example_value"),
},
PrivateInstance: pulumi.Bool(true),
NetworkConfig: &datafusion.InstanceNetworkConfigArgs{
Network: pulumi.String("default"),
IpAllocation: pulumi.String("10.89.48.0/22"),
},
Version: pulumi.String("6.3.0"),
DataprocServiceAccount: pulumi.String(_default.Email),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var default = Output.of(AppengineFunctions.getDefaultServiceAccount());
var extendedInstance = new Instance("extendedInstance", InstanceArgs.builder()
.description("My Data Fusion instance")
.region("us-central1")
.type("BASIC")
.enableStackdriverLogging(true)
.enableStackdriverMonitoring(true)
.labels(Map.of("example_key", "example_value"))
.privateInstance(true)
.networkConfig(InstanceNetworkConfigArgs.builder()
.network("default")
.ipAllocation("10.89.48.0/22")
.build())
.version("6.3.0")
.dataprocServiceAccount(default_.email())
.build());
}
}
import pulumi
import pulumi_gcp as gcp
default = gcp.appengine.get_default_service_account()
extended_instance = gcp.datafusion.Instance("extendedInstance",
description="My Data Fusion instance",
region="us-central1",
type="BASIC",
enable_stackdriver_logging=True,
enable_stackdriver_monitoring=True,
labels={
"example_key": "example_value",
},
private_instance=True,
network_config=gcp.datafusion.InstanceNetworkConfigArgs(
network="default",
ip_allocation="10.89.48.0/22",
),
version="6.3.0",
dataproc_service_account=default.email)
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const default = gcp.appengine.getDefaultServiceAccount({});
const extendedInstance = new gcp.datafusion.Instance("extendedInstance", {
description: "My Data Fusion instance",
region: "us-central1",
type: "BASIC",
enableStackdriverLogging: true,
enableStackdriverMonitoring: true,
labels: {
example_key: "example_value",
},
privateInstance: true,
networkConfig: {
network: "default",
ipAllocation: "10.89.48.0/22",
},
version: "6.3.0",
dataprocServiceAccount: _default.then(_default => _default.email),
});
resources:
extendedInstance:
type: gcp:datafusion:Instance
properties:
description: My Data Fusion instance
region: us-central1
type: BASIC
enableStackdriverLogging: true
enableStackdriverMonitoring: true
labels:
example_key: example_value
privateInstance: true
networkConfig:
network: default
ipAllocation: 10.89.48.0/22
version: 6.3.0
dataprocServiceAccount: ${default.email}
variables:
default:
Fn::Invoke:
Function: gcp:appengine:getDefaultServiceAccount
Arguments: {}
Create a Instance Resource
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
dataproc_service_account: Optional[str] = None,
description: Optional[str] = None,
enable_stackdriver_logging: Optional[bool] = None,
enable_stackdriver_monitoring: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_config: Optional[InstanceNetworkConfigArgs] = None,
options: Optional[Mapping[str, str]] = None,
private_instance: Optional[bool] = None,
project: Optional[str] = None,
region: Optional[str] = None,
type: Optional[str] = None,
version: Optional[str] = None)
@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: gcp:datafusion:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Instance Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Instance resource accepts the following input properties:
- Type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- Dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- Description string
An optional description of the instance.
- Enable
Stackdriver boolLogging Option to enable Stackdriver Logging.
- Enable
Stackdriver boolMonitoring Option to enable Stackdriver Monitoring.
- Labels Dictionary<string, string>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- Name string
The ID of the instance or a fully qualified identifier for the instance.
- Network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- Options Dictionary<string, string>
Map of additional options used to configure the behavior of Data Fusion instance.
- Private
Instance 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 string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region of the Data Fusion instance.
- Version string
Current version of the Data Fusion.
- Type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- Dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- Description string
An optional description of the instance.
- Enable
Stackdriver boolLogging Option to enable Stackdriver Logging.
- Enable
Stackdriver boolMonitoring Option to enable Stackdriver Monitoring.
- Labels map[string]string
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- Name string
The ID of the instance or a fully qualified identifier for the instance.
- Network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- Options map[string]string
Map of additional options used to configure the behavior of Data Fusion instance.
- Private
Instance 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 string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region of the Data Fusion instance.
- Version string
Current version of the Data Fusion.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- dataproc
Service StringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description String
An optional description of the instance.
- enable
Stackdriver BooleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver BooleanMonitoring Option to enable Stackdriver Monitoring.
- labels Map<String,String>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name String
The ID of the instance or a fully qualified identifier for the instance.
- network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Map<String,String>
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region of the Data Fusion instance.
- version String
Current version of the Data Fusion.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description string
An optional description of the instance.
- enable
Stackdriver booleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver booleanMonitoring Option to enable Stackdriver Monitoring.
- labels {[key: string]: string}
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name string
The ID of the instance or a fully qualified identifier for the instance.
- network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options {[key: string]: string}
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
The region of the Data Fusion instance.
- version string
Current version of the Data Fusion.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- dataproc_
service_ straccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description str
An optional description of the instance.
- enable_
stackdriver_ boollogging Option to enable Stackdriver Logging.
- enable_
stackdriver_ boolmonitoring Option to enable Stackdriver Monitoring.
- labels Mapping[str, str]
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name str
The ID of the instance or a fully qualified identifier for the instance.
- network_
config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Mapping[str, str]
Map of additional options used to configure the behavior of Data Fusion instance.
- private_
instance 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 str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
The region of the Data Fusion instance.
- version str
Current version of the Data Fusion.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- dataproc
Service StringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description String
An optional description of the instance.
- enable
Stackdriver BooleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver BooleanMonitoring Option to enable Stackdriver Monitoring.
- labels Map<String>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name String
The ID of the instance or a fully qualified identifier for the instance.
- network
Config Property Map Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Map<String>
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region of the Data Fusion instance.
- version String
Current version of the Data Fusion.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- Id string
The provider-assigned unique ID for this managed resource.
- Service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- Service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- State 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
- State
Message string Additional information about the current state of this Data Fusion instance if available.
- Tenant
Project stringId The name of the tenant project.
- Update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- Id string
The provider-assigned unique ID for this managed resource.
- Service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- Service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- State 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
- State
Message string Additional information about the current state of this Data Fusion instance if available.
- Tenant
Project stringId The name of the tenant project.
- Update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- create
Time String The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- gcs
Bucket String Cloud Storage bucket generated by Data Fusion in the customer project.
- id String
The provider-assigned unique ID for this managed resource.
- service
Account String Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint String Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message String Additional information about the current state of this Data Fusion instance if available.
- tenant
Project StringId The name of the tenant project.
- update
Time String The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- id string
The provider-assigned unique ID for this managed resource.
- service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message string Additional information about the current state of this Data Fusion instance if available.
- tenant
Project stringId The name of the tenant project.
- update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- create_
time str The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- gcs_
bucket str Cloud Storage bucket generated by Data Fusion in the customer project.
- id str
The provider-assigned unique ID for this managed resource.
- service_
account str Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service_
endpoint str Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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 str Additional information about the current state of this Data Fusion instance if available.
- tenant_
project_ strid The name of the tenant project.
- update_
time str The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- create
Time String The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- gcs
Bucket String Cloud Storage bucket generated by Data Fusion in the customer project.
- id String
The provider-assigned unique ID for this managed resource.
- service
Account String Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint String Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message String Additional information about the current state of this Data Fusion instance if available.
- tenant
Project StringId The name of the tenant project.
- update
Time String The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
Look up an Existing Instance Resource
Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
dataproc_service_account: Optional[str] = None,
description: Optional[str] = None,
enable_stackdriver_logging: Optional[bool] = None,
enable_stackdriver_monitoring: Optional[bool] = None,
gcs_bucket: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_config: Optional[InstanceNetworkConfigArgs] = None,
options: Optional[Mapping[str, str]] = None,
private_instance: Optional[bool] = None,
project: Optional[str] = None,
region: Optional[str] = None,
service_account: Optional[str] = None,
service_endpoint: Optional[str] = None,
state: Optional[str] = None,
state_message: Optional[str] = None,
tenant_project_id: Optional[str] = None,
type: Optional[str] = None,
update_time: Optional[str] = None,
version: Optional[str] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- Description string
An optional description of the instance.
- Enable
Stackdriver boolLogging Option to enable Stackdriver Logging.
- Enable
Stackdriver boolMonitoring Option to enable Stackdriver Monitoring.
- Gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- Labels Dictionary<string, string>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- Name string
The ID of the instance or a fully qualified identifier for the instance.
- Network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- Options Dictionary<string, string>
Map of additional options used to configure the behavior of Data Fusion instance.
- Private
Instance 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 string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region of the Data Fusion instance.
- Service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- Service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- State 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
- State
Message string Additional information about the current state of this Data Fusion instance if available.
- Tenant
Project stringId The name of the tenant project.
- Type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- Update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Version string
Current version of the Data Fusion.
- Create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- Description string
An optional description of the instance.
- Enable
Stackdriver boolLogging Option to enable Stackdriver Logging.
- Enable
Stackdriver boolMonitoring Option to enable Stackdriver Monitoring.
- Gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- Labels map[string]string
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- Name string
The ID of the instance or a fully qualified identifier for the instance.
- Network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- Options map[string]string
Map of additional options used to configure the behavior of Data Fusion instance.
- Private
Instance 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 string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Region string
The region of the Data Fusion instance.
- Service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- Service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- State 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
- State
Message string Additional information about the current state of this Data Fusion instance if available.
- Tenant
Project stringId The name of the tenant project.
- Type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- Update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- Version string
Current version of the Data Fusion.
- create
Time String The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- dataproc
Service StringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description String
An optional description of the instance.
- enable
Stackdriver BooleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver BooleanMonitoring Option to enable Stackdriver Monitoring.
- gcs
Bucket String Cloud Storage bucket generated by Data Fusion in the customer project.
- labels Map<String,String>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name String
The ID of the instance or a fully qualified identifier for the instance.
- network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Map<String,String>
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region of the Data Fusion instance.
- service
Account String Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint String Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message String Additional information about the current state of this Data Fusion instance if available.
- tenant
Project StringId The name of the tenant project.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- update
Time String The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- version String
Current version of the Data Fusion.
- create
Time string The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- dataproc
Service stringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description string
An optional description of the instance.
- enable
Stackdriver booleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver booleanMonitoring Option to enable Stackdriver Monitoring.
- gcs
Bucket string Cloud Storage bucket generated by Data Fusion in the customer project.
- labels {[key: string]: string}
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name string
The ID of the instance or a fully qualified identifier for the instance.
- network
Config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options {[key: string]: string}
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region string
The region of the Data Fusion instance.
- service
Account string Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint string Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message string Additional information about the current state of this Data Fusion instance if available.
- tenant
Project stringId The name of the tenant project.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- update
Time string The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- version string
Current version of the Data Fusion.
- create_
time str The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- dataproc_
service_ straccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description str
An optional description of the instance.
- enable_
stackdriver_ boollogging Option to enable Stackdriver Logging.
- enable_
stackdriver_ boolmonitoring Option to enable Stackdriver Monitoring.
- gcs_
bucket str Cloud Storage bucket generated by Data Fusion in the customer project.
- labels Mapping[str, str]
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name str
The ID of the instance or a fully qualified identifier for the instance.
- network_
config InstanceNetwork Config Args Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Mapping[str, str]
Map of additional options used to configure the behavior of Data Fusion instance.
- private_
instance 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 str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region str
The region of the Data Fusion instance.
- service_
account str Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service_
endpoint str Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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 str Additional information about the current state of this Data Fusion instance if available.
- tenant_
project_ strid The name of the tenant project.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- update_
time str The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- version str
Current version of the Data Fusion.
- create
Time String The time the instance was created in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- dataproc
Service StringAccount User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.
- description String
An optional description of the instance.
- enable
Stackdriver BooleanLogging Option to enable Stackdriver Logging.
- enable
Stackdriver BooleanMonitoring Option to enable Stackdriver Monitoring.
- gcs
Bucket String Cloud Storage bucket generated by Data Fusion in the customer project.
- labels Map<String>
The resource labels for instance to use to annotate any related underlying resources, such as Compute Engine VMs.
- name String
The ID of the instance or a fully qualified identifier for the instance.
- network
Config Property Map Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
- options Map<String>
Map of additional options used to configure the behavior of Data Fusion instance.
- private
Instance 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.
- project String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- region String
The region of the Data Fusion instance.
- service
Account String Deprecated. Use 'tenant_project_id' instead to extract the tenant project ID.
Use
tenant_project_id
instead to extract the tenant project ID.- service
Endpoint String Endpoint on which the Data Fusion UI and REST APIs are accessible.
- state 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
- state
Message String Additional information about the current state of this Data Fusion instance if available.
- tenant
Project StringId The name of the tenant project.
- type 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.
- DEVELOPER: Developer Data Fusion instance. In Developer type, the user will have all features available but
with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration
pipelines at low cost.
Possible values are
BASIC
,ENTERPRISE
, andDEVELOPER
.
- update
Time String The time the instance was last updated in RFC3339 UTC "Zulu" format, accurate to nanoseconds.
- version String
Current version of the Data Fusion.
Supporting Types
InstanceNetworkConfig
- Ip
Allocation string 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 string
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}
- Ip
Allocation string 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 string
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}
- ip
Allocation String 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 String
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}
- ip
Allocation string 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 string
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}
- ip_
allocation 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}
- ip
Allocation String 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 String
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}
Import
Instance can be imported using any of these accepted formats
$ pulumi import gcp:datafusion/instance:Instance default projects/{{project}}/locations/{{region}}/instances/{{name}}
$ pulumi import gcp:datafusion/instance:Instance default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:datafusion/instance:Instance default {{region}}/{{name}}
$ pulumi import gcp:datafusion/instance:Instance default {{name}}
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.