このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

gcp_dataproc_cluster

ancestors

Type: UNORDERED_LIST_STRING

cluster_name

Type: STRING
Provider name: clusterName
Description: Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.

cluster_uuid

Type: STRING
Provider name: clusterUuid
Description: Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

config

Type: STRUCT
Provider name: config
Description: Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.Exactly one of ClusterConfig or VirtualClusterConfig must be specified.

  • autoscaling_config
    Type: STRUCT
    Provider name: autoscalingConfig
    Description: Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
  • auxiliary_node_groups
    Type: UNORDERED_LIST_STRUCT
    Provider name: auxiliaryNodeGroups
    Description: Optional. The node group settings.
    • node_group
      Type: STRUCT
      Provider name: nodeGroup
      Description: Required. Node group configuration.
      • name
        Type: STRING
        Provider name: name
        Description: The Node group resource name.
      • node_group_config
        Type: STRUCT
        Provider name: nodeGroupConfig
        Description: Optional. The node group instance group configuration.
        • accelerators
          Type: UNORDERED_LIST_STRUCT
          Provider name: accelerators
          Description: Optional. The Compute Engine accelerator configuration for these instances.
        • disk_config
          Type: STRUCT
          Provider name: diskConfig
          Description: Optional. Disk option config settings.
          • boot_disk_size_gb
            Type: INT32
            Provider name: bootDiskSizeGb
            Description: Optional. Size in GB of the boot disk (default is 500GB).
          • boot_disk_type
            Type: STRING
            Provider name: bootDiskType
            Description: 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.
          • local_ssd_interface
            Type: STRING
            Provider name: localSsdInterface
            Description: 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.
          • num_local_ssds
            Type: INT32
            Provider name: numLocalSsds
            Description: 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 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.
        • image_uri
          Type: STRING
          Provider name: imageUri
          Description: Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples:

          Image family examples. Dataproc will use the most recent image from the family:

          If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

        • instance_names
          Type: UNORDERED_LIST_STRING
          Provider name: instanceNames
          Description: Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
        • instance_references
          Type: UNORDERED_LIST_STRUCT
          Provider name: instanceReferences
          Description: Output only. List of references to Compute Engine instances.
          • instance_id
            Type: STRING
            Provider name: instanceId
            Description: The unique identifier of the Compute Engine instance.
          • instance_name
            Type: STRING
            Provider name: instanceName
            Description: The user-friendly name of the Compute Engine instance.
          • public_ecies_key
            Type: STRING
            Provider name: publicEciesKey
            Description: The public ECIES key used for sharing data with this instance.
          • public_key
            Type: STRING
            Provider name: publicKey
            Description: The public RSA key used for sharing data with this instance.
        • is_preemptible
          Type: BOOLEAN
          Provider name: isPreemptible
          Description: Output only. Specifies that this instance group contains preemptible instances.
        • machine_type_uri
          Type: STRING
          Provider name: machineTypeUri
          Description: Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples:

          Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

        • managed_group_config
          Type: STRUCT
          Provider name: managedGroupConfig
          Description: Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
          • instance_group_manager_name
            Type: STRING
            Provider name: instanceGroupManagerName
            Description: Output only. The name of the Instance Group Manager for this group.
          • instance_template_name
            Type: STRING
            Provider name: instanceTemplateName
            Description: Output only. The name of the Instance Template used for the Managed Instance Group.
        • min_cpu_platform
          Type: STRING
          Provider name: minCpuPlatform
          Description: Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
        • num_instances
          Type: INT32
          Provider name: numInstances
          Description: 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
          Type: STRING
          Provider name: preemptibility
          Description: 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.
          Possible values:
          • PREEMPTIBILITY_UNSPECIFIED - Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.
          • NON_PREEMPTIBLE - Instances are non-preemptible. This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.
          • PREEMPTIBLE - Instances are preemptible. This option is allowed only for secondary worker groups.
          • SPOT - Instances are Spot VMs. This option is allowed only for secondary worker groups. Spot VMs are the latest version of preemptible VMs, and provide additional features.
      • roles
        Type: UNORDERED_LIST_STRING
        Provider name: roles
        Description: Required. Node group roles.
    • node_group_id
      Type: STRING
      Provider name: nodeGroupId
      Description: Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.
  • config_bucket
    Type: STRING
    Provider name: configBucket
    Description: Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster’s staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets). This field requires a Cloud Storage bucket name, not a gs://… URI to a Cloud Storage bucket.
  • dataproc_metric_config
    Type: STRUCT
    Provider name: dataprocMetricConfig
    Description: Optional. The config for Dataproc metrics.
    • metrics
      Type: UNORDERED_LIST_STRUCT
      Provider name: metrics
      Description: Required. Metrics sources to enable.
      • metric_overrides
        Type: UNORDERED_LIST_STRING
        Provider name: metricOverrides
        Description: Optional. Specify one or more available OSS metrics to collect for the metric course (for the SPARK metric source, any Spark metric can be specified). Provide metrics in the following format: METRIC_SOURCE: INSTANCE:GROUP:METRIC. Use camelcase as appropriate. Examples:
        • yarn:ResourceManager:QueueMetrics:AppsCompleted
        • spark:driver:DAGScheduler:job.allJobs
        • sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed
        • hiveserver2:JVM:Memory:NonHeapMemoryUsage.used
        Notes: Only the specified overridden metrics will be collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics will not be collected. The collection of the default metrics for other OSS metric sources is unaffected. For example, if both SPARK andd YARN metric sources are enabled, and overrides are provided for Spark metrics only, all default YARN metrics will be collected.
      • metric_source
        Type: STRING
        Provider name: metricSource
        Description: Required. Default metrics are collected unless metricOverrides are specified for the metric source (see Available OSS metrics for more information).
        Possible values:
        • METRIC_SOURCE_UNSPECIFIED - Required unspecified metric source.
        • MONITORING_AGENT_DEFAULTS - Default monitoring agent metrics. If this source is enabled, Dataproc enables the monitoring agent in Compute Engine, and collects default monitoring agent metrics, which are published with an agent.googleapis.com prefix.
        • HDFS - HDFS metric source.
        • SPARK - Spark metric source.
        • YARN - YARN metric source.
        • SPARK_HISTORY_SERVER - Spark History Server metric source.
        • HIVESERVER2 - Hiveserver2 metric source.
  • encryption_config
    Type: STRUCT
    Provider name: encryptionConfig
    Description: Optional. Encryption settings for the cluster.
    • gce_pd_kms_key_name
      Type: STRING
      Provider name: gcePdKmsKeyName
      Description: Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
  • endpoint_config
    Type: STRUCT
    Provider name: endpointConfig
    Description: Optional. Port/endpoint configuration for this cluster
    • enable_http_port_access
      Type: BOOLEAN
      Provider name: enableHttpPortAccess
      Description: Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
  • gce_cluster_config
    Type: STRUCT
    Provider name: gceClusterConfig
    Description: Optional. The shared Compute Engine config settings for all instances in a cluster.
    • confidential_instance_config
      Type: STRUCT
      Provider name: confidentialInstanceConfig
      Description: Optional. Confidential Instance Config for clusters using Confidential VMs.
      • enable_confidential_compute
        Type: BOOLEAN
        Provider name: enableConfidentialCompute
        Description: Optional. Defines whether the instance should have confidential compute enabled.
    • internal_ip_only
      Type: BOOLEAN
      Provider name: internalIpOnly
      Description: Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
    • network_uri
      Type: STRING
      Provider name: networkUri
      Description: Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the “default” network of the project is used, if it exists. Cannot be a “Custom Subnet Network” (see Using Subnetworks for more information). A full URL, partial URI, or short name are valid. Examples:
    • node_group_affinity
      Type: STRUCT
      Provider name: nodeGroupAffinity
      Description: Optional. Node Group Affinity for sole-tenant clusters.
    • private_ipv6_google_access
      Type: STRING
      Provider name: privateIpv6GoogleAccess
      Description: Optional. The type of IPv6 access for a cluster.
      Possible values:
      • PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED - If unspecified, Compute Engine default behavior will apply, which is the same as INHERIT_FROM_SUBNETWORK.
      • INHERIT_FROM_SUBNETWORK - Private access to and from Google Services configuration inherited from the subnetwork configuration. This is the default Compute Engine behavior.
      • OUTBOUND - Enables outbound private IPv6 access to Google Services from the Dataproc cluster.
      • BIDIRECTIONAL - Enables bidirectional private IPv6 access between Google Services and the Dataproc cluster.
    • reservation_affinity
      Type: STRUCT
      Provider name: reservationAffinity
      Description: Optional. Reservation Affinity for consuming Zonal reservation.
      • consume_reservation_type
        Type: STRING
        Provider name: consumeReservationType
        Description: Optional. Type of reservation to consume
        Possible values:
        • TYPE_UNSPECIFIED
        • NO_RESERVATION - Do not consume from any allocated capacity.
        • ANY_RESERVATION - Consume any reservation available.
        • SPECIFIC_RESERVATION - Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
      • key
        Type: STRING
        Provider name: key
        Description: Optional. Corresponds to the label key of reservation resource.
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: values
        Description: Optional. Corresponds to the label values of reservation resource.
    • service_account
      Type: STRING
      Provider name: serviceAccount
      Description: Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account is used.
    • service_account_scopes
      Type: UNORDERED_LIST_STRING
      Provider name: serviceAccountScopes
      Description: Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:If no scopes are specified, the following defaults are also provided:
    • shielded_instance_config
      Type: STRUCT
      Provider name: shieldedInstanceConfig
      Description: Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs.
      • enable_integrity_monitoring
        Type: BOOLEAN
        Provider name: enableIntegrityMonitoring
        Description: Optional. Defines whether instances have integrity monitoring enabled.
      • enable_secure_boot
        Type: BOOLEAN
        Provider name: enableSecureBoot
        Description: Optional. Defines whether instances have Secure Boot enabled.
      • enable_vtpm
        Type: BOOLEAN
        Provider name: enableVtpm
        Description: Optional. Defines whether instances have the vTPM enabled.
    • subnetwork_uri
      Type: STRING
      Provider name: subnetworkUri
      Description: Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. A full URL, partial URI, or short name are valid. Examples:
    • zone_uri
      Type: STRING
      Provider name: zoneUri
      Description: Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the “global” region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present. A full URL, partial URI, or short name are valid. Examples:
  • gke_cluster_config
    Type: STRUCT
    Provider name: gkeClusterConfig
    Description: Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. These config settings are mutually exclusive with Compute Engine-based options, such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.
    • gke_cluster_target
      Type: STRING
      Provider name: gkeClusterTarget
      Description: Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: ‘projects/{project}/locations/{location}/clusters/{cluster_id}’
    • namespaced_gke_deployment_target
      Type: STRUCT
      Provider name: namespacedGkeDeploymentTarget
      Description: Optional. Deprecated. Use gkeClusterTarget. Used only for the deprecated beta. A target for the deployment.
      • cluster_namespace
        Type: STRING
        Provider name: clusterNamespace
        Description: Optional. A namespace within the GKE cluster to deploy into.
      • target_gke_cluster
        Type: STRING
        Provider name: targetGkeCluster
        Description: Optional. The target GKE cluster to deploy to. Format: ‘projects/{project}/locations/{location}/clusters/{cluster_id}’
    • node_pool_target
      Type: UNORDERED_LIST_STRUCT
      Provider name: nodePoolTarget
      Description: Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings.
      • node_pool
        Type: STRING
        Provider name: nodePool
        Description: Required. The target GKE node pool. Format: ‘projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}’
      • node_pool_config
        Type: STRUCT
        Provider name: nodePoolConfig
        Description: Input only. The configuration for the GKE node pool.If specified, Dataproc attempts to create a node pool with the specified shape. If one with the same name already exists, it is verified against all specified fields. If a field differs, the virtual cluster creation will fail.If omitted, any node pool with the specified name is used. If a node pool with the specified name does not exist, Dataproc create a node pool with default values.This is an input only field. It will not be returned by the API.
        • autoscaling
          Type: STRUCT
          Provider name: autoscaling
          Description: Optional. The autoscaler configuration for this node pool. The autoscaler is enabled only when a valid configuration is present.
          • max_node_count
            Type: INT32
            Provider name: maxNodeCount
            Description: The maximum number of nodes in the node pool. Must be >= min_node_count, and must be > 0. Note: Quota must be sufficient to scale up the cluster.
          • min_node_count
            Type: INT32
            Provider name: minNodeCount
            Description: The minimum number of nodes in the node pool. Must be >= 0 and <= max_node_count.
        • config
          Type: STRUCT
          Provider name: config
          Description: Optional. The node pool configuration.
          • accelerators
            Type: UNORDERED_LIST_STRUCT
            Provider name: accelerators
            Description: Optional. A list of hardware accelerators to attach to each node.
            • accelerator_count
              Type: INT64
              Provider name: acceleratorCount
              Description: The number of accelerator cards exposed to an instance.
            • accelerator_type
              Type: STRING
              Provider name: acceleratorType
              Description: The accelerator type resource namename (see GPUs on Compute Engine).
            • gpu_partition_size
              Type: STRING
              Provider name: gpuPartitionSize
              Description: Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide.
          • boot_disk_kms_key
            Type: STRING
            Provider name: bootDiskKmsKey
            Description: Optional. The Customer Managed Encryption Key (CMEK) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION /keyRings/RING_NAME/cryptoKeys/KEY_NAME.
          • local_ssd_count
            Type: INT32
            Provider name: localSsdCount
            Description: Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs).
          • machine_type
            Type: STRING
            Provider name: machineType
            Description: Optional. The name of a Compute Engine machine type.
          • min_cpu_platform
            Type: STRING
            Provider name: minCpuPlatform
            Description: Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as “Intel Haswell” or “Intel Sandy Bridge”.
          • preemptible
            Type: BOOLEAN
            Provider name: preemptible
            Description: Optional. Whether the nodes are created as legacy preemptible VM instances. Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).
          • spot
            Type: BOOLEAN
            Provider name: spot
            Description: Optional. Whether the nodes are created as Spot VM instances. Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).
        • locations
          Type: UNORDERED_LIST_STRING
          Provider name: locations
          Description: Optional. The list of Compute Engine zones where node pool nodes associated with a Dataproc on GKE virtual cluster will be located. Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region. If a location is not specified during node pool creation, Dataproc on GKE will choose the zone.
      • roles
        Type: UNORDERED_LIST_STRING
        Provider name: roles
        Description: Required. The roles associated with the GKE node pool.
  • initialization_actions
    Type: UNORDERED_LIST_STRUCT
    Provider name: initializationActions
    Description: Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node’s role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ “${ROLE}” == ‘Master’ ]]; then … master specific actions … else … worker specific actions … fi
    • executable_file
      Type: STRING
      Provider name: executableFile
      Description: Required. Cloud Storage URI of executable file.
    • execution_timeout
      Type: STRING
      Provider name: executionTimeout
      Description: Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration). Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
  • lifecycle_config
    Type: STRUCT
    Provider name: lifecycleConfig
    Description: Optional. Lifecycle setting for the cluster.
    • auto_delete_time
      Type: TIMESTAMP
      Provider name: autoDeleteTime
      Description: Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp).
    • auto_delete_ttl
      Type: STRING
      Provider name: autoDeleteTtl
      Description: Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration).
    • idle_delete_ttl
      Type: STRING
      Provider name: idleDeleteTtl
      Description: Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration).
    • idle_start_time
      Type: TIMESTAMP
      Provider name: idleStartTime
      Description: Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp).
  • master_config
    Type: STRUCT
    Provider name: masterConfig
    Description: Optional. The Compute Engine config settings for the cluster’s master instance.
    • accelerators
      Type: UNORDERED_LIST_STRUCT
      Provider name: accelerators
      Description: Optional. The Compute Engine accelerator configuration for these instances.
    • disk_config
      Type: STRUCT
      Provider name: diskConfig
      Description: Optional. Disk option config settings.
      • boot_disk_size_gb
        Type: INT32
        Provider name: bootDiskSizeGb
        Description: Optional. Size in GB of the boot disk (default is 500GB).
      • boot_disk_type
        Type: STRING
        Provider name: bootDiskType
        Description: 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.
      • local_ssd_interface
        Type: STRING
        Provider name: localSsdInterface
        Description: 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.
      • num_local_ssds
        Type: INT32
        Provider name: numLocalSsds
        Description: 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 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.
    • image_uri
      Type: STRING
      Provider name: imageUri
      Description: Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples:

      Image family examples. Dataproc will use the most recent image from the family:

      If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    • instance_names
      Type: UNORDERED_LIST_STRING
      Provider name: instanceNames
      Description: Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    • instance_references
      Type: UNORDERED_LIST_STRUCT
      Provider name: instanceReferences
      Description: Output only. List of references to Compute Engine instances.
      • instance_id
        Type: STRING
        Provider name: instanceId
        Description: The unique identifier of the Compute Engine instance.
      • instance_name
        Type: STRING
        Provider name: instanceName
        Description: The user-friendly name of the Compute Engine instance.
      • public_ecies_key
        Type: STRING
        Provider name: publicEciesKey
        Description: The public ECIES key used for sharing data with this instance.
      • public_key
        Type: STRING
        Provider name: publicKey
        Description: The public RSA key used for sharing data with this instance.
    • is_preemptible
      Type: BOOLEAN
      Provider name: isPreemptible
      Description: Output only. Specifies that this instance group contains preemptible instances.
    • machine_type_uri
      Type: STRING
      Provider name: machineTypeUri
      Description: Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples:

      Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

    • managed_group_config
      Type: STRUCT
      Provider name: managedGroupConfig
      Description: Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
      • instance_group_manager_name
        Type: STRING
        Provider name: instanceGroupManagerName
        Description: Output only. The name of the Instance Group Manager for this group.
      • instance_template_name
        Type: STRING
        Provider name: instanceTemplateName
        Description: Output only. The name of the Instance Template used for the Managed Instance Group.
    • min_cpu_platform
      Type: STRING
      Provider name: minCpuPlatform
      Description: Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
    • num_instances
      Type: INT32
      Provider name: numInstances
      Description: 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
      Type: STRING
      Provider name: preemptibility
      Description: 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.
      Possible values:
      • PREEMPTIBILITY_UNSPECIFIED - Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.
      • NON_PREEMPTIBLE - Instances are non-preemptible. This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.
      • PREEMPTIBLE - Instances are preemptible. This option is allowed only for secondary worker groups.
      • SPOT - Instances are Spot VMs.This option is allowed only for secondary worker groups. Spot VMs are the latest version of preemptible VMs, and provide additional features.
  • metastore_config
    Type: STRUCT
    Provider name: metastoreConfig
    Description: Optional. Metastore configuration.
    • dataproc_metastore_service
      Type: STRING
      Provider name: dataprocMetastoreService
      Description: Required. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name]
  • secondary_worker_config
    Type: STRUCT
    Provider name: secondaryWorkerConfig
    Description: Optional. The Compute Engine config settings for a cluster’s secondary worker instances
    • accelerators
      Type: UNORDERED_LIST_STRUCT
      Provider name: accelerators
      Description: Optional. The Compute Engine accelerator configuration for these instances.
    • disk_config
      Type: STRUCT
      Provider name: diskConfig
      Description: Optional. Disk option config settings.
      • boot_disk_size_gb
        Type: INT32
        Provider name: bootDiskSizeGb
        Description: Optional. Size in GB of the boot disk (default is 500GB).
      • boot_disk_type
        Type: STRING
        Provider name: bootDiskType
        Description: 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.
      • local_ssd_interface
        Type: STRING
        Provider name: localSsdInterface
        Description: 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.
      • num_local_ssds
        Type: INT32
        Provider name: numLocalSsds
        Description: 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 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.
    • image_uri
      Type: STRING
      Provider name: imageUri
      Description: Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples:

      Image family examples. Dataproc will use the most recent image from the family:

      If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    • instance_names
      Type: UNORDERED_LIST_STRING
      Provider name: instanceNames
      Description: Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    • instance_references
      Type: UNORDERED_LIST_STRUCT
      Provider name: instanceReferences
      Description: Output only. List of references to Compute Engine instances.
      • instance_id
        Type: STRING
        Provider name: instanceId
        Description: The unique identifier of the Compute Engine instance.
      • instance_name
        Type: STRING
        Provider name: instanceName
        Description: The user-friendly name of the Compute Engine instance.
      • public_ecies_key
        Type: STRING
        Provider name: publicEciesKey
        Description: The public ECIES key used for sharing data with this instance.
      • public_key
        Type: STRING
        Provider name: publicKey
        Description: The public RSA key used for sharing data with this instance.
    • is_preemptible
      Type: BOOLEAN
      Provider name: isPreemptible
      Description: Output only. Specifies that this instance group contains preemptible instances.
    • machine_type_uri
      Type: STRING
      Provider name: machineTypeUri
      Description: Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples:

      Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

    • managed_group_config
      Type: STRUCT
      Provider name: managedGroupConfig
      Description: Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
      • instance_group_manager_name
        Type: STRING
        Provider name: instanceGroupManagerName
        Description: Output only. The name of the Instance Group Manager for this group.
      • instance_template_name
        Type: STRING
        Provider name: instanceTemplateName
        Description: Output only. The name of the Instance Template used for the Managed Instance Group.
    • min_cpu_platform
      Type: STRING
      Provider name: minCpuPlatform
      Description: Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
    • num_instances
      Type: INT32
      Provider name: numInstances
      Description: 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
      Type: STRING
      Provider name: preemptibility
      Description: 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.
      Possible values:
      • PREEMPTIBILITY_UNSPECIFIED - Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.
      • NON_PREEMPTIBLE - Instances are non-preemptible.This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.
      • PREEMPTIBLE - Instances are preemptible. This option is allowed only for secondary worker groups.
      • SPOT - Instances are Spot VMs.This option is allowed only for secondary worker groups. Spot VMs are the latest version of preemptible VMs, and provide additional features.
  • security_config
    Type: STRUCT
    Provider name: securityConfig
    Description: Optional. Security settings for the cluster.
    • identity_config
      Type: STRUCT
      Provider name: identityConfig
      Description: Optional. Identity related configuration, including service account based secure multi-tenancy user mappings.

    • kerberos_config
      Type: STRUCT
      Provider name: kerberosConfig
      Description: Optional. Kerberos related configuration.

      • cross_realm_trust_admin_server
        Type: STRING
        Provider name: crossRealmTrustAdminServer
        Description: Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
      • cross_realm_trust_kdc
        Type: STRING
        Provider name: crossRealmTrustKdc
        Description: Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
      • cross_realm_trust_realm
        Type: STRING
        Provider name: crossRealmTrustRealm
        Description: Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
      • cross_realm_trust_shared_password_uri
        Type: STRING
        Provider name: crossRealmTrustSharedPasswordUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
      • enable_kerberos
        Type: BOOLEAN
        Provider name: enableKerberos
        Description: Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
      • kdc_db_key_uri
        Type: STRING
        Provider name: kdcDbKeyUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
      • key_password_uri
        Type: STRING
        Provider name: keyPasswordUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
      • keystore_password_uri
        Type: STRING
        Provider name: keystorePasswordUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
      • keystore_uri
        Type: STRING
        Provider name: keystoreUri
        Description: Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
      • kms_key_uri
        Type: STRING
        Provider name: kmsKeyUri
        Description: Optional. The uri of the KMS key used to encrypt various sensitive files.
      • realm
        Type: STRING
        Provider name: realm
        Description: Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
      • root_principal_password_uri
        Type: STRING
        Provider name: rootPrincipalPasswordUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
      • tgt_lifetime_hours
        Type: INT32
        Provider name: tgtLifetimeHours
        Description: Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
      • truststore_password_uri
        Type: STRING
        Provider name: truststorePasswordUri
        Description: Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
      • truststore_uri
        Type: STRING
        Provider name: truststoreUri
        Description: Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
  • software_config
    Type: STRUCT
    Provider name: softwareConfig
    Description: Optional. The config settings for cluster software.
    • image_version
      Type: STRING
      Provider name: imageVersion
      Description: Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions, such as “1.2” (including a subminor version, such as “1.2.29”), or the “preview” version. If unspecified, it defaults to the latest Debian version.
    • optional_components
      Type: UNORDERED_LIST_STRING
      Provider name: optionalComponents
      Description: Optional. The set of components to activate on the cluster.
  • temp_bucket
    Type: STRING
    Provider name: tempBucket
    Description: Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster’s temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets). This field requires a Cloud Storage bucket name, not a gs://… URI to a Cloud Storage bucket.
  • worker_config
    Type: STRUCT
    Provider name: workerConfig
    Description: Optional. The Compute Engine config settings for the cluster’s worker instances.
    • accelerators
      Type: UNORDERED_LIST_STRUCT
      Provider name: accelerators
      Description: Optional. The Compute Engine accelerator configuration for these instances.
    • disk_config
      Type: STRUCT
      Provider name: diskConfig
      Description: Optional. Disk option config settings.
      • boot_disk_size_gb
        Type: INT32
        Provider name: bootDiskSizeGb
        Description: Optional. Size in GB of the boot disk (default is 500GB).
      • boot_disk_type
        Type: STRING
        Provider name: bootDiskType
        Description: 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.
      • local_ssd_interface
        Type: STRING
        Provider name: localSsdInterface
        Description: 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.
      • num_local_ssds
        Type: INT32
        Provider name: numLocalSsds
        Description: 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 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.
    • image_uri
      Type: STRING
      Provider name: imageUri
      Description: Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples:

      Image family examples. Dataproc will use the most recent image from the family:

      If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

    • instance_names
      Type: UNORDERED_LIST_STRING
      Provider name: instanceNames
      Description: Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
    • instance_references
      Type: UNORDERED_LIST_STRUCT
      Provider name: instanceReferences
      Description: Output only. List of references to Compute Engine instances.
      • instance_id
        Type: STRING
        Provider name: instanceId
        Description: The unique identifier of the Compute Engine instance.
      • instance_name
        Type: STRING
        Provider name: instanceName
        Description: The user-friendly name of the Compute Engine instance.
      • public_ecies_key
        Type: STRING
        Provider name: publicEciesKey
        Description: The public ECIES key used for sharing data with this instance.
      • public_key
        Type: STRING
        Provider name: publicKey
        Description: The public RSA key used for sharing data with this instance.
    • is_preemptible
      Type: BOOLEAN
      Provider name: isPreemptible
      Description: Output only. Specifies that this instance group contains preemptible instances.
    • machine_type_uri
      Type: STRING
      Provider name: machineTypeUri
      Description: Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples:

      Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

    • managed_group_config
      Type: STRUCT
      Provider name: managedGroupConfig
      Description: Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
      • instance_group_manager_name
        Type: STRING
        Provider name: instanceGroupManagerName
        Description: Output only. The name of the Instance Group Manager for this group.
      • instance_template_name
        Type: STRING
        Provider name: instanceTemplateName
        Description: Output only. The name of the Instance Template used for the Managed Instance Group.
    • min_cpu_platform
      Type: STRING
      Provider name: minCpuPlatform
      Description: Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform.
    • num_instances
      Type: INT32
      Provider name: numInstances
      Description: 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
      Type: STRING
      Provider name: preemptibility
      Description: 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.
      Possible values:
      • PREEMPTIBILITY_UNSPECIFIED - Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.
      • NON_PREEMPTIBLE - Instances are non-preemptible. This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.
      • PREEMPTIBLE - Instances are preemptible. This option is allowed only for secondary worker groups.
      • SPOT - Instances are Spot VMs. This option is allowed only for secondary worker groups. Spot VMs are the latest version of preemptible VMs, and provide additional features.

