Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

getDataprocCluster

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; }
}
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
	})
}
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_dataproc_cluster(name="test")
pulumi.export("serviceAccountId", foo.service_account_id)
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;

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>
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]
func LookupDataprocCluster(ctx *Context, args *LookupDataprocClusterArgs, opts ...InvokeOption) (*LookupDataprocClusterResult, error)
func LookupDataprocClusterOutput(ctx *Context, args *LookupDataprocClusterOutputArgs, opts ...InvokeOption) LookupDataprocClusterResultOutput

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

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.
cluster_id str
The ID of the Data Proc cluster.
name str
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.
ClusterConfig 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.
ClusterConfig 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.
clusterConfig 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_config 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.

Supporting Types

GetDataprocClusterClusterConfig

Hadoop GetDataprocClusterClusterConfigHadoop
Data Proc specific options. The structure is documented below.
SubclusterSpecs List<GetDataprocClusterClusterConfigSubclusterSpec>
Configuration of the Data Proc subcluster. The structure is documented below.
VersionId string
Version of Data Proc image.
Hadoop GetDataprocClusterClusterConfigHadoop
Data Proc specific options. The structure is documented below.
SubclusterSpecs []GetDataprocClusterClusterConfigSubclusterSpec
Configuration of the Data Proc subcluster. The structure is documented below.
VersionId string
Version of Data Proc image.
hadoop GetDataprocClusterClusterConfigHadoop
Data Proc specific options. The structure is documented below.
subclusterSpecs GetDataprocClusterClusterConfigSubclusterSpec[]
Configuration of the Data Proc subcluster. The structure is documented below.
versionId string
Version of Data Proc image.
hadoop GetDataprocClusterClusterConfigHadoop
Data Proc specific options. The structure is documented below.
subcluster_specs Sequence[GetDataprocClusterClusterConfigSubclusterSpec]
Configuration of the Data Proc subcluster. The structure is documented below.
version_id str
Version of Data Proc image.

GetDataprocClusterClusterConfigHadoop

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

GetDataprocClusterClusterConfigSubclusterSpec

AutoscalingConfig GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig
Optional autoscaling configuration for compute subclusters.
HostsCount int
Number of hosts within Data Proc subcluster.
Id string
ID of the Data Proc subcluster.
Name string
The name of the Data Proc cluster.
Resources GetDataprocClusterClusterConfigSubclusterSpecResources
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
Role string
Role of the subcluster in the Data Proc cluster.
SubnetId string
The ID of the subnet, to which hosts of the subcluster belong.
AutoscalingConfig GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig
Optional autoscaling configuration for compute subclusters.
HostsCount int
Number of hosts within Data Proc subcluster.
Id string
ID of the Data Proc subcluster.
Name string
The name of the Data Proc cluster.
Resources GetDataprocClusterClusterConfigSubclusterSpecResources
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
Role string
Role of the subcluster in the Data Proc cluster.
SubnetId string
The ID of the subnet, to which hosts of the subcluster belong.
autoscalingConfig GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig
Optional autoscaling configuration for compute subclusters.
hostsCount number
Number of hosts within Data Proc subcluster.
id string
ID of the Data Proc subcluster.
name string
The name of the Data Proc cluster.
resources GetDataprocClusterClusterConfigSubclusterSpecResources
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role string
Role of the subcluster in the Data Proc cluster.
subnetId string
The ID of the subnet, to which hosts of the subcluster belong.
autoscaling_config GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig
Optional autoscaling configuration for compute subclusters.
hosts_count int
Number of hosts within Data Proc subcluster.
id str
ID of the Data Proc subcluster.
name str
The name of the Data Proc cluster.
resources GetDataprocClusterClusterConfigSubclusterSpecResources
Resources allocated to each host of the Data Proc subcluster. The structure is documented below.
role str
Role of the subcluster in the Data Proc cluster.
subnet_id str
The ID of the subnet, to which hosts of the subcluster belong.

GetDataprocClusterClusterConfigSubclusterSpecAutoscalingConfig

CpuUtilizationTarget 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 int
Timeout to gracefully decommission nodes during downscaling. In seconds.
MaxHostsCount int
Maximum number of nodes in autoscaling subclusters.
MeasurementDuration int
Time in seconds allotted for averaging metrics.
Preemptible 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 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 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 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 int
Timeout to gracefully decommission nodes during downscaling. In seconds.
MaxHostsCount int
Maximum number of nodes in autoscaling subclusters.
MeasurementDuration int
Time in seconds allotted for averaging metrics.
Preemptible 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 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 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 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 number
Timeout to gracefully decommission nodes during downscaling. In seconds.
maxHostsCount number
Maximum number of nodes in autoscaling subclusters.
measurementDuration number
Time in seconds allotted for averaging metrics.
preemptible 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 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 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 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 int
Timeout to gracefully decommission nodes during downscaling. In seconds.
max_hosts_count int
Maximum number of nodes in autoscaling subclusters.
measurement_duration int
Time in seconds allotted for averaging metrics.
preemptible 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 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 int
The warmup time of the instance in seconds. During this time, traffic is sent to the instance, but instance metrics are not collected.

GetDataprocClusterClusterConfigSubclusterSpecResources

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

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.