1. Pulumi Registry
  2. Google Cloud Native
  3. API Docs
  4. datafusion
  5. datafusion/v1
  6. getInstance
google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.datafusion/v1.getInstance

Gets details of a single Data Fusion instance.

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(instance_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:datafusion/v1:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string
Location string
Project string
InstanceId string
Location string
Project string
instanceId String
location String
project String
instanceId string
location string
project string
instanceId String
location String
project String

getInstance Result

The following output properties are available:

Accelerators List<Pulumi.GoogleNative.DataFusion.V1.Outputs.AcceleratorResponse>

List of accelerators enabled for this CDF instance.

ApiEndpoint string

Endpoint on which the REST APIs is accessible.

AvailableVersion List<Pulumi.GoogleNative.DataFusion.V1.Outputs.VersionResponse>

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

CreateTime string

The time the instance was created.

CryptoKeyConfig Pulumi.GoogleNative.DataFusion.V1.Outputs.CryptoKeyConfigResponse

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

DataprocServiceAccount string

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

Description string

A description of this instance.

DisabledReason List<string>

If the instance state is DISABLED, the reason for disabling the instance.

DisplayName string

Display name for an instance.

EnableRbac bool

Option to enable granular role-based access control.

EnableStackdriverLogging bool

Option to enable Stackdriver Logging.

EnableStackdriverMonitoring bool

Option to enable Stackdriver Monitoring.

EnableZoneSeparation bool

Option to enable granular zone separation.

EventPublishConfig Pulumi.GoogleNative.DataFusion.V1.Outputs.EventPublishConfigResponse

Option to enable and pass metadata for event publishing.

GcsBucket 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. The character '=' is not allowed to be used within the labels.

Name string

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

NetworkConfig Pulumi.GoogleNative.DataFusion.V1.Outputs.NetworkConfigResponse

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

Options Dictionary<string, string>

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

P4ServiceAccount string

P4 service account for the customer project.

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.

ServiceAccount string

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

ServiceEndpoint string

Endpoint on which the Data Fusion UI is accessible.

State string

The current state of this Data Fusion instance.

StateMessage string

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

TenantProjectId string

The name of the tenant project.

Type string

Instance type.

UpdateTime string

The time the instance was last updated.

Version string

Current version of the Data Fusion. Only specifiable in Update.

Zone string

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

Accelerators []AcceleratorResponse

List of accelerators enabled for this CDF instance.

ApiEndpoint string

Endpoint on which the REST APIs is accessible.

AvailableVersion []VersionResponse

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

CreateTime string

The time the instance was created.

CryptoKeyConfig CryptoKeyConfigResponse

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

DataprocServiceAccount string

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

Description string

A description of this instance.

DisabledReason []string

If the instance state is DISABLED, the reason for disabling the instance.

DisplayName string

Display name for an instance.

EnableRbac bool

Option to enable granular role-based access control.

EnableStackdriverLogging bool

Option to enable Stackdriver Logging.

EnableStackdriverMonitoring bool

Option to enable Stackdriver Monitoring.

EnableZoneSeparation bool

Option to enable granular zone separation.

EventPublishConfig EventPublishConfigResponse

Option to enable and pass metadata for event publishing.

GcsBucket 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. The character '=' is not allowed to be used within the labels.

Name string

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

NetworkConfig NetworkConfigResponse

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

Options map[string]string

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

P4ServiceAccount string

P4 service account for the customer project.

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.

ServiceAccount string

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

ServiceEndpoint string

Endpoint on which the Data Fusion UI is accessible.

State string

The current state of this Data Fusion instance.

StateMessage string

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

TenantProjectId string

The name of the tenant project.

Type string

Instance type.

UpdateTime string

The time the instance was last updated.

Version string

Current version of the Data Fusion. Only specifiable in Update.

Zone string

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

accelerators List<AcceleratorResponse>

List of accelerators enabled for this CDF instance.

apiEndpoint String

Endpoint on which the REST APIs is accessible.

availableVersion List<VersionResponse>

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

createTime String

The time the instance was created.

cryptoKeyConfig CryptoKeyConfigResponse

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

dataprocServiceAccount String

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

description String

A description of this instance.

disabledReason List<String>

If the instance state is DISABLED, the reason for disabling the instance.

displayName String

Display name for an instance.

enableRbac Boolean

Option to enable granular role-based access control.

enableStackdriverLogging Boolean

Option to enable Stackdriver Logging.

enableStackdriverMonitoring Boolean

Option to enable Stackdriver Monitoring.

enableZoneSeparation Boolean

Option to enable granular zone separation.

eventPublishConfig EventPublishConfigResponse

Option to enable and pass metadata for event publishing.

gcsBucket 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. The character '=' is not allowed to be used within the labels.

name String

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

networkConfig NetworkConfigResponse

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

options Map<String,String>

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

p4ServiceAccount String

P4 service account for the customer project.

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.

serviceAccount String

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

serviceEndpoint String

Endpoint on which the Data Fusion UI is accessible.

state String

The current state of this Data Fusion instance.

stateMessage String

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

tenantProjectId String

The name of the tenant project.

type String

Instance type.

updateTime String

The time the instance was last updated.

version String

Current version of the Data Fusion. Only specifiable in Update.

zone String

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

accelerators AcceleratorResponse[]

List of accelerators enabled for this CDF instance.

apiEndpoint string

Endpoint on which the REST APIs is accessible.

availableVersion VersionResponse[]

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

createTime string

The time the instance was created.

cryptoKeyConfig CryptoKeyConfigResponse

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

dataprocServiceAccount string

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

description string

A description of this instance.

disabledReason string[]

If the instance state is DISABLED, the reason for disabling the instance.

displayName string

Display name for an instance.

enableRbac boolean

Option to enable granular role-based access control.

enableStackdriverLogging boolean

Option to enable Stackdriver Logging.

enableStackdriverMonitoring boolean

Option to enable Stackdriver Monitoring.

enableZoneSeparation boolean

Option to enable granular zone separation.

eventPublishConfig EventPublishConfigResponse

Option to enable and pass metadata for event publishing.

gcsBucket 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. The character '=' is not allowed to be used within the labels.

name string

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

networkConfig NetworkConfigResponse

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

options {[key: string]: string}

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

p4ServiceAccount string

P4 service account for the customer project.

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.

serviceAccount string

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

serviceEndpoint string

Endpoint on which the Data Fusion UI is accessible.

state string

The current state of this Data Fusion instance.

stateMessage string

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

tenantProjectId string

The name of the tenant project.

type string

Instance type.

updateTime string

The time the instance was last updated.

version string

Current version of the Data Fusion. Only specifiable in Update.

zone string

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

accelerators Sequence[AcceleratorResponse]

List of accelerators enabled for this CDF instance.

api_endpoint str

Endpoint on which the REST APIs is accessible.

available_version Sequence[VersionResponse]

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

create_time str

The time the instance was created.

crypto_key_config CryptoKeyConfigResponse

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

dataproc_service_account str

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

description str

A description of this instance.

disabled_reason Sequence[str]

If the instance state is DISABLED, the reason for disabling the instance.

display_name str

Display name for an instance.

enable_rbac bool

Option to enable granular role-based access control.

enable_stackdriver_logging bool

Option to enable Stackdriver Logging.

enable_stackdriver_monitoring bool

Option to enable Stackdriver Monitoring.

enable_zone_separation bool

Option to enable granular zone separation.

event_publish_config EventPublishConfigResponse

Option to enable and pass metadata for event publishing.

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. The character '=' is not allowed to be used within the labels.

name str

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

network_config NetworkConfigResponse

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

options Mapping[str, str]

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

p4_service_account str

P4 service account for the customer project.

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.

service_account str

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

service_endpoint str

Endpoint on which the Data Fusion UI is accessible.

state str

The current state of this Data Fusion instance.

state_message str

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

tenant_project_id str

The name of the tenant project.

type str

Instance type.

update_time str

The time the instance was last updated.

version str

Current version of the Data Fusion. Only specifiable in Update.

zone str

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

accelerators List<Property Map>

List of accelerators enabled for this CDF instance.

apiEndpoint String

Endpoint on which the REST APIs is accessible.

availableVersion List<Property Map>

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

createTime String

The time the instance was created.

cryptoKeyConfig Property Map

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

dataprocServiceAccount String

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources.

description String

A description of this instance.

disabledReason List<String>

If the instance state is DISABLED, the reason for disabling the instance.

displayName String

Display name for an instance.

enableRbac Boolean

Option to enable granular role-based access control.

enableStackdriverLogging Boolean

Option to enable Stackdriver Logging.

enableStackdriverMonitoring Boolean

Option to enable Stackdriver Monitoring.

enableZoneSeparation Boolean

Option to enable granular zone separation.

eventPublishConfig Property Map

Option to enable and pass metadata for event publishing.

gcsBucket 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. The character '=' is not allowed to be used within the labels.

name String

The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

networkConfig Property Map

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

options Map<String>

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

p4ServiceAccount String

P4 service account for the customer project.

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.

serviceAccount String

Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Deprecated:

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

serviceEndpoint String

Endpoint on which the Data Fusion UI is accessible.

state String

The current state of this Data Fusion instance.

stateMessage String

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

tenantProjectId String

The name of the tenant project.

type String

Instance type.

updateTime String

The time the instance was last updated.

version String

Current version of the Data Fusion. Only specifiable in Update.

zone String

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

Supporting Types

AcceleratorResponse

AcceleratorType string

The type of an accelator for a CDF instance.

State string

The state of the accelerator.

AcceleratorType string

The type of an accelator for a CDF instance.

State string

The state of the accelerator.

acceleratorType String

The type of an accelator for a CDF instance.

state String

The state of the accelerator.

acceleratorType string

The type of an accelator for a CDF instance.

state string

The state of the accelerator.

accelerator_type str

The type of an accelator for a CDF instance.

state str

The state of the accelerator.

acceleratorType String

The type of an accelator for a CDF instance.

state String

The state of the accelerator.

CryptoKeyConfigResponse

KeyReference string

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

KeyReference string

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

keyReference String

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

keyReference string

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

key_reference str

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

keyReference String

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

EventPublishConfigResponse

Enabled bool

Option to enable Event Publishing.

Topic string

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

Enabled bool

Option to enable Event Publishing.

Topic string

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

enabled Boolean

Option to enable Event Publishing.

topic String

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

enabled boolean

Option to enable Event Publishing.

topic string

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

enabled bool

Option to enable Event Publishing.

topic str

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

enabled Boolean

Option to enable Event Publishing.

topic String

The resource name of the Pub/Sub topic. Format: projects/{project_id}/topics/{topic_id}

NetworkConfigResponse

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 customer network.

Network string

Name of the network in the customer 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 customer network.

Network string

Name of the network in the customer 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 customer network.

network String

Name of the network in the customer 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 customer network.

network string

Name of the network in the customer 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 customer network.

network str

Name of the network in the customer 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 customer network.

network String

Name of the network in the customer 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}

VersionResponse

AvailableFeatures List<string>

Represents a list of available feature names for a given version.

DefaultVersion bool

Whether this is currently the default version for Cloud Data Fusion

Type string

Type represents the release availability of the version

VersionNumber string

The version number of the Data Fusion instance, such as '6.0.1.0'.

AvailableFeatures []string

Represents a list of available feature names for a given version.

DefaultVersion bool

Whether this is currently the default version for Cloud Data Fusion

Type string

Type represents the release availability of the version

VersionNumber string

The version number of the Data Fusion instance, such as '6.0.1.0'.

availableFeatures List<String>

Represents a list of available feature names for a given version.

defaultVersion Boolean

Whether this is currently the default version for Cloud Data Fusion

type String

Type represents the release availability of the version

versionNumber String

The version number of the Data Fusion instance, such as '6.0.1.0'.

availableFeatures string[]

Represents a list of available feature names for a given version.

defaultVersion boolean

Whether this is currently the default version for Cloud Data Fusion

type string

Type represents the release availability of the version

versionNumber string

The version number of the Data Fusion instance, such as '6.0.1.0'.

available_features Sequence[str]

Represents a list of available feature names for a given version.

default_version bool

Whether this is currently the default version for Cloud Data Fusion

type str

Type represents the release availability of the version

version_number str

The version number of the Data Fusion instance, such as '6.0.1.0'.

availableFeatures List<String>

Represents a list of available feature names for a given version.

defaultVersion Boolean

Whether this is currently the default version for Cloud Data Fusion

type String

Type represents the release availability of the version

versionNumber String

The version number of the Data Fusion instance, such as '6.0.1.0'.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0