gcp_status

Type: STRUCT
Provider name: status
Description: Output only. Cluster status.

  • detail
    Type: STRING
    Provider name: detail
    Description: Optional. Output only. Details of cluster’s state.
  • state
    Type: STRING
    Provider name: state
    Description: Output only. The cluster’s state.
    Possible values:
    • UNKNOWN - The cluster state is unknown.
    • CREATING - The cluster is being created and set up. It is not ready for use.
    • RUNNING - The cluster is currently running and healthy. It is ready for use.Note: The cluster state changes from ‘creating’ to ‘running’ status after the master node(s), first two primary worker nodes (and the last primary worker node if primary workers > 2) are running.
    • ERROR - The cluster encountered an error. It is not ready for use.
    • ERROR_DUE_TO_UPDATE - The cluster has encountered an error while being updated. Jobs can be submitted to the cluster, but the cluster cannot be updated.
    • DELETING - The cluster is being deleted. It cannot be used.
    • UPDATING - The cluster is being updated. It continues to accept and process jobs.
    • STOPPING - The cluster is being stopped. It cannot be used.
    • STOPPED - The cluster is currently stopped. It is not ready for use.
    • STARTING - The cluster is being started. It is not ready for use.
    • REPAIRING - The cluster is being repaired. It is not ready for use.
  • state_start_time
    Type: TIMESTAMP
    Provider name: stateStartTime
    Description: Output only. Time when this state was entered (see JSON representation of Timestamp).
  • substate
    Type: STRING
    Provider name: substate
    Description: Output only. Additional state information that includes status reported by the agent.
    Possible values:
    • UNSPECIFIED - The cluster substate is unknown.
    • UNHEALTHY - The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.
    • STALE_STATUS - The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state.

labels

Type: UNORDERED_LIST_STRING

metrics

Type: STRUCT
Provider name: metrics
Description: Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

status_history

Type: UNORDERED_LIST_STRUCT
Provider name: statusHistory
Description: Output only. The previous cluster status.

  • detail
    Type: STRING
    Provider name: detail
    Description: Optional. Output only. Details of cluster’s state.
  • state
    Type: STRING
    Provider name: state
    Description: Output only. The cluster’s state.
    Possible values:
    • UNKNOWN - The cluster state is unknown.
    • CREATING - The cluster is being created and set up. It is not ready for use.
    • RUNNING - The cluster is currently running and healthy. It is ready for use.Note: The cluster state changes from ‘creating’ to ‘running’ status after the master node(s), first two primary worker nodes (and the last primary worker node if primary workers > 2) are running.
    • ERROR - The cluster encountered an error. It is not ready for use.
    • ERROR_DUE_TO_UPDATE - The cluster has encountered an error while being updated. Jobs can be submitted to the cluster, but the cluster cannot be updated.
    • DELETING - The cluster is being deleted. It cannot be used.
    • UPDATING - The cluster is being updated. It continues to accept and process jobs.
    • STOPPING - The cluster is being stopped. It cannot be used.
    • STOPPED - The cluster is currently stopped. It is not ready for use.
    • STARTING - The cluster is being started. It is not ready for use.
    • REPAIRING - The cluster is being repaired. It is not ready for use.
  • state_start_time
    Type: TIMESTAMP
    Provider name: stateStartTime
    Description: Output only. Time when this state was entered (see JSON representation of Timestamp).
  • substate
    Type: STRING
    Provider name: substate
    Description: Output only. Additional state information that includes status reported by the agent.
    Possible values:
    • UNSPECIFIED - The cluster substate is unknown.
    • UNHEALTHY - The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.
    • STALE_STATUS - The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state.

