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

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.dataproc/v1.getNodeGroup

Explore with Pulumi AI

google-native logo

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

    Gets the resource representation for a node group in a cluster.

    Using getNodeGroup

    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 getNodeGroup(args: GetNodeGroupArgs, opts?: InvokeOptions): Promise<GetNodeGroupResult>
function getNodeGroupOutput(args: GetNodeGroupOutputArgs, opts?: InvokeOptions): Output<GetNodeGroupResult>
    def get_node_group(cluster_id: Optional[str] = None,
                   node_group_id: Optional[str] = None,
                   project: Optional[str] = None,
                   region_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNodeGroupResult
def get_node_group_output(cluster_id: Optional[pulumi.Input[str]] = None,
                   node_group_id: Optional[pulumi.Input[str]] = None,
                   project: Optional[pulumi.Input[str]] = None,
                   region_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetNodeGroupResult]
    func LookupNodeGroup(ctx *Context, args *LookupNodeGroupArgs, opts ...InvokeOption) (*LookupNodeGroupResult, error)
func LookupNodeGroupOutput(ctx *Context, args *LookupNodeGroupOutputArgs, opts ...InvokeOption) LookupNodeGroupResultOutput

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

    public static class GetNodeGroup 
{
    public static Task<GetNodeGroupResult> InvokeAsync(GetNodeGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNodeGroupResult> Invoke(GetNodeGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNodeGroupResult> getNodeGroup(GetNodeGroupArgs args, InvokeOptions options)
public static Output<GetNodeGroupResult> getNodeGroup(GetNodeGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: google-native:dataproc/v1:getNodeGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterId string
    NodeGroupId string
    RegionId string
    Project string
    ClusterId string
    NodeGroupId string
    RegionId string
    Project string
    clusterId String
    nodeGroupId String
    regionId String
    project String
    clusterId string
    nodeGroupId string
    regionId string
    project string
    clusterId String
    nodeGroupId String
    regionId String
    project String

    getNodeGroup Result

    The following output properties are available:

    Labels Dictionary<string, string>
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    Name string
    The Node group resource name (https://aip.dev/122).
    NodeGroupConfig Pulumi.GoogleNative.Dataproc.V1.Outputs.InstanceGroupConfigResponse
    Optional. The node group instance group configuration.
    Roles List<string>
    Node group roles.
    Labels map[string]string
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    Name string
    The Node group resource name (https://aip.dev/122).
    NodeGroupConfig InstanceGroupConfigResponse
    Optional. The node group instance group configuration.
    Roles []string
    Node group roles.
    labels Map<String,String>
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    name String
    The Node group resource name (https://aip.dev/122).
    nodeGroupConfig InstanceGroupConfigResponse
    Optional. The node group instance group configuration.
    roles List<String>
    Node group roles.
    labels {[key: string]: string}
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    name string
    The Node group resource name (https://aip.dev/122).
    nodeGroupConfig InstanceGroupConfigResponse
    Optional. The node group instance group configuration.
    roles string[]
    Node group roles.
    labels Mapping[str, str]
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    name str
    The Node group resource name (https://aip.dev/122).
    node_group_config InstanceGroupConfigResponse
    Optional. The node group instance group configuration.
    roles Sequence[str]
    Node group roles.
    labels Map<String>
    Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
    name String
    The Node group resource name (https://aip.dev/122).
    nodeGroupConfig Property Map
    Optional. The node group instance group configuration.
    roles List<String>
    Node group roles.

    Supporting Types

    AcceleratorConfigResponse

    AcceleratorCount int
    The number of the accelerator cards of this type exposed to this instance.
    AcceleratorTypeUri string
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
    AcceleratorCount int
    The number of the accelerator cards of this type exposed to this instance.
    AcceleratorTypeUri string
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
    acceleratorCount Integer
    The number of the accelerator cards of this type exposed to this instance.
    acceleratorTypeUri String
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
    acceleratorCount number
    The number of the accelerator cards of this type exposed to this instance.
    acceleratorTypeUri string
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
    accelerator_count int
    The number of the accelerator cards of this type exposed to this instance.
    accelerator_type_uri str
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
    acceleratorCount Number
    The number of the accelerator cards of this type exposed to this instance.
    acceleratorTypeUri String
    Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

    DiskConfigResponse

    BootDiskSizeGb int
    Optional. Size in GB of the boot disk (default is 500GB).
    BootDiskType string
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    LocalSsdInterface string
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    NumLocalSsds int
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
    BootDiskSizeGb int
    Optional. Size in GB of the boot disk (default is 500GB).
    BootDiskType string
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    LocalSsdInterface string
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    NumLocalSsds int
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
    bootDiskSizeGb Integer
    Optional. Size in GB of the boot disk (default is 500GB).
    bootDiskType String
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    localSsdInterface String
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    numLocalSsds Integer
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
    bootDiskSizeGb number
    Optional. Size in GB of the boot disk (default is 500GB).
    bootDiskType string
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    localSsdInterface string
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    numLocalSsds number
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
    boot_disk_size_gb int
    Optional. Size in GB of the boot disk (default is 500GB).
    boot_disk_type str
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    local_ssd_interface str
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    num_local_ssds int
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
    bootDiskSizeGb Number
    Optional. Size in GB of the boot disk (default is 500GB).
    bootDiskType String
    Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
    localSsdInterface String
    Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
    numLocalSsds Number
    Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.

    InstanceFlexibilityPolicyResponse

    InstanceSelectionList List<Pulumi.GoogleNative.Dataproc.V1.Inputs.InstanceSelectionResponse>
    Optional. List of instance selection options that the group will use when creating new VMs.
    InstanceSelectionResults List<Pulumi.GoogleNative.Dataproc.V1.Inputs.InstanceSelectionResultResponse>
    A list of instance selection results in the group.
    InstanceSelectionList []InstanceSelectionResponse
    Optional. List of instance selection options that the group will use when creating new VMs.
    InstanceSelectionResults []InstanceSelectionResultResponse
    A list of instance selection results in the group.
    instanceSelectionList List<InstanceSelectionResponse>
    Optional. List of instance selection options that the group will use when creating new VMs.
    instanceSelectionResults List<InstanceSelectionResultResponse>
    A list of instance selection results in the group.
    instanceSelectionList InstanceSelectionResponse[]
    Optional. List of instance selection options that the group will use when creating new VMs.
    instanceSelectionResults InstanceSelectionResultResponse[]
    A list of instance selection results in the group.
    instance_selection_list Sequence[InstanceSelectionResponse]
    Optional. List of instance selection options that the group will use when creating new VMs.
    instance_selection_results Sequence[InstanceSelectionResultResponse]
    A list of instance selection results in the group.
    instanceSelectionList List<Property Map>
    Optional. List of instance selection options that the group will use when creating new VMs.
    instanceSelectionResults List<Property Map>
    A list of instance selection results in the group.

    InstanceGroupConfigResponse

    Accelerators List<Pulumi.GoogleNative.Dataproc.V1.Inputs.AcceleratorConfigResponse>
    Optional. The Compute Engine accelerator configuration for these instances.
    DiskConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.DiskConfigResponse
    Optional. Disk option config settings.
    ImageUri string
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    InstanceFlexibilityPolicy Pulumi.GoogleNative.Dataproc.V1.Inputs.InstanceFlexibilityPolicyResponse
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    InstanceNames List<string>
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    InstanceReferences List<Pulumi.GoogleNative.Dataproc.V1.Inputs.InstanceReferenceResponse>
    List of references to Compute Engine instances.
    IsPreemptible bool
    Specifies that this instance group contains preemptible instances.
    MachineTypeUri string
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    ManagedGroupConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.ManagedGroupConfigResponse
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    MinCpuPlatform string
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    MinNumInstances int
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    NumInstances int
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    Preemptibility string
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    StartupConfig Pulumi.GoogleNative.Dataproc.V1.Inputs.StartupConfigResponse
    Optional. Configuration to handle the startup of instances during cluster create and update process.
    Accelerators []AcceleratorConfigResponse
    Optional. The Compute Engine accelerator configuration for these instances.
    DiskConfig DiskConfigResponse
    Optional. Disk option config settings.
    ImageUri string
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    InstanceFlexibilityPolicy InstanceFlexibilityPolicyResponse
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    InstanceNames []string
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    InstanceReferences []InstanceReferenceResponse
    List of references to Compute Engine instances.
    IsPreemptible bool
    Specifies that this instance group contains preemptible instances.
    MachineTypeUri string
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    ManagedGroupConfig ManagedGroupConfigResponse
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    MinCpuPlatform string
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    MinNumInstances int
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    NumInstances int
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    Preemptibility string
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    StartupConfig StartupConfigResponse
    Optional. Configuration to handle the startup of instances during cluster create and update process.
    accelerators List<AcceleratorConfigResponse>
    Optional. The Compute Engine accelerator configuration for these instances.
    diskConfig DiskConfigResponse
    Optional. Disk option config settings.
    imageUri String
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    instanceFlexibilityPolicy InstanceFlexibilityPolicyResponse
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    instanceNames List<String>
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    instanceReferences List<InstanceReferenceResponse>
    List of references to Compute Engine instances.
    isPreemptible Boolean
    Specifies that this instance group contains preemptible instances.
    machineTypeUri String
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    managedGroupConfig ManagedGroupConfigResponse
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    minCpuPlatform String
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    minNumInstances Integer
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    numInstances Integer
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    preemptibility String
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    startupConfig StartupConfigResponse
    Optional. Configuration to handle the startup of instances during cluster create and update process.
    accelerators AcceleratorConfigResponse[]
    Optional. The Compute Engine accelerator configuration for these instances.
    diskConfig DiskConfigResponse
    Optional. Disk option config settings.
    imageUri string
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    instanceFlexibilityPolicy InstanceFlexibilityPolicyResponse
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    instanceNames string[]
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    instanceReferences InstanceReferenceResponse[]
    List of references to Compute Engine instances.
    isPreemptible boolean
    Specifies that this instance group contains preemptible instances.
    machineTypeUri string
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    managedGroupConfig ManagedGroupConfigResponse
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    minCpuPlatform string
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    minNumInstances number
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    numInstances number
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    preemptibility string
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    startupConfig StartupConfigResponse
    Optional. Configuration to handle the startup of instances during cluster create and update process.
    accelerators Sequence[AcceleratorConfigResponse]
    Optional. The Compute Engine accelerator configuration for these instances.
    disk_config DiskConfigResponse
    Optional. Disk option config settings.
    image_uri str
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    instance_flexibility_policy InstanceFlexibilityPolicyResponse
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    instance_names Sequence[str]
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    instance_references Sequence[InstanceReferenceResponse]
    List of references to Compute Engine instances.
    is_preemptible bool
    Specifies that this instance group contains preemptible instances.
    machine_type_uri str
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    managed_group_config ManagedGroupConfigResponse
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    min_cpu_platform str
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    min_num_instances int
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    num_instances int
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    preemptibility str
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    startup_config StartupConfigResponse
    Optional. Configuration to handle the startup of instances during cluster create and update process.
    accelerators List<Property Map>
    Optional. The Compute Engine accelerator configuration for these instances.
    diskConfig Property Map
    Optional. Disk option config settings.
    imageUri String
    Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
    instanceFlexibilityPolicy Property Map
    Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.
    instanceNames List<String>
    The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    instanceReferences List<Property Map>
    List of references to Compute Engine instances.
    isPreemptible Boolean
    Specifies that this instance group contains preemptible instances.
    machineTypeUri String
    Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
    managedGroupConfig Property Map
    The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
    minCpuPlatform String
    Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
    minNumInstances Number
    Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.
    numInstances Number
    Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
    preemptibility String
    Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
    startupConfig Property Map
    Optional. Configuration to handle the startup of instances during cluster create and update process.

    InstanceReferenceResponse

    InstanceId string
    The unique identifier of the Compute Engine instance.
    InstanceName string
    The user-friendly name of the Compute Engine instance.
    PublicEciesKey string
    The public ECIES key used for sharing data with this instance.
    PublicKey string
    The public RSA key used for sharing data with this instance.
    InstanceId string
    The unique identifier of the Compute Engine instance.
    InstanceName string
    The user-friendly name of the Compute Engine instance.
    PublicEciesKey string
    The public ECIES key used for sharing data with this instance.
    PublicKey string
    The public RSA key used for sharing data with this instance.
    instanceId String
    The unique identifier of the Compute Engine instance.
    instanceName String
    The user-friendly name of the Compute Engine instance.
    publicEciesKey String
    The public ECIES key used for sharing data with this instance.
    publicKey String
    The public RSA key used for sharing data with this instance.
    instanceId string
    The unique identifier of the Compute Engine instance.
    instanceName string
    The user-friendly name of the Compute Engine instance.
    publicEciesKey string
    The public ECIES key used for sharing data with this instance.
    publicKey string
    The public RSA key used for sharing data with this instance.
    instance_id str
    The unique identifier of the Compute Engine instance.
    instance_name str
    The user-friendly name of the Compute Engine instance.
    public_ecies_key str
    The public ECIES key used for sharing data with this instance.
    public_key str
    The public RSA key used for sharing data with this instance.
    instanceId String
    The unique identifier of the Compute Engine instance.
    instanceName String
    The user-friendly name of the Compute Engine instance.
    publicEciesKey String
    The public ECIES key used for sharing data with this instance.
    publicKey String
    The public RSA key used for sharing data with this instance.

    InstanceSelectionResponse

    MachineTypes List<string>
    Optional. Full machine-type names, e.g. "n1-standard-16".
    Rank int
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
    MachineTypes []string
    Optional. Full machine-type names, e.g. "n1-standard-16".
    Rank int
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
    machineTypes List<String>
    Optional. Full machine-type names, e.g. "n1-standard-16".
    rank Integer
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
    machineTypes string[]
    Optional. Full machine-type names, e.g. "n1-standard-16".
    rank number
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
    machine_types Sequence[str]
    Optional. Full machine-type names, e.g. "n1-standard-16".
    rank int
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.
    machineTypes List<String>
    Optional. Full machine-type names, e.g. "n1-standard-16".
    rank Number
    Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.

    InstanceSelectionResultResponse

    MachineType string
    Full machine-type names, e.g. "n1-standard-16".
    VmCount int
    Number of VM provisioned with the machine_type.
    MachineType string
    Full machine-type names, e.g. "n1-standard-16".
    VmCount int
    Number of VM provisioned with the machine_type.
    machineType String
    Full machine-type names, e.g. "n1-standard-16".
    vmCount Integer
    Number of VM provisioned with the machine_type.
    machineType string
    Full machine-type names, e.g. "n1-standard-16".
    vmCount number
    Number of VM provisioned with the machine_type.
    machine_type str
    Full machine-type names, e.g. "n1-standard-16".
    vm_count int
    Number of VM provisioned with the machine_type.
    machineType String
    Full machine-type names, e.g. "n1-standard-16".
    vmCount Number
    Number of VM provisioned with the machine_type.

    ManagedGroupConfigResponse

    InstanceGroupManagerName string
    The name of the Instance Group Manager for this group.
    InstanceGroupManagerUri string
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    InstanceTemplateName string
    The name of the Instance Template used for the Managed Instance Group.
    InstanceGroupManagerName string
    The name of the Instance Group Manager for this group.
    InstanceGroupManagerUri string
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    InstanceTemplateName string
    The name of the Instance Template used for the Managed Instance Group.
    instanceGroupManagerName String
    The name of the Instance Group Manager for this group.
    instanceGroupManagerUri String
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    instanceTemplateName String
    The name of the Instance Template used for the Managed Instance Group.
    instanceGroupManagerName string
    The name of the Instance Group Manager for this group.
    instanceGroupManagerUri string
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    instanceTemplateName string
    The name of the Instance Template used for the Managed Instance Group.
    instance_group_manager_name str
    The name of the Instance Group Manager for this group.
    instance_group_manager_uri str
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    instance_template_name str
    The name of the Instance Template used for the Managed Instance Group.
    instanceGroupManagerName String
    The name of the Instance Group Manager for this group.
    instanceGroupManagerUri String
    The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.
    instanceTemplateName String
    The name of the Instance Template used for the Managed Instance Group.

    StartupConfigResponse

    RequiredRegistrationFraction double
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).
    RequiredRegistrationFraction float64
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).
    requiredRegistrationFraction Double
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).
    requiredRegistrationFraction number
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).
    required_registration_fraction float
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).
    requiredRegistrationFraction Number
    Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).

    Package Details

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

    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