Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteStorageConfiguration
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteStorageConfiguration

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete IBM Cloud Storage Configuration. By using storage templates, you can create storage configurations that can be consistently assigned, updated, and managed across the clusters, service clusters, and cluster groups in your location.

    Example Usage

    Sample to create a storage configuration by using the odf-remote storage template

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

const storageConfiguration = new ibm.SatelliteStorageConfiguration("storageConfiguration", {
    configName: "config-name",
    location: "location-name",
    storageTemplateName: "odf-remote",
    storageTemplateVersion: "4.12",
    userConfigParameters: {
        "billing-type": "advanced",
        "cluster-encryption": "false",
        "ibm-cos-endpoint": "",
        "ibm-cos-location": "",
        "ignore-noobaa": "false",
        "kms-base-url": "",
        "kms-encryption": "false",
        "kms-instance-id": "",
        "kms-instance-name": "",
        "kms-token-url": "",
        "num-of-osd": "1",
        "odf-upgrade": "true",
        "osd-size": "100Gi",
        "osd-storage-class": "ibmc-vpc-block-metro-5iops-tier",
        "perform-cleanup": "false",
        "worker-nodes": "",
    },
    userSecretParameters: {
        "iam-api-key": "apikey",
    },
});

    import pulumi
import pulumi_ibm as ibm

