1. Registry
  2. Packages
  3. Spotinst Provider
  4. API Docs
  5. OceanRightSizingClusterConfig
Viewing docs for Spotinst v3.137.0
published on Saturday, Aug 15, 2026 by Pulumi
spotinst logo
Viewing docs for Spotinst v3.137.0
published on Saturday, Aug 15, 2026 by Pulumi

    Manages a Spotinst Ocean right sizing cluster configuration resource. This resource allows you to configure cluster-level right sizing settings.

    NOTE:

    • This resource supports POST, PUT and READ operations only. Delete operation is not supported through Terraform.
    • POST and PUT operations can take a few minutes to complete.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as spotinst from "@pulumi/spotinst";
    
    const example = new spotinst.OceanRightSizingClusterConfig("example", {
        oceanId: "o-abcd1234",
        clusterIdentifier: "dev-cluster",
        config: {
            adjustLimitOnDownsize: true,
            downsideOnly: false,
            recommendationsCpuPercentile: 85,
            recommendationsMemoryPercentile: 85,
        },
    });
    
    import pulumi
    import pulumi_spotinst as spotinst
    
    example = spotinst.OceanRightSizingClusterConfig("example",
        ocean_id="o-abcd1234",
        cluster_identifier="dev-cluster",
        config={
            "adjust_limit_on_downsize": True,
            "downside_only": False,
            "recommendations_cpu_percentile": 85,
            "recommendations_memory_percentile": 85,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-spotinst/sdk/v3/go/spotinst"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := spotinst.NewOceanRightSizingClusterConfig(ctx, "example", &spotinst.OceanRightSizingClusterConfigArgs{
    			OceanId:           pulumi.String("o-abcd1234"),
    			ClusterIdentifier: pulumi.String("dev-cluster"),
    			Config: &spotinst.OceanRightSizingClusterConfigConfigArgs{
    				AdjustLimitOnDownsize:           pulumi.Bool(true),
    				DownsideOnly:                    pulumi.Bool(false),
    				RecommendationsCpuPercentile:    pulumi.Int(85),
    				RecommendationsMemoryPercentile: pulumi.Int(85),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SpotInst = Pulumi.SpotInst;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new SpotInst.OceanRightSizingClusterConfig("example", new()
        {
            OceanId = "o-abcd1234",
            ClusterIdentifier = "dev-cluster",
            Config = new SpotInst.Inputs.OceanRightSizingClusterConfigConfigArgs
            {
                AdjustLimitOnDownsize = true,
                DownsideOnly = false,
                RecommendationsCpuPercentile = 85,
                RecommendationsMemoryPercentile = 85,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.spotinst.OceanRightSizingClusterConfig;
    import com.pulumi.spotinst.OceanRightSizingClusterConfigArgs;
    import com.pulumi.spotinst.inputs.OceanRightSizingClusterConfigConfigArgs;
    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 example = new OceanRightSizingClusterConfig("example", OceanRightSizingClusterConfigArgs.builder()
                .oceanId("o-abcd1234")
                .clusterIdentifier("dev-cluster")
                .config(OceanRightSizingClusterConfigConfigArgs.builder()
                    .adjustLimitOnDownsize(true)
                    .downsideOnly(false)
                    .recommendationsCpuPercentile(85)
                    .recommendationsMemoryPercentile(85)
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: spotinst:OceanRightSizingClusterConfig
        properties:
          oceanId: o-abcd1234
          clusterIdentifier: dev-cluster
          config:
            adjustLimitOnDownsize: true
            downsideOnly: false
            recommendationsCpuPercentile: 85
            recommendationsMemoryPercentile: 85
    
    pulumi {
      required_providers {
        spotinst = {
          source = "pulumi/spotinst"
        }
      }
    }
    
    resource "spotinst_oceanrightsizingclusterconfig" "example" {
      ocean_id           = "o-abcd1234"
      cluster_identifier = "dev-cluster"
      config = {
        adjust_limit_on_downsize          = true
        downside_only                     = false
        recommendations_cpu_percentile    = 85
        recommendations_memory_percentile = 85
      }
    }
    

    Create OceanRightSizingClusterConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OceanRightSizingClusterConfig(name: string, args: OceanRightSizingClusterConfigArgs, opts?: CustomResourceOptions);
    @overload
    def OceanRightSizingClusterConfig(resource_name: str,
                                      args: OceanRightSizingClusterConfigArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def OceanRightSizingClusterConfig(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      cluster_identifier: Optional[str] = None,
                                      config: Optional[OceanRightSizingClusterConfigConfigArgs] = None,
                                      ocean_id: Optional[str] = None)
    func NewOceanRightSizingClusterConfig(ctx *Context, name string, args OceanRightSizingClusterConfigArgs, opts ...ResourceOption) (*OceanRightSizingClusterConfig, error)
    public OceanRightSizingClusterConfig(string name, OceanRightSizingClusterConfigArgs args, CustomResourceOptions? opts = null)
    public OceanRightSizingClusterConfig(String name, OceanRightSizingClusterConfigArgs args)
    public OceanRightSizingClusterConfig(String name, OceanRightSizingClusterConfigArgs args, CustomResourceOptions options)
    
    type: spotinst:OceanRightSizingClusterConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "spotinst_ocean_right_sizing_cluster_config" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OceanRightSizingClusterConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OceanRightSizingClusterConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OceanRightSizingClusterConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OceanRightSizingClusterConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OceanRightSizingClusterConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var oceanRightSizingClusterConfigResource = new SpotInst.OceanRightSizingClusterConfig("oceanRightSizingClusterConfigResource", new()
    {
        ClusterIdentifier = "string",
        Config = new SpotInst.Inputs.OceanRightSizingClusterConfigConfigArgs
        {
            AdjustLimitOnDownsize = false,
            DownsideOnly = false,
            RecommendationsCpuPercentile = 0,
            RecommendationsMemoryPercentile = 0,
        },
        OceanId = "string",
    });
    
    example, err := spotinst.NewOceanRightSizingClusterConfig(ctx, "oceanRightSizingClusterConfigResource", &spotinst.OceanRightSizingClusterConfigArgs{
    	ClusterIdentifier: pulumi.String("string"),
    	Config: &spotinst.OceanRightSizingClusterConfigConfigArgs{
    		AdjustLimitOnDownsize:           pulumi.Bool(false),
    		DownsideOnly:                    pulumi.Bool(false),
    		RecommendationsCpuPercentile:    pulumi.Int(0),
    		RecommendationsMemoryPercentile: pulumi.Int(0),
    	},
    	OceanId: pulumi.String("string"),
    })
    
    resource "spotinst_ocean_right_sizing_cluster_config" "oceanRightSizingClusterConfigResource" {
      lifecycle {
        create_before_destroy = true
      }
      cluster_identifier = "string"
      config = {
        adjust_limit_on_downsize          = false
        downside_only                     = false
        recommendations_cpu_percentile    = 0
        recommendations_memory_percentile = 0
      }
      ocean_id = "string"
    }
    
    var oceanRightSizingClusterConfigResource = new OceanRightSizingClusterConfig("oceanRightSizingClusterConfigResource", OceanRightSizingClusterConfigArgs.builder()
        .clusterIdentifier("string")
        .config(OceanRightSizingClusterConfigConfigArgs.builder()
            .adjustLimitOnDownsize(false)
            .downsideOnly(false)
            .recommendationsCpuPercentile(0)
            .recommendationsMemoryPercentile(0)
            .build())
        .oceanId("string")
        .build());
    
    ocean_right_sizing_cluster_config_resource = spotinst.OceanRightSizingClusterConfig("oceanRightSizingClusterConfigResource",
        cluster_identifier="string",
        config={
            "adjust_limit_on_downsize": False,
            "downside_only": False,
            "recommendations_cpu_percentile": 0,
            "recommendations_memory_percentile": 0,
        },
        ocean_id="string")
    
    const oceanRightSizingClusterConfigResource = new spotinst.OceanRightSizingClusterConfig("oceanRightSizingClusterConfigResource", {
        clusterIdentifier: "string",
        config: {
            adjustLimitOnDownsize: false,
            downsideOnly: false,
            recommendationsCpuPercentile: 0,
            recommendationsMemoryPercentile: 0,
        },
        oceanId: "string",
    });
    
    type: spotinst:OceanRightSizingClusterConfig
    properties:
        clusterIdentifier: string
        config:
            adjustLimitOnDownsize: false
            downsideOnly: false
            recommendationsCpuPercentile: 0
            recommendationsMemoryPercentile: 0
        oceanId: string
    

    OceanRightSizingClusterConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OceanRightSizingClusterConfig resource accepts the following input properties:

    ClusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    Config Pulumi.SpotInst.Inputs.OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    OceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    ClusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    Config OceanRightSizingClusterConfigConfigArgs
    The Ocean right sizing cluster configuration. The config block supports:
    OceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    cluster_identifier string
    Identifier of the cluster. Example: dev-cluster
    config object
    The Ocean right sizing cluster configuration. The config block supports:
    ocean_id string
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier String
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId String
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    cluster_identifier str
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfigArgs
    The Ocean right sizing cluster configuration. The config block supports:
    ocean_id str
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier String
    Identifier of the cluster. Example: dev-cluster
    config Property Map
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId String
    Identifier of the Ocean cluster. Example: o-abcd1234

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OceanRightSizingClusterConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OceanRightSizingClusterConfig Resource

    Get an existing OceanRightSizingClusterConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OceanRightSizingClusterConfigState, opts?: CustomResourceOptions): OceanRightSizingClusterConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_identifier: Optional[str] = None,
            config: Optional[OceanRightSizingClusterConfigConfigArgs] = None,
            ocean_id: Optional[str] = None) -> OceanRightSizingClusterConfig
    func GetOceanRightSizingClusterConfig(ctx *Context, name string, id IDInput, state *OceanRightSizingClusterConfigState, opts ...ResourceOption) (*OceanRightSizingClusterConfig, error)
    public static OceanRightSizingClusterConfig Get(string name, Input<string> id, OceanRightSizingClusterConfigState? state, CustomResourceOptions? opts = null)
    public static OceanRightSizingClusterConfig get(String name, Output<String> id, OceanRightSizingClusterConfigState state, CustomResourceOptions options)
    resources:  _:    type: spotinst:OceanRightSizingClusterConfig    get:      id: ${id}
    import {
      to = spotinst_ocean_right_sizing_cluster_config.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    Config Pulumi.SpotInst.Inputs.OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    OceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    ClusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    Config OceanRightSizingClusterConfigConfigArgs
    The Ocean right sizing cluster configuration. The config block supports:
    OceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    cluster_identifier string
    Identifier of the cluster. Example: dev-cluster
    config object
    The Ocean right sizing cluster configuration. The config block supports:
    ocean_id string
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier String
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId String
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier string
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfig
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId string
    Identifier of the Ocean cluster. Example: o-abcd1234
    cluster_identifier str
    Identifier of the cluster. Example: dev-cluster
    config OceanRightSizingClusterConfigConfigArgs
    The Ocean right sizing cluster configuration. The config block supports:
    ocean_id str
    Identifier of the Ocean cluster. Example: o-abcd1234
    clusterIdentifier String
    Identifier of the cluster. Example: dev-cluster
    config Property Map
    The Ocean right sizing cluster configuration. The config block supports:
    oceanId String
    Identifier of the Ocean cluster. Example: o-abcd1234

    Supporting Types

    OceanRightSizingClusterConfigConfig, OceanRightSizingClusterConfigConfigArgs

    AdjustLimitOnDownsize bool
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    DownsideOnly bool
    When set to true, only downscale recommendations will be applied.
    RecommendationsCpuPercentile int
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    RecommendationsMemoryPercentile int
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    AdjustLimitOnDownsize bool
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    DownsideOnly bool
    When set to true, only downscale recommendations will be applied.
    RecommendationsCpuPercentile int
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    RecommendationsMemoryPercentile int
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    adjust_limit_on_downsize bool
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    downside_only bool
    When set to true, only downscale recommendations will be applied.
    recommendations_cpu_percentile number
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    recommendations_memory_percentile number
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    adjustLimitOnDownsize Boolean
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    downsideOnly Boolean
    When set to true, only downscale recommendations will be applied.
    recommendationsCpuPercentile Integer
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    recommendationsMemoryPercentile Integer
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    adjustLimitOnDownsize boolean
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    downsideOnly boolean
    When set to true, only downscale recommendations will be applied.
    recommendationsCpuPercentile number
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    recommendationsMemoryPercentile number
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    adjust_limit_on_downsize bool
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    downside_only bool
    When set to true, only downscale recommendations will be applied.
    recommendations_cpu_percentile int
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    recommendations_memory_percentile int
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.
    adjustLimitOnDownsize Boolean
    When set to true, the limit will be adjusted when downscale recommendations are applied.
    downsideOnly Boolean
    When set to true, only downscale recommendations will be applied.
    recommendationsCpuPercentile Number
    Change the CPU percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 99.
    recommendationsMemoryPercentile Number
    Change the memory percentile that the right-sizing recommendations calculation will take into account. Valid values: 85, 90, 95, 100.

    Package Details

    Repository
    Spotinst pulumi/pulumi-spotinst
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the spotinst Terraform Provider.
    spotinst logo
    Viewing docs for Spotinst v3.137.0
    published on Saturday, Aug 15, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial