Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataplex
  5. dataplex/v1
  6. getEnvironment

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.dataplex/v1.getEnvironment

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Get environment resource.

Using getEnvironment

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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
Copy
def get_environment(environment_id: Optional[str] = None,
                    lake_id: Optional[str] = None,
                    location: Optional[str] = None,
                    project: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_id: Optional[pulumi.Input[str]] = None,
                    lake_id: Optional[pulumi.Input[str]] = None,
                    location: Optional[pulumi.Input[str]] = None,
                    project: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
Copy
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
Copy

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

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:dataplex/v1:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentId This property is required. string
LakeId This property is required. string
Location This property is required. string
Project string
EnvironmentId This property is required. string
LakeId This property is required. string
Location This property is required. string
Project string
environmentId This property is required. String
lakeId This property is required. String
location This property is required. String
project String
environmentId This property is required. string
lakeId This property is required. string
location This property is required. string
project string
environment_id This property is required. str
lake_id This property is required. str
location This property is required. str
project str
environmentId This property is required. String
lakeId This property is required. String
location This property is required. String
project String

getEnvironment Result

The following output properties are available:

CreateTime string
Environment creation time.
Description string
Optional. Description of the environment.
DisplayName string
Optional. User friendly display name.
Endpoints Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1EnvironmentEndpointsResponse
URI Endpoints to access sessions associated with the Environment.
InfrastructureSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
Infrastructure specification for the Environment.
Labels Dictionary<string, string>
Optional. User defined labels for the environment.
Name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
SessionSpec Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1EnvironmentSessionSpecResponse
Optional. Configuration for sessions created for this environment.
SessionStatus Pulumi.GoogleNative.Dataplex.V1.Outputs.GoogleCloudDataplexV1EnvironmentSessionStatusResponse
Status of sessions created for this environment.
State string
Current state of the environment.
Uid string
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
UpdateTime string
The time when the environment was last updated.
CreateTime string
Environment creation time.
Description string
Optional. Description of the environment.
DisplayName string
Optional. User friendly display name.
Endpoints GoogleCloudDataplexV1EnvironmentEndpointsResponse
URI Endpoints to access sessions associated with the Environment.
InfrastructureSpec GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
Infrastructure specification for the Environment.
Labels map[string]string
Optional. User defined labels for the environment.
Name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
SessionSpec GoogleCloudDataplexV1EnvironmentSessionSpecResponse
Optional. Configuration for sessions created for this environment.
SessionStatus GoogleCloudDataplexV1EnvironmentSessionStatusResponse
Status of sessions created for this environment.
State string
Current state of the environment.
Uid string
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
UpdateTime string
The time when the environment was last updated.
createTime String
Environment creation time.
description String
Optional. Description of the environment.
displayName String
Optional. User friendly display name.
endpoints GoogleCloudDataplexV1EnvironmentEndpointsResponse
URI Endpoints to access sessions associated with the Environment.
infrastructureSpec GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
Infrastructure specification for the Environment.
labels Map<String,String>
Optional. User defined labels for the environment.
name String
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
sessionSpec GoogleCloudDataplexV1EnvironmentSessionSpecResponse
Optional. Configuration for sessions created for this environment.
sessionStatus GoogleCloudDataplexV1EnvironmentSessionStatusResponse
Status of sessions created for this environment.
state String
Current state of the environment.
uid String
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
updateTime String
The time when the environment was last updated.
createTime string
Environment creation time.
description string
Optional. Description of the environment.
displayName string
Optional. User friendly display name.
endpoints GoogleCloudDataplexV1EnvironmentEndpointsResponse
URI Endpoints to access sessions associated with the Environment.
infrastructureSpec GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
Infrastructure specification for the Environment.
labels {[key: string]: string}
Optional. User defined labels for the environment.
name string
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
sessionSpec GoogleCloudDataplexV1EnvironmentSessionSpecResponse
Optional. Configuration for sessions created for this environment.
sessionStatus GoogleCloudDataplexV1EnvironmentSessionStatusResponse
Status of sessions created for this environment.
state string
Current state of the environment.
uid string
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
updateTime string
The time when the environment was last updated.
create_time str
Environment creation time.
description str
Optional. Description of the environment.
display_name str
Optional. User friendly display name.
endpoints GoogleCloudDataplexV1EnvironmentEndpointsResponse
URI Endpoints to access sessions associated with the Environment.
infrastructure_spec GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse
Infrastructure specification for the Environment.
labels Mapping[str, str]
Optional. User defined labels for the environment.
name str
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
session_spec GoogleCloudDataplexV1EnvironmentSessionSpecResponse
Optional. Configuration for sessions created for this environment.
session_status GoogleCloudDataplexV1EnvironmentSessionStatusResponse
Status of sessions created for this environment.
state str
Current state of the environment.
uid str
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
update_time str
The time when the environment was last updated.
createTime String
Environment creation time.
description String
Optional. Description of the environment.
displayName String
Optional. User friendly display name.
endpoints Property Map
URI Endpoints to access sessions associated with the Environment.
infrastructureSpec Property Map
Infrastructure specification for the Environment.
labels Map<String>
Optional. User defined labels for the environment.
name String
The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
sessionSpec Property Map
Optional. Configuration for sessions created for this environment.
sessionStatus Property Map
Status of sessions created for this environment.
state String
Current state of the environment.
uid String
System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
updateTime String
The time when the environment was last updated.

Supporting Types

GoogleCloudDataplexV1EnvironmentEndpointsResponse

Notebooks This property is required. string
URI to serve notebook APIs
Sql This property is required. string
URI to serve SQL APIs
Notebooks This property is required. string
URI to serve notebook APIs
Sql This property is required. string
URI to serve SQL APIs
notebooks This property is required. String
URI to serve notebook APIs
sql This property is required. String
URI to serve SQL APIs
notebooks This property is required. string
URI to serve notebook APIs
sql This property is required. string
URI to serve SQL APIs
notebooks This property is required. str
URI to serve notebook APIs
sql This property is required. str
URI to serve SQL APIs
notebooks This property is required. String
URI to serve notebook APIs
sql This property is required. String
URI to serve SQL APIs

GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse

DiskSizeGb This property is required. int
Optional. Size in GB of the disk. Default is 100 GB.
MaxNodeCount This property is required. int
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
NodeCount This property is required. int
Optional. Total number of nodes in the sessions created for this environment.
DiskSizeGb This property is required. int
Optional. Size in GB of the disk. Default is 100 GB.
MaxNodeCount This property is required. int
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
NodeCount This property is required. int
Optional. Total number of nodes in the sessions created for this environment.
diskSizeGb This property is required. Integer
Optional. Size in GB of the disk. Default is 100 GB.
maxNodeCount This property is required. Integer
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
nodeCount This property is required. Integer
Optional. Total number of nodes in the sessions created for this environment.
diskSizeGb This property is required. number
Optional. Size in GB of the disk. Default is 100 GB.
maxNodeCount This property is required. number
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
nodeCount This property is required. number
Optional. Total number of nodes in the sessions created for this environment.
disk_size_gb This property is required. int
Optional. Size in GB of the disk. Default is 100 GB.
max_node_count This property is required. int
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
node_count This property is required. int
Optional. Total number of nodes in the sessions created for this environment.
diskSizeGb This property is required. Number
Optional. Size in GB of the disk. Default is 100 GB.
maxNodeCount This property is required. Number
Optional. Max configurable nodes. If max_node_count > node_count, then auto-scaling is enabled.
nodeCount This property is required. Number
Optional. Total number of nodes in the sessions created for this environment.

GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse

ImageVersion This property is required. string
Dataplex Image version.
JavaLibraries This property is required. List<string>
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
Properties This property is required. Dictionary<string, string>
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
PythonPackages This property is required. List<string>
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
ImageVersion This property is required. string
Dataplex Image version.
JavaLibraries This property is required. []string
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
Properties This property is required. map[string]string
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
PythonPackages This property is required. []string
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
imageVersion This property is required. String
Dataplex Image version.
javaLibraries This property is required. List<String>
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
properties This property is required. Map<String,String>
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
pythonPackages This property is required. List<String>
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
imageVersion This property is required. string
Dataplex Image version.
javaLibraries This property is required. string[]
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
properties This property is required. {[key: string]: string}
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
pythonPackages This property is required. string[]
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
image_version This property is required. str
Dataplex Image version.
java_libraries This property is required. Sequence[str]
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
properties This property is required. Mapping[str, str]
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
python_packages This property is required. Sequence[str]
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
imageVersion This property is required. String
Dataplex Image version.
javaLibraries This property is required. List<String>
Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
properties This property is required. Map<String>
Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".
pythonPackages This property is required. List<String>
Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz

GoogleCloudDataplexV1EnvironmentInfrastructureSpecResponse

Compute This property is required. Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
Optional. Compute resources needed for analyze interactive workloads.
OsImage This property is required. Pulumi.GoogleNative.Dataplex.V1.Inputs.GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
Software Runtime Configuration for analyze interactive workloads.
Compute This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
Optional. Compute resources needed for analyze interactive workloads.
OsImage This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
Software Runtime Configuration for analyze interactive workloads.
compute This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
Optional. Compute resources needed for analyze interactive workloads.
osImage This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
Software Runtime Configuration for analyze interactive workloads.
compute This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
Optional. Compute resources needed for analyze interactive workloads.
osImage This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
Software Runtime Configuration for analyze interactive workloads.
compute This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecComputeResourcesResponse
Optional. Compute resources needed for analyze interactive workloads.
os_image This property is required. GoogleCloudDataplexV1EnvironmentInfrastructureSpecOsImageRuntimeResponse
Software Runtime Configuration for analyze interactive workloads.
compute This property is required. Property Map
Optional. Compute resources needed for analyze interactive workloads.
osImage This property is required. Property Map
Software Runtime Configuration for analyze interactive workloads.

GoogleCloudDataplexV1EnvironmentSessionSpecResponse

EnableFastStartup This property is required. bool
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
MaxIdleDuration This property is required. string
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
EnableFastStartup This property is required. bool
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
MaxIdleDuration This property is required. string
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
enableFastStartup This property is required. Boolean
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
maxIdleDuration This property is required. String
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
enableFastStartup This property is required. boolean
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
maxIdleDuration This property is required. string
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
enable_fast_startup This property is required. bool
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
max_idle_duration This property is required. str
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.
enableFastStartup This property is required. Boolean
Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.
maxIdleDuration This property is required. String
Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.

GoogleCloudDataplexV1EnvironmentSessionStatusResponse

Active This property is required. bool
Queries over sessions to mark whether the environment is currently active or not
Active This property is required. bool
Queries over sessions to mark whether the environment is currently active or not
active This property is required. Boolean
Queries over sessions to mark whether the environment is currently active or not
active This property is required. boolean
Queries over sessions to mark whether the environment is currently active or not
active This property is required. bool
Queries over sessions to mark whether the environment is currently active or not
active This property is required. Boolean
Queries over sessions to mark whether the environment is currently active or not

Package Details

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

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native