ibm 1.78.0, Apr 30 25

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.SatelliteStorageAssignment

Explore with Pulumi AI

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

Example Usage

Sample to create a storage assignment to a cluster

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

const assignment = new ibm.SatelliteStorageAssignment("assignment", {
    assignmentName: "assignment-name",
    cluster: "cluster-id",
    config: "storage-config-name",
    controller: "satellite-location",
});

import pulumi
import pulumi_ibm as ibm

assignment = ibm.SatelliteStorageAssignment("assignment",
    assignment_name="assignment-name",
    cluster="cluster-id",
    config="storage-config-name",
    controller="satellite-location")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSatelliteStorageAssignment(ctx, "assignment", &ibm.SatelliteStorageAssignmentArgs{
			AssignmentName: pulumi.String("assignment-name"),
			Cluster:        pulumi.String("cluster-id"),
			Config:         pulumi.String("storage-config-name"),
			Controller:     pulumi.String("satellite-location"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var assignment = new Ibm.SatelliteStorageAssignment("assignment", new()
    {
        AssignmentName = "assignment-name",
        Cluster = "cluster-id",
        Config = "storage-config-name",
        Controller = "satellite-location",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteStorageAssignment;
import com.pulumi.ibm.SatelliteStorageAssignmentArgs;
import java.util.List;
import java.util.ArrayList;
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 assignment = new SatelliteStorageAssignment("assignment", SatelliteStorageAssignmentArgs.builder()
            .assignmentName("assignment-name")
            .cluster("cluster-id")
            .config("storage-config-name")
            .controller("satellite-location")
            .build());

    }
}

resources:
  assignment:
    type: ibm:SatelliteStorageAssignment
    properties:
      assignmentName: assignment-name
      cluster: cluster-id
      config: storage-config-name
      controller: satellite-location

Sample to create a storage assignment to a group

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

const assignment = new ibm.SatelliteStorageAssignment("assignment", {
    assignmentName: "assignment-name",
    config: "storage-config-name",
    controller: "satellite-location",
    groups: [
        "cluster-group-1",
        "cluster-group-2",
    ],
});

import pulumi
import pulumi_ibm as ibm

assignment = ibm.SatelliteStorageAssignment("assignment",
    assignment_name="assignment-name",
    config="storage-config-name",
    controller="satellite-location",
    groups=[
        "cluster-group-1",
        "cluster-group-2",
    ])

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSatelliteStorageAssignment(ctx, "assignment", &ibm.SatelliteStorageAssignmentArgs{
			AssignmentName: pulumi.String("assignment-name"),
			Config:         pulumi.String("storage-config-name"),
			Controller:     pulumi.String("satellite-location"),
			Groups: pulumi.StringArray{
				pulumi.String("cluster-group-1"),
				pulumi.String("cluster-group-2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var assignment = new Ibm.SatelliteStorageAssignment("assignment", new()
    {
        AssignmentName = "assignment-name",
        Config = "storage-config-name",
        Controller = "satellite-location",
        Groups = new[]
        {
            "cluster-group-1",
            "cluster-group-2",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteStorageAssignment;
import com.pulumi.ibm.SatelliteStorageAssignmentArgs;
import java.util.List;
import java.util.ArrayList;
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 assignment = new SatelliteStorageAssignment("assignment", SatelliteStorageAssignmentArgs.builder()
            .assignmentName("assignment-name")
            .config("storage-config-name")
            .controller("satellite-location")
            .groups(            
                "cluster-group-1",
                "cluster-group-2")
            .build());

    }
}

resources:
  assignment:
    type: ibm:SatelliteStorageAssignment
    properties:
      assignmentName: assignment-name
      config: storage-config-name
      controller: satellite-location
      groups:
        - cluster-group-1
        - cluster-group-2

Sample to update the storage configuration revision to a cluster/group

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

const assignment = new ibm.SatelliteStorageAssignment("assignment", {
    assignmentName: "assignment-name",
    config: "storage-config-name",
    groups: [
        "cluster-group-1",
        "cluster-group-2",
    ],
    updateConfigRevision: true,
});

import pulumi
import pulumi_ibm as ibm

assignment = ibm.SatelliteStorageAssignment("assignment",
    assignment_name="assignment-name",
    config="storage-config-name",
    groups=[
        "cluster-group-1",
        "cluster-group-2",
    ],
    update_config_revision=True)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSatelliteStorageAssignment(ctx, "assignment", &ibm.SatelliteStorageAssignmentArgs{
			AssignmentName: pulumi.String("assignment-name"),
			Config:         pulumi.String("storage-config-name"),
			Groups: pulumi.StringArray{
				pulumi.String("cluster-group-1"),
				pulumi.String("cluster-group-2"),
			},
			UpdateConfigRevision: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var assignment = new Ibm.SatelliteStorageAssignment("assignment", new()
    {
        AssignmentName = "assignment-name",
        Config = "storage-config-name",
        Groups = new[]
        {
            "cluster-group-1",
            "cluster-group-2",
        },
        UpdateConfigRevision = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteStorageAssignment;
import com.pulumi.ibm.SatelliteStorageAssignmentArgs;
import java.util.List;
import java.util.ArrayList;
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 assignment = new SatelliteStorageAssignment("assignment", SatelliteStorageAssignmentArgs.builder()
            .assignmentName("assignment-name")
            .config("storage-config-name")
            .groups(            
                "cluster-group-1",
                "cluster-group-2")
            .updateConfigRevision(true)
            .build());

    }
}

resources:
  assignment:
    type: ibm:SatelliteStorageAssignment
    properties:
      assignmentName: assignment-name
      config: storage-config-name
      groups:
        - cluster-group-1
        - cluster-group-2
      updateConfigRevision: true

Create SatelliteStorageAssignment Resource

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

Constructor syntax

new SatelliteStorageAssignment(name: string, args: SatelliteStorageAssignmentArgs, opts?: CustomResourceOptions);

@overload
def SatelliteStorageAssignment(resource_name: str,
                               args: SatelliteStorageAssignmentArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def SatelliteStorageAssignment(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               assignment_name: Optional[str] = None,
                               config: Optional[str] = None,
                               cluster: Optional[str] = None,
                               controller: Optional[str] = None,
                               groups: Optional[Sequence[str]] = None,
                               satellite_storage_assignment_id: Optional[str] = None,
                               timeouts: Optional[SatelliteStorageAssignmentTimeoutsArgs] = None,
                               update_config_revision: Optional[bool] = None)

func NewSatelliteStorageAssignment(ctx *Context, name string, args SatelliteStorageAssignmentArgs, opts ...ResourceOption) (*SatelliteStorageAssignment, error)

public SatelliteStorageAssignment(string name, SatelliteStorageAssignmentArgs args, CustomResourceOptions? opts = null)

public SatelliteStorageAssignment(String name, SatelliteStorageAssignmentArgs args)
public SatelliteStorageAssignment(String name, SatelliteStorageAssignmentArgs args, CustomResourceOptions options)

type: ibm:SatelliteStorageAssignment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SatelliteStorageAssignmentArgs: 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 SatelliteStorageAssignmentArgs: 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 SatelliteStorageAssignmentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SatelliteStorageAssignmentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SatelliteStorageAssignmentArgs: 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 satelliteStorageAssignmentResource = new Ibm.SatelliteStorageAssignment("satelliteStorageAssignmentResource", new()
{
    AssignmentName = "string",
    Config = "string",
    Cluster = "string",
    Controller = "string",
    Groups = new[]
    {
        "string",
    },
    SatelliteStorageAssignmentId = "string",
    Timeouts = new Ibm.Inputs.SatelliteStorageAssignmentTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    UpdateConfigRevision = false,
});

example, err := ibm.NewSatelliteStorageAssignment(ctx, "satelliteStorageAssignmentResource", &ibm.SatelliteStorageAssignmentArgs{
	AssignmentName: pulumi.String("string"),
	Config:         pulumi.String("string"),
	Cluster:        pulumi.String("string"),
	Controller:     pulumi.String("string"),
	Groups: pulumi.StringArray{
		pulumi.String("string"),
	},
	SatelliteStorageAssignmentId: pulumi.String("string"),
	Timeouts: &ibm.SatelliteStorageAssignmentTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	UpdateConfigRevision: pulumi.Bool(false),
})

var satelliteStorageAssignmentResource = new SatelliteStorageAssignment("satelliteStorageAssignmentResource", SatelliteStorageAssignmentArgs.builder()
    .assignmentName("string")
    .config("string")
    .cluster("string")
    .controller("string")
    .groups("string")
    .satelliteStorageAssignmentId("string")
    .timeouts(SatelliteStorageAssignmentTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .updateConfigRevision(false)
    .build());

satellite_storage_assignment_resource = ibm.SatelliteStorageAssignment("satelliteStorageAssignmentResource",
    assignment_name="string",
    config="string",
    cluster="string",
    controller="string",
    groups=["string"],
    satellite_storage_assignment_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    update_config_revision=False)

const satelliteStorageAssignmentResource = new ibm.SatelliteStorageAssignment("satelliteStorageAssignmentResource", {
    assignmentName: "string",
    config: "string",
    cluster: "string",
    controller: "string",
    groups: ["string"],
    satelliteStorageAssignmentId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    updateConfigRevision: false,
});

type: ibm:SatelliteStorageAssignment
properties:
    assignmentName: string
    cluster: string
    config: string
    controller: string
    groups:
        - string
    satelliteStorageAssignmentId: string
    timeouts:
        create: string
        delete: string
        update: string
    updateConfigRevision: false

SatelliteStorageAssignment 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 SatelliteStorageAssignment resource accepts the following input properties:

AssignmentName string

The name of the assignment

Config string

The name of the storage configuration to be assigned.

Cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

Controller string

The name of the location where the storage configuration is created.

Groups List<string>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

SatelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

Timeouts SatelliteStorageAssignmentTimeouts

UpdateConfigRevision bool

Set to true to update the assignment with the latest revision of the storage configuration.

AssignmentName string

The name of the assignment

Config string

The name of the storage configuration to be assigned.

Cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

Controller string

The name of the location where the storage configuration is created.

Groups []string

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

SatelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

Timeouts SatelliteStorageAssignmentTimeoutsArgs

UpdateConfigRevision bool

Set to true to update the assignment with the latest revision of the storage configuration.

assignmentName String

The name of the assignment

config String

The name of the storage configuration to be assigned.

cluster String

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

controller String

The name of the location where the storage configuration is created.

groups List<String>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

satelliteStorageAssignmentId String

(String) ID of the Storage Assignment Resource

timeouts SatelliteStorageAssignmentTimeouts

updateConfigRevision Boolean

Set to true to update the assignment with the latest revision of the storage configuration.

assignmentName string

The name of the assignment

config string

The name of the storage configuration to be assigned.

cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

controller string

The name of the location where the storage configuration is created.

groups string[]

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

satelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

timeouts SatelliteStorageAssignmentTimeouts

updateConfigRevision boolean

Set to true to update the assignment with the latest revision of the storage configuration.

assignment_name str

The name of the assignment

config str

The name of the storage configuration to be assigned.

cluster str

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

controller str

The name of the location where the storage configuration is created.

groups Sequence[str]

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

satellite_storage_assignment_id str

(String) ID of the Storage Assignment Resource

timeouts SatelliteStorageAssignmentTimeoutsArgs

update_config_revision bool

Set to true to update the assignment with the latest revision of the storage configuration.

assignmentName String

The name of the assignment

config String

The name of the storage configuration to be assigned.

cluster String

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

controller String

The name of the location where the storage configuration is created.

groups List<String>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

satelliteStorageAssignmentId String

(String) ID of the Storage Assignment Resource

timeouts Property Map

updateConfigRevision Boolean

Set to true to update the assignment with the latest revision of the storage configuration.

Outputs

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

AssignmentType string: (String) The Type of Assignment.
ConfigUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
ConfigVersion string: (String) The Current Storage Configuration Version.
ConfigVersionUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
Created string: (String) The Time of Creation of the Assignment.
Id string: The provider-assigned unique ID for this managed resource.
IsAssignmentUpgradeAvailable bool: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
Owner string: (String) The Owner of the Assignment.
RolloutErrorCount double: (String) The Rollout Error Count of the Assignment.
RolloutSuccessCount double: (String) The Rollout Success Count of the Assignment.
SatCluster string: (String) ID of the Satellite cluster that you have assigned the configuration to.
SvcCluster string: (String) ID of the Service Cluster that you have assigned the configuration to.
Uuid string: (String) The Universally Unique IDentifier (UUID) of the Assignment.

AssignmentType string: (String) The Type of Assignment.
ConfigUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
ConfigVersion string: (String) The Current Storage Configuration Version.
ConfigVersionUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
Created string: (String) The Time of Creation of the Assignment.
Id string: The provider-assigned unique ID for this managed resource.
IsAssignmentUpgradeAvailable bool: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
Owner string: (String) The Owner of the Assignment.
RolloutErrorCount float64: (String) The Rollout Error Count of the Assignment.
RolloutSuccessCount float64: (String) The Rollout Success Count of the Assignment.
SatCluster string: (String) ID of the Satellite cluster that you have assigned the configuration to.
SvcCluster string: (String) ID of the Service Cluster that you have assigned the configuration to.
Uuid string: (String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentType String: (String) The Type of Assignment.
configUuid String: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
configVersion String: (String) The Current Storage Configuration Version.
configVersionUuid String: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
created String: (String) The Time of Creation of the Assignment.
id String: The provider-assigned unique ID for this managed resource.
isAssignmentUpgradeAvailable Boolean: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
owner String: (String) The Owner of the Assignment.
rolloutErrorCount Double: (String) The Rollout Error Count of the Assignment.
rolloutSuccessCount Double: (String) The Rollout Success Count of the Assignment.
satCluster String: (String) ID of the Satellite cluster that you have assigned the configuration to.
svcCluster String: (String) ID of the Service Cluster that you have assigned the configuration to.
uuid String: (String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentType string: (String) The Type of Assignment.
configUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
configVersion string: (String) The Current Storage Configuration Version.
configVersionUuid string: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
created string: (String) The Time of Creation of the Assignment.
id string: The provider-assigned unique ID for this managed resource.
isAssignmentUpgradeAvailable boolean: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
owner string: (String) The Owner of the Assignment.
rolloutErrorCount number: (String) The Rollout Error Count of the Assignment.
rolloutSuccessCount number: (String) The Rollout Success Count of the Assignment.
satCluster string: (String) ID of the Satellite cluster that you have assigned the configuration to.
svcCluster string: (String) ID of the Service Cluster that you have assigned the configuration to.
uuid string: (String) The Universally Unique IDentifier (UUID) of the Assignment.

assignment_type str: (String) The Type of Assignment.
config_uuid str: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
config_version str: (String) The Current Storage Configuration Version.
config_version_uuid str: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
created str: (String) The Time of Creation of the Assignment.
id str: The provider-assigned unique ID for this managed resource.
is_assignment_upgrade_available bool: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
owner str: (String) The Owner of the Assignment.
rollout_error_count float: (String) The Rollout Error Count of the Assignment.
rollout_success_count float: (String) The Rollout Success Count of the Assignment.
sat_cluster str: (String) ID of the Satellite cluster that you have assigned the configuration to.
svc_cluster str: (String) ID of the Service Cluster that you have assigned the configuration to.
uuid str: (String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentType String: (String) The Type of Assignment.
configUuid String: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
configVersion String: (String) The Current Storage Configuration Version.
configVersionUuid String: (String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.
created String: (String) The Time of Creation of the Assignment.
id String: The provider-assigned unique ID for this managed resource.
isAssignmentUpgradeAvailable Boolean: (Bool) Whether a Configuration Revision Update is Available for the Assignment.
owner String: (String) The Owner of the Assignment.
rolloutErrorCount Number: (String) The Rollout Error Count of the Assignment.
rolloutSuccessCount Number: (String) The Rollout Success Count of the Assignment.
satCluster String: (String) ID of the Satellite cluster that you have assigned the configuration to.
svcCluster String: (String) ID of the Service Cluster that you have assigned the configuration to.
uuid String: (String) The Universally Unique IDentifier (UUID) of the Assignment.

Look up Existing SatelliteStorageAssignment Resource

Get an existing SatelliteStorageAssignment 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?: SatelliteStorageAssignmentState, opts?: CustomResourceOptions): SatelliteStorageAssignment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        assignment_name: Optional[str] = None,
        assignment_type: Optional[str] = None,
        cluster: Optional[str] = None,
        config: Optional[str] = None,
        config_uuid: Optional[str] = None,
        config_version: Optional[str] = None,
        config_version_uuid: Optional[str] = None,
        controller: Optional[str] = None,
        created: Optional[str] = None,
        groups: Optional[Sequence[str]] = None,
        is_assignment_upgrade_available: Optional[bool] = None,
        owner: Optional[str] = None,
        rollout_error_count: Optional[float] = None,
        rollout_success_count: Optional[float] = None,
        sat_cluster: Optional[str] = None,
        satellite_storage_assignment_id: Optional[str] = None,
        svc_cluster: Optional[str] = None,
        timeouts: Optional[SatelliteStorageAssignmentTimeoutsArgs] = None,
        update_config_revision: Optional[bool] = None,
        uuid: Optional[str] = None) -> SatelliteStorageAssignment

func GetSatelliteStorageAssignment(ctx *Context, name string, id IDInput, state *SatelliteStorageAssignmentState, opts ...ResourceOption) (*SatelliteStorageAssignment, error)

public static SatelliteStorageAssignment Get(string name, Input<string> id, SatelliteStorageAssignmentState? state, CustomResourceOptions? opts = null)

public static SatelliteStorageAssignment get(String name, Output<String> id, SatelliteStorageAssignmentState state, CustomResourceOptions options)

resources:  _:    type: ibm:SatelliteStorageAssignment    get:      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:

AssignmentName string

The name of the assignment

AssignmentType string

(String) The Type of Assignment.

Cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

Config string

The name of the storage configuration to be assigned.

ConfigUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

ConfigVersion string

(String) The Current Storage Configuration Version.

ConfigVersionUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

Controller string

The name of the location where the storage configuration is created.

Created string

(String) The Time of Creation of the Assignment.

Groups List<string>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

IsAssignmentUpgradeAvailable bool

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

Owner string

(String) The Owner of the Assignment.

RolloutErrorCount double

(String) The Rollout Error Count of the Assignment.

RolloutSuccessCount double

(String) The Rollout Success Count of the Assignment.

SatCluster string

(String) ID of the Satellite cluster that you have assigned the configuration to.

SatelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

SvcCluster string

(String) ID of the Service Cluster that you have assigned the configuration to.

Timeouts SatelliteStorageAssignmentTimeouts

UpdateConfigRevision bool

Set to true to update the assignment with the latest revision of the storage configuration.

Uuid string

(String) The Universally Unique IDentifier (UUID) of the Assignment.

AssignmentName string

The name of the assignment

AssignmentType string

(String) The Type of Assignment.

Cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

Config string

The name of the storage configuration to be assigned.

ConfigUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

ConfigVersion string

(String) The Current Storage Configuration Version.

ConfigVersionUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

Controller string

The name of the location where the storage configuration is created.

Created string

(String) The Time of Creation of the Assignment.

Groups []string

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

IsAssignmentUpgradeAvailable bool

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

Owner string

(String) The Owner of the Assignment.

RolloutErrorCount float64

(String) The Rollout Error Count of the Assignment.

RolloutSuccessCount float64

(String) The Rollout Success Count of the Assignment.

SatCluster string

(String) ID of the Satellite cluster that you have assigned the configuration to.

SatelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

SvcCluster string

(String) ID of the Service Cluster that you have assigned the configuration to.

Timeouts SatelliteStorageAssignmentTimeoutsArgs

UpdateConfigRevision bool

Set to true to update the assignment with the latest revision of the storage configuration.

Uuid string

(String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentName String

The name of the assignment

assignmentType String

(String) The Type of Assignment.

cluster String

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

config String

The name of the storage configuration to be assigned.

configUuid String

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

configVersion String

(String) The Current Storage Configuration Version.

configVersionUuid String

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

controller String

The name of the location where the storage configuration is created.

created String

(String) The Time of Creation of the Assignment.

groups List<String>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

isAssignmentUpgradeAvailable Boolean

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

owner String

(String) The Owner of the Assignment.

rolloutErrorCount Double

(String) The Rollout Error Count of the Assignment.

rolloutSuccessCount Double

(String) The Rollout Success Count of the Assignment.

satCluster String

(String) ID of the Satellite cluster that you have assigned the configuration to.

satelliteStorageAssignmentId String

(String) ID of the Storage Assignment Resource

svcCluster String

(String) ID of the Service Cluster that you have assigned the configuration to.

timeouts SatelliteStorageAssignmentTimeouts

updateConfigRevision Boolean

Set to true to update the assignment with the latest revision of the storage configuration.

uuid String

(String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentName string

The name of the assignment

assignmentType string

(String) The Type of Assignment.

cluster string

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

config string

The name of the storage configuration to be assigned.

configUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

configVersion string

(String) The Current Storage Configuration Version.

configVersionUuid string

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

controller string

The name of the location where the storage configuration is created.

created string

(String) The Time of Creation of the Assignment.

groups string[]

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

isAssignmentUpgradeAvailable boolean

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

owner string

(String) The Owner of the Assignment.

rolloutErrorCount number

(String) The Rollout Error Count of the Assignment.

rolloutSuccessCount number

(String) The Rollout Success Count of the Assignment.

satCluster string

(String) ID of the Satellite cluster that you have assigned the configuration to.

satelliteStorageAssignmentId string

(String) ID of the Storage Assignment Resource

svcCluster string

(String) ID of the Service Cluster that you have assigned the configuration to.

timeouts SatelliteStorageAssignmentTimeouts

updateConfigRevision boolean

Set to true to update the assignment with the latest revision of the storage configuration.

uuid string

(String) The Universally Unique IDentifier (UUID) of the Assignment.

assignment_name str

The name of the assignment

assignment_type str

(String) The Type of Assignment.

cluster str

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

config str

The name of the storage configuration to be assigned.

config_uuid str

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

config_version str

(String) The Current Storage Configuration Version.

config_version_uuid str

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

controller str

The name of the location where the storage configuration is created.

created str

(String) The Time of Creation of the Assignment.

groups Sequence[str]

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

is_assignment_upgrade_available bool

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

owner str

(String) The Owner of the Assignment.

rollout_error_count float

(String) The Rollout Error Count of the Assignment.

rollout_success_count float

(String) The Rollout Success Count of the Assignment.

sat_cluster str

(String) ID of the Satellite cluster that you have assigned the configuration to.

satellite_storage_assignment_id str

(String) ID of the Storage Assignment Resource

svc_cluster str

(String) ID of the Service Cluster that you have assigned the configuration to.

timeouts SatelliteStorageAssignmentTimeoutsArgs

update_config_revision bool

Set to true to update the assignment with the latest revision of the storage configuration.

uuid str

(String) The Universally Unique IDentifier (UUID) of the Assignment.

assignmentName String

The name of the assignment

assignmentType String

(String) The Type of Assignment.

cluster String

The id of the cluster you wish to assign the defined configuration too.

Constraints: Required with controller

config String

The name of the storage configuration to be assigned.

configUuid String

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

configVersion String

(String) The Current Storage Configuration Version.

configVersionUuid String

(String) The Universally Unique IDentifier (UUID) of the Storage Configuration Version.

controller String

The name of the location where the storage configuration is created.

created String

(String) The Time of Creation of the Assignment.

groups List<String>

) A list of strings of cluster groups you want to assign the defined configuration too.

Constraints: Required with controller

isAssignmentUpgradeAvailable Boolean

(Bool) Whether a Configuration Revision Update is Available for the Assignment.

owner String

(String) The Owner of the Assignment.

rolloutErrorCount Number

(String) The Rollout Error Count of the Assignment.

rolloutSuccessCount Number

(String) The Rollout Success Count of the Assignment.

satCluster String

(String) ID of the Satellite cluster that you have assigned the configuration to.

satelliteStorageAssignmentId String

(String) ID of the Storage Assignment Resource

svcCluster String

(String) ID of the Service Cluster that you have assigned the configuration to.

timeouts Property Map

updateConfigRevision Boolean

Set to true to update the assignment with the latest revision of the storage configuration.

uuid String

(String) The Universally Unique IDentifier (UUID) of the Assignment.

Supporting Types

SatelliteStorageAssignmentTimeouts, SatelliteStorageAssignmentTimeoutsArgs

Create string
Delete string
Update string

Create string
Delete string
Update string

create String
delete String
update String

create string
delete string
update string

create str
delete str
update str

create String
delete String
update String

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm-cloud/terraform-provider-ibm

ibm.SatelliteStorageAssignment

On this page

On this page

Example Usage

Sample to create a storage assignment to a cluster

Sample to create a storage assignment to a group

Sample to update the storage configuration revision to a cluster/group

Create SatelliteStorageAssignment Resource

Constructor syntax

Parameters

Constructor example

SatelliteStorageAssignment Resource Properties

Inputs

Outputs

Look up Existing SatelliteStorageAssignment Resource

Supporting Types

SatelliteStorageAssignmentTimeouts, SatelliteStorageAssignmentTimeoutsArgs

Package Details

On this page

On this page