SecretV2

Provides a Rancher Secret v2 resource. This can be used to create k8s secrets for Rancher v2 environments and retrieve their information. Secret v2 resource is available at Rancher v2.5.x and above.

Create a SecretV2 Resource

new SecretV2(name: string, args: SecretV2Args, opts?: CustomResourceOptions);
@overload
def SecretV2(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             annotations: Optional[Mapping[str, Any]] = None,
             cluster_id: Optional[str] = None,
             data: Optional[Mapping[str, Any]] = None,
             immutable: Optional[bool] = None,
             labels: Optional[Mapping[str, Any]] = None,
             name: Optional[str] = None,
             namespace: Optional[str] = None,
             type: Optional[str] = None)
@overload
def SecretV2(resource_name: str,
             args: SecretV2Args,
             opts: Optional[ResourceOptions] = None)
func NewSecretV2(ctx *Context, name string, args SecretV2Args, opts ...ResourceOption) (*SecretV2, error)
public SecretV2(string name, SecretV2Args args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args SecretV2Args
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 SecretV2Args
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 SecretV2Args
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SecretV2Args
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

SecretV2 Resource Properties

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

Inputs

The SecretV2 resource accepts the following input properties:

ClusterId string
The cluster id of the secret V2 (string)
Data Dictionary<string, object>
The data of the secret v2 (map)
Annotations Dictionary<string, object>
Annotations for the secret v2 (map)
Immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
Labels Dictionary<string, object>
Labels for the secret v2 (map)
Name string
The name of the secret v2 (string)
Namespace string
The namespaces of the secret v2. Default: default (string)
Type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
ClusterId string
The cluster id of the secret V2 (string)
Data map[string]interface{}
The data of the secret v2 (map)
Annotations map[string]interface{}
Annotations for the secret v2 (map)
Immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
Labels map[string]interface{}
Labels for the secret v2 (map)
Name string
The name of the secret v2 (string)
Namespace string
The namespaces of the secret v2. Default: default (string)
Type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
clusterId string
The cluster id of the secret V2 (string)
data {[key: string]: any}
The data of the secret v2 (map)
annotations {[key: string]: any}
Annotations for the secret v2 (map)
immutable boolean
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
labels {[key: string]: any}
Labels for the secret v2 (map)
name string
The name of the secret v2 (string)
namespace string
The namespaces of the secret v2. Default: default (string)
type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
cluster_id str
The cluster id of the secret V2 (string)
data Mapping[str, Any]
The data of the secret v2 (map)
annotations Mapping[str, Any]
Annotations for the secret v2 (map)
immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
labels Mapping[str, Any]
Labels for the secret v2 (map)
name str
The name of the secret v2 (string)
namespace str
The namespaces of the secret v2. Default: default (string)
type str
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ResourceVersion string
(Computed) The k8s resource version (string)
Id string
The provider-assigned unique ID for this managed resource.
ResourceVersion string
(Computed) The k8s resource version (string)
id string
The provider-assigned unique ID for this managed resource.
resourceVersion string
(Computed) The k8s resource version (string)
id str
The provider-assigned unique ID for this managed resource.
resource_version str
(Computed) The k8s resource version (string)

Look up an Existing SecretV2 Resource

Get an existing SecretV2 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?: SecretV2State, opts?: CustomResourceOptions): SecretV2
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, Any]] = None,
        cluster_id: Optional[str] = None,
        data: Optional[Mapping[str, Any]] = None,
        immutable: Optional[bool] = None,
        labels: Optional[Mapping[str, Any]] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        resource_version: Optional[str] = None,
        type: Optional[str] = None) -> SecretV2
func GetSecretV2(ctx *Context, name string, id IDInput, state *SecretV2State, opts ...ResourceOption) (*SecretV2, error)
public static SecretV2 Get(string name, Input<string> id, SecretV2State? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Annotations Dictionary<string, object>
Annotations for the secret v2 (map)
ClusterId string
The cluster id of the secret V2 (string)
Data Dictionary<string, object>
The data of the secret v2 (map)
Immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
Labels Dictionary<string, object>
Labels for the secret v2 (map)
Name string
The name of the secret v2 (string)
Namespace string
The namespaces of the secret v2. Default: default (string)
ResourceVersion string
(Computed) The k8s resource version (string)
Type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
Annotations map[string]interface{}
Annotations for the secret v2 (map)
ClusterId string
The cluster id of the secret V2 (string)
Data map[string]interface{}
The data of the secret v2 (map)
Immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
Labels map[string]interface{}
Labels for the secret v2 (map)
Name string
The name of the secret v2 (string)
Namespace string
The namespaces of the secret v2. Default: default (string)
ResourceVersion string
(Computed) The k8s resource version (string)
Type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
annotations {[key: string]: any}
Annotations for the secret v2 (map)
clusterId string
The cluster id of the secret V2 (string)
data {[key: string]: any}
The data of the secret v2 (map)
immutable boolean
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
labels {[key: string]: any}
Labels for the secret v2 (map)
name string
The name of the secret v2 (string)
namespace string
The namespaces of the secret v2. Default: default (string)
resourceVersion string
(Computed) The k8s resource version (string)
type string
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)
annotations Mapping[str, Any]
Annotations for the secret v2 (map)
cluster_id str
The cluster id of the secret V2 (string)
data Mapping[str, Any]
The data of the secret v2 (map)
immutable bool
If set to true, any secret update will remove and recreate the secret. This is a beta field enabled by k8s ImmutableEphemeralVolumes feature gate. Default: false (bool)
labels Mapping[str, Any]
Labels for the secret v2 (map)
name str
The name of the secret v2 (string)
namespace str
The namespaces of the secret v2. Default: default (string)
resource_version str
(Computed) The k8s resource version (string)
type str
The type of the k8s secret, used to facilitate programmatic handling of secret data, More info about k8s secret types and expected format. Default: Opaque (string)

Import

V2 secrets can be imported using the Rancher cluster ID, Secret V2 namespace and name.

 $ pulumi import rancher2:index/secretV2:SecretV2 foo &lt;CLUSTER_ID&gt;.&lt;SECRET_V2_NAMESPACE&gt;/&lt;SECRET_V2_NAME&gt;

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.