1. Packages
  2. Yandex
  3. API Docs
  4. getDataprocCluster
Yandex v0.13.0 published on Tuesday, Feb 22, 2022 by Pulumi

yandex.getDataprocCluster

Explore with Pulumi AI

Get information about a Yandex Data Proc cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetDataprocCluster.InvokeAsync(new Yandex.GetDataprocClusterArgs
        {
            Name = "test",
        }));
        this.ServiceAccountId = foo.Apply(foo => foo.ServiceAccountId);
    }

    [Output("serviceAccountId")]
    public Output<string> ServiceAccountId { get; set; }
}
Copy
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.LookupDataprocCluster(ctx, &GetDataprocClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("serviceAccountId", foo.ServiceAccountId)
		return nil
	})
}
Copy

Coming soon!

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

const foo = pulumi.output(yandex.getDataprocCluster({
    name: "test",
}));

export const serviceAccountId = foo.serviceAccountId;
Copy
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_dataproc_cluster(name="test")
pulumi.export("serviceAccountId", foo.service_account_id)
Copy

Coming soon!

Using getDataprocCluster

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 getDataprocCluster(args: GetDataprocClusterArgs, opts?: InvokeOptions): Promise<GetDataprocClusterResult>
function getDataprocClusterOutput(args: GetDataprocClusterOutputArgs, opts?: InvokeOptions): Output<GetDataprocClusterResult>
Copy
def get_dataproc_cluster(cluster_id: Optional[str] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDataprocClusterResult
def get_dataproc_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDataprocClusterResult]
Copy
func LookupDataprocCluster(ctx *Context, args *LookupDataprocClusterArgs, opts ...InvokeOption) (*LookupDataprocClusterResult, error)
func LookupDataprocClusterOutput(ctx *Context, args *LookupDataprocClusterOutputArgs, opts ...InvokeOption) LookupDataprocClusterResultOutput
Copy

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

