Instance

Represents a Data Fusion instance.

To get more information about Instance, see:

API documentation
How-to Guides
- Official Documentation

Create a Instance Resource

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

def 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);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
Description string: An optional description of the instance.
EnableStackdriverLogging bool: Option to enable Stackdriver Logging.
EnableStackdriverMonitoring bool: 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.
NetworkConfig InstanceNetworkConfigArgs: 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.
PrivateInstance 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.

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.
Description string: An optional description of the instance.
EnableStackdriverLogging bool: Option to enable Stackdriver Logging.
EnableStackdriverMonitoring bool: 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.
NetworkConfig InstanceNetworkConfig: 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.
PrivateInstance 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.

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.
description string: An optional description of the instance.
enableStackdriverLogging boolean: Option to enable Stackdriver Logging.
enableStackdriverMonitoring boolean: 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.
networkConfig InstanceNetworkConfig: 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.
privateInstance 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.

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.
description str: An optional description of the instance.
enable_stackdriver_logging bool: Option to enable Stackdriver Logging.
enable_stackdriver_monitoring bool: Option to enable Stackdriver Monitoring.
labels Dict[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 Dict[InstanceNetworkConfig]: Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
options Dict[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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Id string: The provider-assigned unique ID for this managed resource.
ServiceAccount string: Service account which will be used to access resources in the customer project.
ServiceEndpoint 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
StateMessage string: Additional information about the current state of this Data Fusion instance if available.
UpdateTime string: The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Version string: Current version of the Data Fusion.

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Id string: The provider-assigned unique ID for this managed resource.
ServiceAccount string: Service account which will be used to access resources in the customer project.
ServiceEndpoint 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
StateMessage string: Additional information about the current state of this Data Fusion instance if available.
UpdateTime string: The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Version string: Current version of the Data Fusion.

createTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
id string: The provider-assigned unique ID for this managed resource.
serviceAccount string: Service account which will be used to access resources in the customer project.
serviceEndpoint 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
stateMessage string: Additional information about the current state of this Data Fusion instance if available.
updateTime 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.
id str: The provider-assigned unique ID for this managed resource.
service_account str: Service account which will be used to access resources in the customer project.
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.
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.

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

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, __props__=None);

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)

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.

The following state arguments are supported:

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Description string: An optional description of the instance.
EnableStackdriverLogging bool: Option to enable Stackdriver Logging.
EnableStackdriverMonitoring bool: 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.
NetworkConfig InstanceNetworkConfigArgs: 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.
PrivateInstance 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.
ServiceAccount string: Service account which will be used to access resources in the customer project.
ServiceEndpoint 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
StateMessage string: Additional information about the current state of this Data Fusion instance if available.
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.
UpdateTime string: The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Version string: Current version of the Data Fusion.

CreateTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Description string: An optional description of the instance.
EnableStackdriverLogging bool: Option to enable Stackdriver Logging.
EnableStackdriverMonitoring bool: 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.
NetworkConfig InstanceNetworkConfig: 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.
PrivateInstance 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.
ServiceAccount string: Service account which will be used to access resources in the customer project.
ServiceEndpoint 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
StateMessage string: Additional information about the current state of this Data Fusion instance if available.
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.
UpdateTime string: The time the instance was last updated in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
Version string: Current version of the Data Fusion.

createTime string: The time the instance was created in RFC3339 UTC “Zulu” format, accurate to nanoseconds.
description string: An optional description of the instance.
enableStackdriverLogging boolean: Option to enable Stackdriver Logging.
enableStackdriverMonitoring boolean: 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.
networkConfig InstanceNetworkConfig: 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.
privateInstance 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.
serviceAccount string: Service account which will be used to access resources in the customer project.
serviceEndpoint 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
stateMessage string: Additional information about the current state of this Data Fusion instance if available.
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.
updateTime 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.
description str: An optional description of the instance.
enable_stackdriver_logging bool: Option to enable Stackdriver Logging.
enable_stackdriver_monitoring bool: Option to enable Stackdriver Monitoring.
labels Dict[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 Dict[InstanceNetworkConfig]: Network configuration options. These are required when a private Data Fusion instance is to be created. Structure is documented below.
options Dict[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: Service account which will be used to access resources in the customer project.
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.
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.
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.

Supporting Types

InstanceNetworkConfig

See the input and output API doc for this type.

IpAllocation 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}

IpAllocation 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}

ipAllocation 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}

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}

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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud