Class Setting

Provides a Rancher v2 Setting resource. This can be used to create settings for Rancher v2 environments and retrieve their information.

On create, if setting already exists, provider will import it and update its value.

On destroy, if setting is a system setting like server-url, provider'll not delete it from Rancher, it'll just update setting value to default and remove it from tfstate.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
public MyStack()
{
    // Create a new rancher2 Setting
    var foo = new Rancher2.Setting("foo", new Rancher2.SettingArgs
    {
        Value = "<VALUE>",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Setting

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class Setting : CustomResource

Constructors

Setting(String, SettingArgs, CustomResourceOptions)

Create a Setting resource with the given unique name, arguments, and options.

Declaration

public Setting(string name, SettingArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SettingArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Annotations

Annotations for setting object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Labels

Labels for setting object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

The name of the setting (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Value

The value of the setting (string)

Declaration

public Output<string> Value { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, SettingState, CustomResourceOptions)

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

Declaration

public static Setting Get(string name, Input<string> id, SettingState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SettingState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Setting