storage_configuration = ibm.SatelliteStorageConfiguration("storageConfiguration",
    config_name="config-name",
    location="location-name",
    storage_template_name="odf-remote",
    storage_template_version="4.12",
    user_config_parameters={
        "billing-type": "advanced",
        "cluster-encryption": "false",
        "ibm-cos-endpoint": "",
        "ibm-cos-location": "",
        "ignore-noobaa": "false",
        "kms-base-url": "",
        "kms-encryption": "false",
        "kms-instance-id": "",
        "kms-instance-name": "",
        "kms-token-url": "",
        "num-of-osd": "1",
        "odf-upgrade": "true",
        "osd-size": "100Gi",
        "osd-storage-class": "ibmc-vpc-block-metro-5iops-tier",
        "perform-cleanup": "false",
        "worker-nodes": "",
    },
    user_secret_parameters={
        "iam-api-key": "apikey",
    })

    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.NewSatelliteStorageConfiguration(ctx, "storageConfiguration", &ibm.SatelliteStorageConfigurationArgs{
			ConfigName:             pulumi.String("config-name"),
			Location:               pulumi.String("location-name"),
			StorageTemplateName:    pulumi.String("odf-remote"),
			StorageTemplateVersion: pulumi.String("4.12"),
			UserConfigParameters: pulumi.StringMap{
				"billing-type":       pulumi.String("advanced"),
				"cluster-encryption": pulumi.String("false"),
				"ibm-cos-endpoint":   pulumi.String(""),
				"ibm-cos-location":   pulumi.String(""),
				"ignore-noobaa":      pulumi.String("false"),
				"kms-base-url":       pulumi.String(""),
				"kms-encryption":     pulumi.String("false"),
				"kms-instance-id":    pulumi.String(""),
				"kms-instance-name":  pulumi.String(""),
				"kms-token-url":      pulumi.String(""),
				"num-of-osd":         pulumi.String("1"),
				"odf-upgrade":        pulumi.String("true"),
				"osd-size":           pulumi.String("100Gi"),
				"osd-storage-class":  pulumi.String("ibmc-vpc-block-metro-5iops-tier"),
				"perform-cleanup":    pulumi.String("false"),
				"worker-nodes":       pulumi.String(""),
			},
			UserSecretParameters: pulumi.StringMap{
				"iam-api-key": pulumi.String("apikey"),
			},
		})
		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 storageConfiguration = new Ibm.SatelliteStorageConfiguration("storageConfiguration", new()
    {
        ConfigName = "config-name",
        Location = "location-name",
        StorageTemplateName = "odf-remote",
        StorageTemplateVersion = "4.12",
        UserConfigParameters = 
        {
            { "billing-type", "advanced" },
            { "cluster-encryption", "false" },
            { "ibm-cos-endpoint", "" },
            { "ibm-cos-location", "" },
            { "ignore-noobaa", "false" },
            { "kms-base-url", "" },
            { "kms-encryption", "false" },
            { "kms-instance-id", "" },
            { "kms-instance-name", "" },
            { "kms-token-url", "" },
            { "num-of-osd", "1" },
            { "odf-upgrade", "true" },
            { "osd-size", "100Gi" },
            { "osd-storage-class", "ibmc-vpc-block-metro-5iops-tier" },
            { "perform-cleanup", "false" },
            { "worker-nodes", "" },
        },
        UserSecretParameters = 
        {
            { "iam-api-key", "apikey" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SatelliteStorageConfiguration;
import com.pulumi.ibm.SatelliteStorageConfigurationArgs;
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 storageConfiguration = new SatelliteStorageConfiguration("storageConfiguration", SatelliteStorageConfigurationArgs.builder()
            .configName("config-name")
            .location("location-name")
            .storageTemplateName("odf-remote")
            .storageTemplateVersion("4.12")
            .userConfigParameters(Map.ofEntries(
                Map.entry("billing-type", "advanced"),
                Map.entry("cluster-encryption", "false"),
                Map.entry("ibm-cos-endpoint", ""),
                Map.entry("ibm-cos-location", ""),
                Map.entry("ignore-noobaa", "false"),
                Map.entry("kms-base-url", ""),
                Map.entry("kms-encryption", "false"),
                Map.entry("kms-instance-id", ""),
                Map.entry("kms-instance-name", ""),
                Map.entry("kms-token-url", ""),
                Map.entry("num-of-osd", "1"),
                Map.entry("odf-upgrade", "true"),
                Map.entry("osd-size", "100Gi"),
                Map.entry("osd-storage-class", "ibmc-vpc-block-metro-5iops-tier"),
                Map.entry("perform-cleanup", "false"),
                Map.entry("worker-nodes", "")
            ))
            .userSecretParameters(Map.of("iam-api-key", "apikey"))
            .build());

    }
}

    resources:
  storageConfiguration:
    type: ibm:SatelliteStorageConfiguration
    properties:
      configName: config-name
      location: location-name
      storageTemplateName: odf-remote
      storageTemplateVersion: '4.12'
      userConfigParameters:
        billing-type: advanced
        cluster-encryption: 'false'
        ibm-cos-endpoint: ""
        ibm-cos-location: ""
        ignore-noobaa: 'false'
        kms-base-url: ""
        kms-encryption: 'false'
        kms-instance-id: ""
        kms-instance-name: ""
        kms-token-url: ""
        num-of-osd: '1'
        odf-upgrade: 'true'
        osd-size: 100Gi
        osd-storage-class: ibmc-vpc-block-metro-5iops-tier
        perform-cleanup: 'false'
        worker-nodes: ""
      userSecretParameters:
        iam-api-key: apikey

    Create SatelliteStorageConfiguration Resource

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

    Constructor syntax

    new SatelliteStorageConfiguration(name: string, args: SatelliteStorageConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def SatelliteStorageConfiguration(resource_name: str,
                                  args: SatelliteStorageConfigurationArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def SatelliteStorageConfiguration(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  config_name: Optional[str] = None,
                                  location: Optional[str] = None,
                                  storage_template_name: Optional[str] = None,
                                  storage_template_version: Optional[str] = None,
                                  user_config_parameters: Optional[Mapping[str, str]] = None,
                                  user_secret_parameters: Optional[Mapping[str, str]] = None,
                                  delete_assignments: Optional[bool] = None,
                                  satellite_storage_configuration_id: Optional[str] = None,
                                  storage_class_parameters: Optional[Sequence[Mapping[str, str]]] = None,
                                  timeouts: Optional[SatelliteStorageConfigurationTimeoutsArgs] = None,
                                  update_assignments: Optional[bool] = None)
    func NewSatelliteStorageConfiguration(ctx *Context, name string, args SatelliteStorageConfigurationArgs, opts ...ResourceOption) (*SatelliteStorageConfiguration, error)
    public SatelliteStorageConfiguration(string name, SatelliteStorageConfigurationArgs args, CustomResourceOptions? opts = null)
    public SatelliteStorageConfiguration(String name, SatelliteStorageConfigurationArgs args)
public SatelliteStorageConfiguration(String name, SatelliteStorageConfigurationArgs args, CustomResourceOptions options)

    type: ibm:SatelliteStorageConfiguration
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 SatelliteStorageConfigurationArgs
    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 SatelliteStorageConfigurationArgs
    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 SatelliteStorageConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteStorageConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteStorageConfigurationArgs
    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 satelliteStorageConfigurationResource = new Ibm.SatelliteStorageConfiguration("satelliteStorageConfigurationResource", new()
{
    ConfigName = "string",
    Location = "string",
    StorageTemplateName = "string",
    StorageTemplateVersion = "string",
    UserConfigParameters = 
    {
        { "string", "string" },
    },
    UserSecretParameters = 
    {
        { "string", "string" },
    },
    DeleteAssignments = false,
    SatelliteStorageConfigurationId = "string",
    StorageClassParameters = new[]
    {
        
        {
            { "string", "string" },
        },
    },
    Timeouts = new Ibm.Inputs.SatelliteStorageConfigurationTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    UpdateAssignments = false,
});

    example, err := ibm.NewSatelliteStorageConfiguration(ctx, "satelliteStorageConfigurationResource", &ibm.SatelliteStorageConfigurationArgs{
	ConfigName:             pulumi.String("string"),
	Location:               pulumi.String("string"),
	StorageTemplateName:    pulumi.String("string"),
	StorageTemplateVersion: pulumi.String("string"),
	UserConfigParameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UserSecretParameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeleteAssignments:               pulumi.Bool(false),
	SatelliteStorageConfigurationId: pulumi.String("string"),
	StorageClassParameters: pulumi.StringMapArray{
		pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Timeouts: &ibm.SatelliteStorageConfigurationTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	UpdateAssignments: pulumi.Bool(false),
})

    var satelliteStorageConfigurationResource = new SatelliteStorageConfiguration("satelliteStorageConfigurationResource", SatelliteStorageConfigurationArgs.builder()
    .configName("string")
    .location("string")
    .storageTemplateName("string")
    .storageTemplateVersion("string")
    .userConfigParameters(Map.of("string", "string"))
    .userSecretParameters(Map.of("string", "string"))
    .deleteAssignments(false)
    .satelliteStorageConfigurationId("string")
    .storageClassParameters(Map.of("string", "string"))
    .timeouts(SatelliteStorageConfigurationTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .updateAssignments(false)
    .build());

    satellite_storage_configuration_resource = ibm.SatelliteStorageConfiguration("satelliteStorageConfigurationResource",
    config_name="string",
    location="string",
    storage_template_name="string",
    storage_template_version="string",
    user_config_parameters={
        "string": "string",
    },
    user_secret_parameters={
        "string": "string",
    },
    delete_assignments=False,
    satellite_storage_configuration_id="string",
    storage_class_parameters=[{
        "string": "string",
    }],
    timeouts={
        "create": "string",
        "delete": "string",
    },
    update_assignments=False)

    const satelliteStorageConfigurationResource = new ibm.SatelliteStorageConfiguration("satelliteStorageConfigurationResource", {
    configName: "string",
    location: "string",
    storageTemplateName: "string",
    storageTemplateVersion: "string",
    userConfigParameters: {
        string: "string",
    },
    userSecretParameters: {
        string: "string",
    },
    deleteAssignments: false,
    satelliteStorageConfigurationId: "string",
    storageClassParameters: [{
        string: "string",
    }],
    timeouts: {
        create: "string",
        "delete": "string",
    },
    updateAssignments: false,
});

    type: ibm:SatelliteStorageConfiguration
properties:
    configName: string
    deleteAssignments: false
    location: string
    satelliteStorageConfigurationId: string
    storageClassParameters:
        - string: string
    storageTemplateName: string
    storageTemplateVersion: string
    timeouts:
        create: string
        delete: string
    updateAssignments: false
    userConfigParameters:
        string: string
    userSecretParameters:
        string: string

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

    ConfigName string
    The name of the storage configuration to be created.
    Location string
    The name of the location where the storage configuration is created.
    StorageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    StorageTemplateVersion string
    The version of the storage template you'd like to use.
    UserConfigParameters Dictionary<string, string>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    UserSecretParameters Dictionary<string, string>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    DeleteAssignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    SatelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    StorageClassParameters List<ImmutableDictionary<string, string>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    Timeouts SatelliteStorageConfigurationTimeouts
    UpdateAssignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    ConfigName string
    The name of the storage configuration to be created.
    Location string
    The name of the location where the storage configuration is created.
    StorageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    StorageTemplateVersion string
    The version of the storage template you'd like to use.
    UserConfigParameters map[string]string
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    UserSecretParameters map[string]string
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    DeleteAssignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    SatelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    StorageClassParameters []map[string]string
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    Timeouts SatelliteStorageConfigurationTimeoutsArgs
    UpdateAssignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    configName String
    The name of the storage configuration to be created.
    location String
    The name of the location where the storage configuration is created.
    storageTemplateName String
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion String
    The version of the storage template you'd like to use.
    userConfigParameters Map<String,String>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters Map<String,String>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    deleteAssignments Boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    satelliteStorageConfigurationId String
    (String) The ID of the storage configuration resource.
    storageClassParameters List<Map<String,String>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    timeouts SatelliteStorageConfigurationTimeouts
    updateAssignments Boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    configName string
    The name of the storage configuration to be created.
    location string
    The name of the location where the storage configuration is created.
    storageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion string
    The version of the storage template you'd like to use.
    userConfigParameters {[key: string]: string}
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters {[key: string]: string}
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    deleteAssignments boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    satelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    storageClassParameters {[key: string]: string}[]
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    timeouts SatelliteStorageConfigurationTimeouts
    updateAssignments boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    config_name str
    The name of the storage configuration to be created.
    location str
    The name of the location where the storage configuration is created.
    storage_template_name str
    The storage template name to create the storage configuration such as odf-remote.
    storage_template_version str
    The version of the storage template you'd like to use.
    user_config_parameters Mapping[str, str]
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    user_secret_parameters Mapping[str, str]
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    delete_assignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    satellite_storage_configuration_id str
    (String) The ID of the storage configuration resource.
    storage_class_parameters Sequence[Mapping[str, str]]
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    timeouts SatelliteStorageConfigurationTimeoutsArgs
    update_assignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    configName String
    The name of the storage configuration to be created.
    location String
    The name of the location where the storage configuration is created.
    storageTemplateName String
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion String
    The version of the storage template you'd like to use.
    userConfigParameters Map<String>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters Map<String>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    deleteAssignments Boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    satelliteStorageConfigurationId String
    (String) The ID of the storage configuration resource.
    storageClassParameters List<Map<String>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    timeouts Property Map
    updateAssignments Boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.

    Outputs

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

    ConfigVersion string
    (String) The current version of the storage configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    ConfigVersion string
    (String) The current version of the storage configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configVersion String
    (String) The current version of the storage configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configVersion string
    (String) The current version of the storage configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    config_version str
    (String) The current version of the storage configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    uuid str
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configVersion String
    (String) The current version of the storage configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    uuid String
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

    Look up Existing SatelliteStorageConfiguration Resource

    Get an existing SatelliteStorageConfiguration 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?: SatelliteStorageConfigurationState, opts?: CustomResourceOptions): SatelliteStorageConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_name: Optional[str] = None,
        config_version: Optional[str] = None,
        delete_assignments: Optional[bool] = None,
        location: Optional[str] = None,
        satellite_storage_configuration_id: Optional[str] = None,
        storage_class_parameters: Optional[Sequence[Mapping[str, str]]] = None,
        storage_template_name: Optional[str] = None,
        storage_template_version: Optional[str] = None,
        timeouts: Optional[SatelliteStorageConfigurationTimeoutsArgs] = None,
        update_assignments: Optional[bool] = None,
        user_config_parameters: Optional[Mapping[str, str]] = None,
        user_secret_parameters: Optional[Mapping[str, str]] = None,
        uuid: Optional[str] = None) -> SatelliteStorageConfiguration
    func GetSatelliteStorageConfiguration(ctx *Context, name string, id IDInput, state *SatelliteStorageConfigurationState, opts ...ResourceOption) (*SatelliteStorageConfiguration, error)
    public static SatelliteStorageConfiguration Get(string name, Input<string> id, SatelliteStorageConfigurationState? state, CustomResourceOptions? opts = null)
    public static SatelliteStorageConfiguration get(String name, Output<String> id, SatelliteStorageConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SatelliteStorageConfiguration    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:
    ConfigName string
    The name of the storage configuration to be created.
    ConfigVersion string
    (String) The current version of the storage configuration.
    DeleteAssignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    Location string
    The name of the location where the storage configuration is created.
    SatelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    StorageClassParameters List<ImmutableDictionary<string, string>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    StorageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    StorageTemplateVersion string
    The version of the storage template you'd like to use.
    Timeouts SatelliteStorageConfigurationTimeouts
    UpdateAssignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    UserConfigParameters Dictionary<string, string>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    UserSecretParameters Dictionary<string, string>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    Uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    ConfigName string
    The name of the storage configuration to be created.
    ConfigVersion string
    (String) The current version of the storage configuration.
    DeleteAssignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    Location string
    The name of the location where the storage configuration is created.
    SatelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    StorageClassParameters []map[string]string
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    StorageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    StorageTemplateVersion string
    The version of the storage template you'd like to use.
    Timeouts SatelliteStorageConfigurationTimeoutsArgs
    UpdateAssignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    UserConfigParameters map[string]string
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    UserSecretParameters map[string]string
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    Uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configName String
    The name of the storage configuration to be created.
    configVersion String
    (String) The current version of the storage configuration.
    deleteAssignments Boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    location String
    The name of the location where the storage configuration is created.
    satelliteStorageConfigurationId String
    (String) The ID of the storage configuration resource.
    storageClassParameters List<Map<String,String>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    storageTemplateName String
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion String
    The version of the storage template you'd like to use.
    timeouts SatelliteStorageConfigurationTimeouts
    updateAssignments Boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    userConfigParameters Map<String,String>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters Map<String,String>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    uuid String
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configName string
    The name of the storage configuration to be created.
    configVersion string
    (String) The current version of the storage configuration.
    deleteAssignments boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    location string
    The name of the location where the storage configuration is created.
    satelliteStorageConfigurationId string
    (String) The ID of the storage configuration resource.
    storageClassParameters {[key: string]: string}[]
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    storageTemplateName string
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion string
    The version of the storage template you'd like to use.
    timeouts SatelliteStorageConfigurationTimeouts
    updateAssignments boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    userConfigParameters {[key: string]: string}
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters {[key: string]: string}
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    uuid string
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    config_name str
    The name of the storage configuration to be created.
    config_version str
    (String) The current version of the storage configuration.
    delete_assignments bool
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    location str
    The name of the location where the storage configuration is created.
    satellite_storage_configuration_id str
    (String) The ID of the storage configuration resource.
    storage_class_parameters Sequence[Mapping[str, str]]
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    storage_template_name str
    The storage template name to create the storage configuration such as odf-remote.
    storage_template_version str
    The version of the storage template you'd like to use.
    timeouts SatelliteStorageConfigurationTimeoutsArgs
    update_assignments bool
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    user_config_parameters Mapping[str, str]
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    user_secret_parameters Mapping[str, str]
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    uuid str
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.
    configName String
    The name of the storage configuration to be created.
    configVersion String
    (String) The current version of the storage configuration.
    deleteAssignments Boolean
    If set to true it will auto-delete all the configuration's assignments before the configuration's deletion.

    location String
    The name of the location where the storage configuration is created.
    satelliteStorageConfigurationId String
    (String) The ID of the storage configuration resource.
    storageClassParameters List<Map<String>>
    ) A list of Maps, users can enter custom storage classes if the storage template supports it. Each Map will require a key-value of type string.
    storageTemplateName String
    The storage template name to create the storage configuration such as odf-remote.
    storageTemplateVersion String
    The version of the storage template you'd like to use.
    timeouts Property Map
    updateAssignments Boolean
    If set to true it will auto-update all the configuration's assignments with the latest revision after a configuration update.
    userConfigParameters Map<String>
    The Storage Configuration parameters of a particular storage template to be passed to be passed as a Map of string key-value. Both the key-value i.e the configuration parameter name and the respective value must be entered based on the chosen storage template.
    userSecretParameters Map<String>
    The Storage Configuration secret parameters of a particular storage template to be passed as a Map of string key-value. Both the key-value i.e the secret parameter name and the respective value must be entered based on the chosen storage template.
    uuid String
    (String) The Universally Unique IDentifier (UUID) of the Storage Configuration.

    Supporting Types

    SatelliteStorageConfigurationTimeouts, SatelliteStorageConfigurationTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm