AutoscalingPolicy class

Describes an autoscaling policy for Dataproc cluster autoscaler.

Example Usage

Dataproc Autoscaling Policy

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

const asp = new gcp.dataproc.AutoscalingPolicy("asp", {
    policyId: "dataproc-policy",
    location: "us-central1",
    workerConfig: {
        maxInstances: 3,
    },
    basicAlgorithm: {
        yarnConfig: {
            gracefulDecommissionTimeout: "30s",
            scaleUpFactor: 0.5,
            scaleDownFactor: 0.5,
        },
    },
});
const basic = new gcp.dataproc.Cluster("basic", {
    name: "dataproc-policy",
    region: "us-central1",
    clusterConfig: {
        autoscalingConfig: {
            policyUri: asp.name,
        },
    },
});

import pulumi
import pulumi_gcp as gcp

asp = gcp.dataproc.AutoscalingPolicy("asp",
    policy_id="dataproc-policy",
    location="us-central1",
    worker_config={
        "max_instances": 3,
    },
    basic_algorithm={
        "yarn_config": {
            "graceful_decommission_timeout": "30s",
            "scale_up_factor": 0.5,
            "scale_down_factor": 0.5,
        },
    })
basic = gcp.dataproc.Cluster("basic",
    name="dataproc-policy",
    region="us-central1",
    cluster_config={
        "autoscaling_config": {
            "policy_uri": asp.name,
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var asp = new Gcp.Dataproc.AutoscalingPolicy("asp", new()
    {
        PolicyId = "dataproc-policy",
        Location = "us-central1",
        WorkerConfig = new Gcp.Dataproc.Inputs.AutoscalingPolicyWorkerConfigArgs
        {
            MaxInstances = 3,
        },
        BasicAlgorithm = new Gcp.Dataproc.Inputs.AutoscalingPolicyBasicAlgorithmArgs
        {
            YarnConfig = new Gcp.Dataproc.Inputs.AutoscalingPolicyBasicAlgorithmYarnConfigArgs
            {
                GracefulDecommissionTimeout = "30s",
                ScaleUpFactor = 0.5,
                ScaleDownFactor = 0.5,
            },
        },
    });

    var basic = new Gcp.Dataproc.Cluster("basic", new()
    {
        Name = "dataproc-policy",
        Region = "us-central1",
        ClusterConfig = new Gcp.Dataproc.Inputs.ClusterClusterConfigArgs
        {
            AutoscalingConfig = new Gcp.Dataproc.Inputs.ClusterClusterConfigAutoscalingConfigArgs
            {
                PolicyUri = asp.Name,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/dataproc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		asp, err := dataproc.NewAutoscalingPolicy(ctx, "asp", &dataproc.AutoscalingPolicyArgs{
			PolicyId: pulumi.String("dataproc-policy"),
			Location: pulumi.String("us-central1"),
			WorkerConfig: &dataproc.AutoscalingPolicyWorkerConfigArgs{
				MaxInstances: pulumi.Int(3),
			},
			BasicAlgorithm: &dataproc.AutoscalingPolicyBasicAlgorithmArgs{
				YarnConfig: &dataproc.AutoscalingPolicyBasicAlgorithmYarnConfigArgs{
					GracefulDecommissionTimeout: pulumi.String("30s"),
					ScaleUpFactor:               pulumi.Float64(0.5),
					ScaleDownFactor:             pulumi.Float64(0.5),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = dataproc.NewCluster(ctx, "basic", &dataproc.ClusterArgs{
			Name:   pulumi.String("dataproc-policy"),
			Region: pulumi.String("us-central1"),
			ClusterConfig: &dataproc.ClusterClusterConfigArgs{
				AutoscalingConfig: &dataproc.ClusterClusterConfigAutoscalingConfigArgs{
					PolicyUri: asp.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_dataproc_cluster" "basic" {
  name   = "dataproc-policy"
  region = "us-central1"
  cluster_config = {
    autoscaling_config = {
      policy_uri = gcp_dataproc_autoscalingpolicy.asp.name
    }
  }
}
resource "gcp_dataproc_autoscalingpolicy" "asp" {
  policy_id = "dataproc-policy"
  location  = "us-central1"
  worker_config = {
    max_instances = 3
  }
  basic_algorithm = {
    yarn_config = {
      graceful_decommission_timeout = "30s"
      scale_up_factor               = 0.5
      scale_down_factor             = 0.5
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.dataproc.AutoscalingPolicy;
import com.pulumi.gcp.dataproc.AutoscalingPolicyArgs;
import com.pulumi.gcp.dataproc.inputs.AutoscalingPolicyWorkerConfigArgs;
import com.pulumi.gcp.dataproc.inputs.AutoscalingPolicyBasicAlgorithmArgs;
import com.pulumi.gcp.dataproc.inputs.AutoscalingPolicyBasicAlgorithmYarnConfigArgs;
import com.pulumi.gcp.dataproc.Cluster;
import com.pulumi.gcp.dataproc.ClusterArgs;
import com.pulumi.gcp.dataproc.inputs.ClusterClusterConfigArgs;
import com.pulumi.gcp.dataproc.inputs.ClusterClusterConfigAutoscalingConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var asp = new AutoscalingPolicy("asp", AutoscalingPolicyArgs.builder()
            .policyId("dataproc-policy")
            .location("us-central1")
            .workerConfig(AutoscalingPolicyWorkerConfigArgs.builder()
                .maxInstances(3)
                .build())
            .basicAlgorithm(AutoscalingPolicyBasicAlgorithmArgs.builder()
                .yarnConfig(AutoscalingPolicyBasicAlgorithmYarnConfigArgs.builder()
                    .gracefulDecommissionTimeout("30s")
                    .scaleUpFactor(0.5)
                    .scaleDownFactor(0.5)
                    .build())
                .build())
            .build());

        var basic = new Cluster("basic", ClusterArgs.builder()
            .name("dataproc-policy")
            .region("us-central1")
            .clusterConfig(ClusterClusterConfigArgs.builder()
                .autoscalingConfig(ClusterClusterConfigAutoscalingConfigArgs.builder()
                    .policyUri(asp.name())
                    .build())
                .build())
            .build());

    }
}

resources:
  basic:
    type: gcp:dataproc:Cluster
    properties:
      name: dataproc-policy
      region: us-central1
      clusterConfig:
        autoscalingConfig:
          policyUri: ${asp.name}
  asp:
    type: gcp:dataproc:AutoscalingPolicy
    properties:
      policyId: dataproc-policy
      location: us-central1
      workerConfig:
        maxInstances: 3
      basicAlgorithm:
        yarnConfig:
          gracefulDecommissionTimeout: 30s
          scaleUpFactor: 0.5
          scaleDownFactor: 0.5

Import

AutoscalingPolicy can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{policy_id}}
• {{project}}/{{location}}/{{policy_id}}
• {{location}}/{{policy_id}}

When using the pulumi import command, AutoscalingPolicy can be imported using one of the formats above. For example:

$ pulumi import gcp:dataproc/autoscalingPolicy:AutoscalingPolicy default projects/{{project}}/locations/{{location}}/autoscalingPolicies/{{policy_id}}
$ pulumi import gcp:dataproc/autoscalingPolicy:AutoscalingPolicy default {{project}}/{{location}}/{{policy_id}}
$ pulumi import gcp:dataproc/autoscalingPolicy:AutoscalingPolicy default {{location}}/{{policy_id}}

Constructors

AutoscalingPolicy(String name, {AutoscalingPolicyArgs? args, CustomResourceOptions? options})

Creates a new AutoscalingPolicy. name The Pulumi resource name. args Arguments used to configure this AutoscalingPolicy. The set of arguments for AutoscalingPolicy. options Resource options controlling this resource's behavior.

AutoscalingPolicy.reference(String urn)

Creates a typed reference to an existing AutoscalingPolicy resource.

Properties

basicAlgorithm ↔ Output<AutoscalingPolicyBasicAlgorithm?>

Basic algorithm for autoscaling. Structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String?>

The location where the autoscaling policy should reside. The default value is global.

late, final

name ↔ Output<String>

The "resource name" of the autoscaling policy.

late, final

policyId ↔ Output<String>

The policy id. 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 between 3 and 50 characters.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

secondaryWorkerConfig ↔ Output<AutoscalingPolicySecondaryWorkerConfig?>

Describes how the autoscaler will operate for secondary workers. Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

workerConfig ↔ Output<AutoscalingPolicyWorkerConfig?>

Describes how the autoscaler will operate for primary workers. Structure is documented below.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {AutoscalingPolicyState? state, CustomResourceOptions? options}) → AutoscalingPolicy

Gets an existing AutoscalingPolicy resource's state with the given name and id.