InstanceGroupConfig

import type { InstanceGroupConfig } from "https://googleapis.deno.dev/v1/dataproc:v1.ts";

The config settings for Compute Engine resources in an instance group, such as a master or worker group.

interface InstanceGroupConfig {

accelerators?: AcceleratorConfig[];

diskConfig?: DiskConfig;

imageUri?: string;

instanceFlexibilityPolicy?: InstanceFlexibilityPolicy;

readonly instanceNames?: string[];

readonly instanceReferences?: InstanceReference[];

readonly isPreemptible?: boolean;

machineTypeUri?: string;

readonly managedGroupConfig?: ManagedGroupConfig;

minCpuPlatform?: string;

minNumInstances?: number;

numInstances?: number;

preemptibility?:

| "PREEMPTIBILITY_UNSPECIFIED"

| "NON_PREEMPTIBLE"

| "PREEMPTIBLE"

| "SPOT";

startupConfig?: StartupConfig;

}

§Properties

accelerators?: AcceleratorConfig[]

[src]

Optional. The Compute Engine accelerator configuration for these instances.

diskConfig?: DiskConfig

[src]

Optional. Disk option config settings.

imageUri?: string

[src]

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?: InstanceFlexibilityPolicy

[src]

Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.

readonly instanceNames?: string[]

[src]

Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

readonly instanceReferences?: InstanceReference[]

[src]

Output only. List of references to Compute Engine instances.

readonly isPreemptible?: boolean

[src]

Output only. Specifies that this instance group contains preemptible instances.

machineTypeUri?: string

[src]

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.

readonly managedGroupConfig?: ManagedGroupConfig

[src]

Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

minCpuPlatform?: string

[src]

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

[src]

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

[src]

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?: "PREEMPTIBILITY_UNSPECIFIED" | "NON_PREEMPTIBLE" | "PREEMPTIBLE" | "SPOT"

[src]

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?: StartupConfig

[src]

Optional. Configuration to handle the startup of instances during cluster create and update process.