public static class GetDataprocCluster 
{
    public static Task<GetDataprocClusterResult> InvokeAsync(GetDataprocClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetDataprocClusterResult> Invoke(GetDataprocClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDataprocClusterResult> getDataprocCluster(GetDataprocClusterArgs args, InvokeOptions options)
public static Output<GetDataprocClusterResult> getDataprocCluster(GetDataprocClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: yandex:index/getDataprocCluster:getDataprocCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterId string
The ID of the Data Proc cluster.
Name string
The name of the Data Proc cluster.
ClusterId string
The ID of the Data Proc cluster.
Name string
The name of the Data Proc cluster.
clusterId String
The ID of the Data Proc cluster.
name String
The name of the Data Proc cluster.
clusterId string
The ID of the Data Proc cluster.
name string
The name of the Data Proc cluster.
cluster_id str
The ID of the Data Proc cluster.
name str
The name of the Data Proc cluster.
clusterId String
The ID of the Data Proc cluster.
name String
The name of the Data Proc cluster.

getDataprocCluster Result

The following output properties are available:

Bucket string
Name of the Object Storage bucket used for Data Proc jobs.
ClusterConfigs List<GetDataprocClusterClusterConfig>
Configuration and resources of the cluster. The structure is documented below.
ClusterId string
CreatedAt string
The Data Proc cluster creation timestamp.
DeletionProtection bool
Description string
Description of the Data Proc cluster.
FolderId string
HostGroupIds List<string>
A list of IDs of the host groups hosting VMs of the cluster.
Id string
The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
A set of key/value label pairs assigned to the Data Proc cluster.
Name string
Name of the Data Proc subcluster.
SecurityGroupIds List<string>
ServiceAccountId string
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
UiProxy bool
Whether UI proxy feature is enabled.
ZoneId string
ID of the availability zone where the cluster resides.
Bucket string
Name of the Object Storage bucket used for Data Proc jobs.
ClusterConfigs []GetDataprocClusterClusterConfig
Configuration and resources of the cluster. The structure is documented below.
ClusterId string
CreatedAt string
The Data Proc cluster creation timestamp.
DeletionProtection bool
Description string
Description of the Data Proc cluster.
FolderId string
HostGroupIds []string
A list of IDs of the host groups hosting VMs of the cluster.
Id string
The provider-assigned unique ID for this managed resource.
Labels map[string]string
A set of key/value label pairs assigned to the Data Proc cluster.
Name string
Name of the Data Proc subcluster.
SecurityGroupIds []string
ServiceAccountId string
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
UiProxy bool
Whether UI proxy feature is enabled.
ZoneId string
ID of the availability zone where the cluster resides.
bucket String
Name of the Object Storage bucket used for Data Proc jobs.
clusterConfigs List<GetDataprocClusterClusterConfig>
Configuration and resources of the cluster. The structure is documented below.
clusterId String
createdAt String
The Data Proc cluster creation timestamp.
deletionProtection Boolean
description String
Description of the Data Proc cluster.
folderId String
hostGroupIds List<String>
A list of IDs of the host groups hosting VMs of the cluster.
id String
The provider-assigned unique ID for this managed resource.
labels Map<String,String>
A set of key/value label pairs assigned to the Data Proc cluster.
name String
Name of the Data Proc subcluster.
securityGroupIds List<String>
serviceAccountId String
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
uiProxy Boolean
Whether UI proxy feature is enabled.
zoneId String
ID of the availability zone where the cluster resides.
bucket string
Name of the Object Storage bucket used for Data Proc jobs.
clusterConfigs GetDataprocClusterClusterConfig[]
Configuration and resources of the cluster. The structure is documented below.
clusterId string
createdAt string
The Data Proc cluster creation timestamp.
deletionProtection boolean
description string
Description of the Data Proc cluster.
folderId string
hostGroupIds string[]
A list of IDs of the host groups hosting VMs of the cluster.
id string
The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
A set of key/value label pairs assigned to the Data Proc cluster.
name string
Name of the Data Proc subcluster.
securityGroupIds string[]
serviceAccountId string
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
uiProxy boolean
Whether UI proxy feature is enabled.
zoneId string
ID of the availability zone where the cluster resides.
bucket str
Name of the Object Storage bucket used for Data Proc jobs.
cluster_configs Sequence[GetDataprocClusterClusterConfig]
Configuration and resources of the cluster. The structure is documented below.
cluster_id str
created_at str
The Data Proc cluster creation timestamp.
deletion_protection bool
description str
Description of the Data Proc cluster.
folder_id str
host_group_ids Sequence[str]
A list of IDs of the host groups hosting VMs of the cluster.
id str
The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
A set of key/value label pairs assigned to the Data Proc cluster.
name str
Name of the Data Proc subcluster.
security_group_ids Sequence[str]
service_account_id str
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
ui_proxy bool
Whether UI proxy feature is enabled.
zone_id str
ID of the availability zone where the cluster resides.
bucket String
Name of the Object Storage bucket used for Data Proc jobs.
clusterConfigs List<Property Map>
Configuration and resources of the cluster. The structure is documented below.
clusterId String
createdAt String
The Data Proc cluster creation timestamp.
deletionProtection Boolean
description String
Description of the Data Proc cluster.
folderId String
hostGroupIds List<String>
A list of IDs of the host groups hosting VMs of the cluster.
id String
The provider-assigned unique ID for this managed resource.
labels Map<String>
A set of key/value label pairs assigned to the Data Proc cluster.
name String
Name of the Data Proc subcluster.
securityGroupIds List<String>
serviceAccountId String
Service account used by the Data Proc agent to access resources of Yandex.Cloud.
uiProxy Boolean
Whether UI proxy feature is enabled.
zoneId String
ID of the availability zone where the cluster resides.

Supporting Types

GetDataprocClusterClusterConfig

Hadoops This property is required. List<GetDataprocClusterClusterConfigHadoop>
Data Proc specific options. The structure is documented below.
SubclusterSpecs This property is required. List<GetDataprocClusterClusterConfigSubclusterSpec>
Configuration of the Data Proc subcluster. The structure is documented below.
VersionId This property is required. string
Version of Data Proc image.
Hadoops This property is required. []GetDataprocClusterClusterConfigHadoop
Data Proc specific options. The structure is documented below.
SubclusterSpecs This property is required. []GetDataprocClusterClusterConfigSubclusterSpec
Configuration of the Data Proc subcluster. The structure is documented below.
VersionId This property is required. string
Version of Data Proc image.
hadoops This property is required. List<GetDataprocClusterClusterConfigHadoop>
Data Proc specific options. The structure is documented below.
subclusterSpecs This property is required. List<GetDataprocClusterClusterConfigSubclusterSpec>
Configuration of the Data Proc subcluster. The structure is documented below.
versionId This property is required. String
Version of Data Proc image.
hadoops This property is required. GetDataprocClusterClusterConfigHadoop[]
Data Proc specific options. The structure is documented below.
subclusterSpecs This property is required. GetDataprocClusterClusterConfigSubclusterSpec[]
Configuration of the Data Proc subcluster. The structure is documented below.
versionId This property is required. string
Version of Data Proc image.
hadoops This property is required. Sequence[GetDataprocClusterClusterConfigHadoop]
Data Proc specific options. The structure is documented below.
subcluster_specs This property is required. Sequence[GetDataprocClusterClusterConfigSubclusterSpec]
Configuration of the Data Proc subcluster. The structure is documented below.
version_id This property is required. str
Version of Data Proc image.
hadoops This property is required. List<Property Map>
Data Proc specific options. The structure is documented below.
subclusterSpecs This property is required. List<Property Map>
Configuration of the Data Proc subcluster. The structure is documented below.
versionId This property is required. String
Version of Data Proc image.

GetDataprocClusterClusterConfigHadoop

Properties This property is required. Dictionary<string, string>
A set of key/value pairs used to configure cluster services.
Services This property is required. List<string>
List of services launched on Data Proc cluster.
SshPublicKeys This property is required. List<string>
List of SSH public keys distributed to the hosts of the cluster.
Properties This property is required. map[string]string
A set of key/value pairs used to configure cluster services.
Services This property is required. []string
List of services launched on Data Proc cluster.
SshPublicKeys This property is required. []string
List of SSH public keys distributed to the hosts of the cluster.
properties This property is required. Map<String,String>
A set of key/value pairs used to configure cluster services.
services This property is required. List<String>
List of services launched on Data Proc cluster.
sshPublicKeys This property is required. List<String>
List of SSH public keys distributed to the hosts of the cluster.
properties This property is required. {[key: string]: string}
A set of key/value pairs used to configure cluster services.
services This property is required. string[]
List of services launched on Data Proc cluster.
sshPublicKeys This property is required. string[]
List of SSH public keys distributed to the hosts of the cluster.
properties This property is required. Mapping[str, str]
A set of key/value pairs used to configure cluster services.
services This property is required. Sequence[str]
List of services launched on Data Proc cluster.
ssh_public_keys This property is required. Sequence[str]
List of SSH public keys distributed to the hosts of the cluster.
properties This property is required. Map<String>
A set of key/value pairs used to configure cluster services.
services This property is required. List<String>
List of services launched on Data Proc cluster.
sshPublicKeys This property is required. List<String>
List of SSH public keys distributed to the hosts of the cluster.

GetDataprocClusterClusterConfigSubclusterSpec

AutoscalingConfigs This property is required. List<GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig>
Optional autoscaling configuration for compute subclusters.
HostsCount This property is required. int
Number of hosts within Data Proc subcluster.
Id This property is required. string
ID of the Data Proc subcluster.
Name This property is required. string
The name of the Data Proc cluster.
Resources This property is required. List<GetDataprocClusterClusterConfigSubclusterSpecResource>
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
Role This property is required. string
Role of the subcluster in the Data Proc cluster.
SubnetId This property is required. string
The ID of the subnet, to which hosts of the subcluster belong.
AutoscalingConfigs This property is required. []GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig
Optional autoscaling configuration for compute subclusters.
HostsCount This property is required. int
Number of hosts within Data Proc subcluster.
Id This property is required. string
ID of the Data Proc subcluster.
Name This property is required. string
The name of the Data Proc cluster.
Resources This property is required. []GetDataprocClusterClusterConfigSubclusterSpecResource
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
Role This property is required. string
Role of the subcluster in the Data Proc cluster.
SubnetId This property is required. string
The ID of the subnet, to which hosts of the subcluster belong.
autoscalingConfigs This property is required. List<GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig>
Optional autoscaling configuration for compute subclusters.
hostsCount This property is required. Integer
Number of hosts within Data Proc subcluster.
id This property is required. String
ID of the Data Proc subcluster.
name This property is required. String
The name of the Data Proc cluster.
resources This property is required. List<GetDataprocClusterClusterConfigSubclusterSpecResource>
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role This property is required. String
Role of the subcluster in the Data Proc cluster.
subnetId This property is required. String
The ID of the subnet, to which hosts of the subcluster belong.
autoscalingConfigs This property is required. GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig[]
Optional autoscaling configuration for compute subclusters.
hostsCount This property is required. number
Number of hosts within Data Proc subcluster.
id This property is required. string
ID of the Data Proc subcluster.
name This property is required. string
The name of the Data Proc cluster.
resources This property is required. GetDataprocClusterClusterConfigSubclusterSpecResource[]
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role This property is required. string
Role of the subcluster in the Data Proc cluster.
subnetId This property is required. string
The ID of the subnet, to which hosts of the subcluster belong.
autoscaling_configs This property is required. Sequence[GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig]
Optional autoscaling configuration for compute subclusters.
hosts_count This property is required. int
Number of hosts within Data Proc subcluster.
id This property is required. str
ID of the Data Proc subcluster.
name This property is required. str
The name of the Data Proc cluster.
resources This property is required. Sequence[GetDataprocClusterClusterConfigSubclusterSpecResource]
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role This property is required. str
Role of the subcluster in the Data Proc cluster.
subnet_id This property is required. str
The ID of the subnet, to which hosts of the subcluster belong.
autoscalingConfigs This property is required. List<Property Map>
Optional autoscaling configuration for compute subclusters.
hostsCount This property is required. Number
Number of hosts within Data Proc subcluster.
id This property is required. String
ID of the Data Proc subcluster.
name This property is required. String
The name of the Data Proc cluster.
resources This property is required. List<Property Map>
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role This property is required. String
Role of the subcluster in the Data Proc cluster.
subnetId This property is required. String
The ID of the subnet, to which hosts of the subcluster belong.

GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig

CpuUtilizationTarget This property is required. double
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
DecommissionTimeout This property is required. int
Timeout to gracefully decommission nodes during downscaling. In seconds.
MaxHostsCount This property is required. int
Maximum number of nodes in autoscaling subclusters.
MeasurementDuration This property is required. int
Time in seconds allotted for averaging metrics.
Preemptible This property is required. bool
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
StabilizationDuration This property is required. int
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
WarmupDuration This property is required. int
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
CpuUtilizationTarget This property is required. float64
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
DecommissionTimeout This property is required. int
Timeout to gracefully decommission nodes during downscaling. In seconds.
MaxHostsCount This property is required. int
Maximum number of nodes in autoscaling subclusters.
MeasurementDuration This property is required. int
Time in seconds allotted for averaging metrics.
Preemptible This property is required. bool
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
StabilizationDuration This property is required. int
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
WarmupDuration This property is required. int
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
cpuUtilizationTarget This property is required. Double
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
decommissionTimeout This property is required. Integer
Timeout to gracefully decommission nodes during downscaling. In seconds.
maxHostsCount This property is required. Integer
Maximum number of nodes in autoscaling subclusters.
measurementDuration This property is required. Integer
Time in seconds allotted for averaging metrics.
preemptible This property is required. Boolean
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
stabilizationDuration This property is required. Integer
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
warmupDuration This property is required. Integer
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
cpuUtilizationTarget This property is required. number
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
decommissionTimeout This property is required. number
Timeout to gracefully decommission nodes during downscaling. In seconds.
maxHostsCount This property is required. number
Maximum number of nodes in autoscaling subclusters.
measurementDuration This property is required. number
Time in seconds allotted for averaging metrics.
preemptible This property is required. boolean
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
stabilizationDuration This property is required. number
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
warmupDuration This property is required. number
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
cpu_utilization_target This property is required. float
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
decommission_timeout This property is required. int
Timeout to gracefully decommission nodes during downscaling. In seconds.
max_hosts_count This property is required. int
Maximum number of nodes in autoscaling subclusters.
measurement_duration This property is required. int
Time in seconds allotted for averaging metrics.
preemptible This property is required. bool
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
stabilization_duration This property is required. int
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
warmup_duration This property is required. int
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.
cpuUtilizationTarget This property is required. Number
Defines an autoscaling rule based on the average CPU utilization of the instance group. If not set default autoscaling metric will be used.
decommissionTimeout This property is required. Number
Timeout to gracefully decommission nodes during downscaling. In seconds.
maxHostsCount This property is required. Number
Maximum number of nodes in autoscaling subclusters.
measurementDuration This property is required. Number
Time in seconds allotted for averaging metrics.
preemptible This property is required. Boolean
Bool flag -- whether to use preemptible compute instances. Preemptible instances are stopped at least once every 24 hours, and can be stopped at any time if their resources are needed by Compute. For more information, see Preemptible Virtual Machines.
stabilizationDuration This property is required. Number
Minimum amount of time in seconds allotted for monitoring before Instance Groups can reduce the number of instances in the group. During this time, the group size doesn't decrease, even if the new metric values indicate that it should.
warmupDuration This property is required. Number
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.

GetDataprocClusterClusterConfigSubclusterSpecResource

DiskSize This property is required. int
Volume of the storage available to a host, in gigabytes.
DiskTypeId This property is required. string
Type of the storage of a host.
ResourcePresetId This property is required. string
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.
DiskSize This property is required. int
Volume of the storage available to a host, in gigabytes.
DiskTypeId This property is required. string
Type of the storage of a host.
ResourcePresetId This property is required. string
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.
diskSize This property is required. Integer
Volume of the storage available to a host, in gigabytes.
diskTypeId This property is required. String
Type of the storage of a host.
resourcePresetId This property is required. String
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.
diskSize This property is required. number
Volume of the storage available to a host, in gigabytes.
diskTypeId This property is required. string
Type of the storage of a host.
resourcePresetId This property is required. string
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.
disk_size This property is required. int
Volume of the storage available to a host, in gigabytes.
disk_type_id This property is required. str
Type of the storage of a host.
resource_preset_id This property is required. str
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.
diskSize This property is required. Number
Volume of the storage available to a host, in gigabytes.
diskTypeId This property is required. String
Type of the storage of a host.
resourcePresetId This property is required. String
The ID of the preset for computational resources available to a host. All available presets are listed in the documentation.

Package Details

Repository
Yandex pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.