tags

Type: UNORDERED_LIST_STRING

virtual_cluster_config

Type: STRUCT
Provider name: virtualClusterConfig
Description: Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster. Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified.

  • auxiliary_services_config
    Type: STRUCT
    Provider name: auxiliaryServicesConfig
    Description: Optional. Configuration of auxiliary services used by this cluster.
    • metastore_config
      Type: STRUCT
      Provider name: metastoreConfig
      Description: Optional. The Hive Metastore configuration for this workload.
      • dataproc_metastore_service
        Type: STRING
        Provider name: dataprocMetastoreService
        Description: Required. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name]
    • spark_history_server_config
      Type: STRUCT
      Provider name: sparkHistoryServerConfig
      Description: Optional. The Spark History Server configuration for the workload.
      • dataproc_cluster
        Type: STRING
        Provider name: dataprocCluster
        Description: Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
  • kubernetes_cluster_config
    Type: STRUCT
    Provider name: kubernetesClusterConfig
    Description: Required. The configuration for running the Dataproc cluster on Kubernetes.
    • gke_cluster_config
      Type: STRUCT
      Provider name: gkeClusterConfig
      Description: Required. The configuration for running the Dataproc cluster on GKE.
      • gke_cluster_target
        Type: STRING
        Provider name: gkeClusterTarget
        Description: Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: ‘projects/{project}/locations/{location}/clusters/{cluster_id}’
      • namespaced_gke_deployment_target
        Type: STRUCT
        Provider name: namespacedGkeDeploymentTarget
        Description: Optional. Deprecated. Use gkeClusterTarget. Used only for the deprecated beta. A target for the deployment.
        • cluster_namespace
          Type: STRING
          Provider name: clusterNamespace
          Description: Optional. A namespace within the GKE cluster to deploy into.
        • target_gke_cluster
          Type: STRING
          Provider name: targetGkeCluster
          Description: Optional. The target GKE cluster to deploy to. Format: ‘projects/{project}/locations/{location}/clusters/{cluster_id}’
      • node_pool_target
        Type: UNORDERED_LIST_STRUCT
        Provider name: nodePoolTarget
        Description: Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings.
        • node_pool
          Type: STRING
          Provider name: nodePool
          Description: Required. The target GKE node pool. Format: ‘projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}’
        • node_pool_config
          Type: STRUCT
          Provider name: nodePoolConfig
          Description: Input only. The configuration for the GKE node pool.If specified, Dataproc attempts to create a node pool with the specified shape. If one with the same name already exists, it is verified against all specified fields. If a field differs, the virtual cluster creation will fail.If omitted, any node pool with the specified name is used. If a node pool with the specified name does not exist, Dataproc create a node pool with default values.This is an input only field. It will not be returned by the API.
          • autoscaling
            Type: STRUCT
            Provider name: autoscaling
            Description: Optional. The autoscaler configuration for this node pool. The autoscaler is enabled only when a valid configuration is present.
            • max_node_count
              Type: INT32
              Provider name: maxNodeCount
              Description: The maximum number of nodes in the node pool. Must be >= min_node_count, and must be > 0. Note: Quota must be sufficient to scale up the cluster.
            • min_node_count
              Type: INT32
              Provider name: minNodeCount
              Description: The minimum number of nodes in the node pool. Must be >= 0 and <= max_node_count.
          • config
            Type: STRUCT
            Provider name: config
            Description: Optional. The node pool configuration.
            • accelerators
              Type: UNORDERED_LIST_STRUCT
              Provider name: accelerators
              Description: Optional. A list of hardware accelerators to attach to each node.
              • accelerator_count
                Type: INT64
                Provider name: acceleratorCount
                Description: The number of accelerator cards exposed to an instance.
              • accelerator_type
                Type: STRING
                Provider name: acceleratorType
                Description: The accelerator type resource namename (see GPUs on Compute Engine).
              • gpu_partition_size
                Type: STRING
                Provider name: gpuPartitionSize
                Description: Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide.
            • boot_disk_kms_key
              Type: STRING
              Provider name: bootDiskKmsKey
              Description: Optional. The Customer Managed Encryption Key (CMEK) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/KEY_PROJECT_ID/locations/LOCATION /keyRings/RING_NAME/cryptoKeys/KEY_NAME.
            • local_ssd_count
              Type: INT32
              Provider name: localSsdCount
              Description: Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs).
            • machine_type
              Type: STRING
              Provider name: machineType
              Description: Optional. The name of a Compute Engine machine type.
            • min_cpu_platform
              Type: STRING
              Provider name: minCpuPlatform
              Description: Optional. Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as “Intel Haswell” or “Intel Sandy Bridge”.
            • preemptible
              Type: BOOLEAN
              Provider name: preemptible
              Description: Optional. Whether the nodes are created as legacy preemptible VM instances. Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).
            • spot
              Type: BOOLEAN
              Provider name: spot
              Description: Optional. Whether the nodes are created as Spot VM instances. Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).
          • locations
            Type: UNORDERED_LIST_STRING
            Provider name: locations
            Description: Optional. The list of Compute Engine zones where node pool nodes associated with a Dataproc on GKE virtual cluster will be located. Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region. If a location is not specified during node pool creation, Dataproc on GKE will choose the zone.
        • roles
          Type: UNORDERED_LIST_STRING
          Provider name: roles
          Description: Required. The roles associated with the GKE node pool.
    • kubernetes_namespace
      Type: STRING
      Provider name: kubernetesNamespace
      Description: Optional. A namespace within the Kubernetes cluster to deploy into. If this namespace does not exist, it is created. If it exists, Dataproc verifies that another Dataproc VirtualCluster is not installed into it. If not specified, the name of the Dataproc Cluster is used.
    • kubernetes_software_config
      Type: STRUCT
      Provider name: kubernetesSoftwareConfig
      Description: Optional. The software configuration for this Dataproc cluster running on Kubernetes.
  • staging_bucket
    Type: STRING
    Provider name: stagingBucket
    Description: Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster’s staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets). This field requires a Cloud Storage bucket name, not a gs://… URI to a Cloud Storage bucket.