1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. UscSecret
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.UscSecret

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    Universal Secrets Connector secret resource

    Create UscSecret Resource

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

    Constructor syntax

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

@overload
def UscSecret(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              secret_name: Optional[str] = None,
              usc_name: Optional[str] = None,
              region: Optional[str] = None,
              namespace: Optional[str] = None,
              object_type: Optional[str] = None,
              pfx_password: Optional[str] = None,
              binary_value: Optional[bool] = None,
              force_delete: Optional[bool] = None,
              tags: Optional[Sequence[str]] = None,
              usc_encryption_key: Optional[str] = None,
              description: Optional[str] = None,
              usc_secret_id: Optional[str] = None,
              value: Optional[str] = None,
              version_id: Optional[str] = None)
    func NewUscSecret(ctx *Context, name string, args UscSecretArgs, opts ...ResourceOption) (*UscSecret, error)
    public UscSecret(string name, UscSecretArgs args, CustomResourceOptions? opts = null)
    public UscSecret(String name, UscSecretArgs args)
public UscSecret(String name, UscSecretArgs args, CustomResourceOptions options)

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


    resource "akeyless_uscsecret" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args UscSecretArgs
    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 UscSecretArgs
    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 UscSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UscSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UscSecretArgs
    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 uscSecretResource = new Akeyless.UscSecret("uscSecretResource", new()
{
    SecretName = "string",
    UscName = "string",
    Region = "string",
    Namespace = "string",
    ObjectType = "string",
    PfxPassword = "string",
    BinaryValue = false,
    ForceDelete = false,
    Tags = new[]
    {
        "string",
    },
    UscEncryptionKey = "string",
    Description = "string",
    UscSecretId = "string",
    Value = "string",
    VersionId = "string",
});

    example, err := akeyless.NewUscSecret(ctx, "uscSecretResource", &akeyless.UscSecretArgs{
	SecretName:  pulumi.String("string"),
	UscName:     pulumi.String("string"),
	Region:      pulumi.String("string"),
	Namespace:   pulumi.String("string"),
	ObjectType:  pulumi.String("string"),
	PfxPassword: pulumi.String("string"),
	BinaryValue: pulumi.Bool(false),
	ForceDelete: pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UscEncryptionKey: pulumi.String("string"),
	Description:      pulumi.String("string"),
	UscSecretId:      pulumi.String("string"),
	Value:            pulumi.String("string"),
	VersionId:        pulumi.String("string"),
})

    resource "akeyless_uscsecret" "uscSecretResource" {
  secret_name        = "string"
  usc_name           = "string"
  region             = "string"
  namespace          = "string"
  object_type        = "string"
  pfx_password       = "string"
  binary_value       = false
  force_delete       = false
  tags               = ["string"]
  usc_encryption_key = "string"
  description        = "string"
  usc_secret_id      = "string"
  value              = "string"
  version_id         = "string"
}

    var uscSecretResource = new UscSecret("uscSecretResource", UscSecretArgs.builder()
    .secretName("string")
    .uscName("string")
    .region("string")
    .namespace("string")
    .objectType("string")
    .pfxPassword("string")
    .binaryValue(false)
    .forceDelete(false)
    .tags("string")
    .uscEncryptionKey("string")
    .description("string")
    .uscSecretId("string")
    .value("string")
    .versionId("string")
    .build());

    usc_secret_resource = akeyless.UscSecret("uscSecretResource",
    secret_name="string",
    usc_name="string",
    region="string",
    namespace="string",
    object_type="string",
    pfx_password="string",
    binary_value=False,
    force_delete=False,
    tags=["string"],
    usc_encryption_key="string",
    description="string",
    usc_secret_id="string",
    value="string",
    version_id="string")

    const uscSecretResource = new akeyless.UscSecret("uscSecretResource", {
    secretName: "string",
    uscName: "string",
    region: "string",
    namespace: "string",
    objectType: "string",
    pfxPassword: "string",
    binaryValue: false,
    forceDelete: false,
    tags: ["string"],
    uscEncryptionKey: "string",
    description: "string",
    uscSecretId: "string",
    value: "string",
    versionId: "string",
});

    type: akeyless:UscSecret
properties:
    binaryValue: false
    description: string
    forceDelete: false
    namespace: string
    objectType: string
    pfxPassword: string
    region: string
    secretName: string
    tags:
        - string
    uscEncryptionKey: string
    uscName: string
    uscSecretId: string
    value: string
    versionId: string

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

    SecretName string
    Name for the new universal secrets
    UscName string
    Name of the Universal Secrets Connector item
    BinaryValue bool
    Use this option if the universal secrets value is a base64 encoded binary
    Description string
    Description of the universal secrets
    ForceDelete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    Namespace string
    The namespace (relevant for Hashi vault target)
    ObjectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    PfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    Region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    Tags List<string>
    Tags for the universal secrets
    UscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    UscSecretId string
    The ID of this resource.
    Value string
    Value of the universal secrets item, either text or base64 encoded binary
    VersionId string
    The version id (if not specified, will retrieve the last version)
    SecretName string
    Name for the new universal secrets
    UscName string
    Name of the Universal Secrets Connector item
    BinaryValue bool
    Use this option if the universal secrets value is a base64 encoded binary
    Description string
    Description of the universal secrets
    ForceDelete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    Namespace string
    The namespace (relevant for Hashi vault target)
    ObjectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    PfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    Region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    Tags []string
    Tags for the universal secrets
    UscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    UscSecretId string
    The ID of this resource.
    Value string
    Value of the universal secrets item, either text or base64 encoded binary
    VersionId string
    The version id (if not specified, will retrieve the last version)
    secret_name string
    Name for the new universal secrets
    usc_name string
    Name of the Universal Secrets Connector item
    binary_value bool
    Use this option if the universal secrets value is a base64 encoded binary
    description string
    Description of the universal secrets
    force_delete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace string
    The namespace (relevant for Hashi vault target)
    object_type string
    Either secret or certificate (Relevant only for Azure KV targets)
    pfx_password string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    tags list(string)
    Tags for the universal secrets
    usc_encryption_key string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    usc_secret_id string
    The ID of this resource.
    value string
    Value of the universal secrets item, either text or base64 encoded binary
    version_id string
    The version id (if not specified, will retrieve the last version)
    secretName String
    Name for the new universal secrets
    uscName String
    Name of the Universal Secrets Connector item
    binaryValue Boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description String
    Description of the universal secrets
    forceDelete Boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace String
    The namespace (relevant for Hashi vault target)
    objectType String
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword String
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region String
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    tags List<String>
    Tags for the universal secrets
    uscEncryptionKey String
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscSecretId String
    The ID of this resource.
    value String
    Value of the universal secrets item, either text or base64 encoded binary
    versionId String
    The version id (if not specified, will retrieve the last version)
    secretName string
    Name for the new universal secrets
    uscName string
    Name of the Universal Secrets Connector item
    binaryValue boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description string
    Description of the universal secrets
    forceDelete boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace string
    The namespace (relevant for Hashi vault target)
    objectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    tags string[]
    Tags for the universal secrets
    uscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscSecretId string
    The ID of this resource.
    value string
    Value of the universal secrets item, either text or base64 encoded binary
    versionId string
    The version id (if not specified, will retrieve the last version)
    secret_name str
    Name for the new universal secrets
    usc_name str
    Name of the Universal Secrets Connector item
    binary_value bool
    Use this option if the universal secrets value is a base64 encoded binary
    description str
    Description of the universal secrets
    force_delete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace str
    The namespace (relevant for Hashi vault target)
    object_type str
    Either secret or certificate (Relevant only for Azure KV targets)
    pfx_password str
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region str
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    tags Sequence[str]
    Tags for the universal secrets
    usc_encryption_key str
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    usc_secret_id str
    The ID of this resource.
    value str
    Value of the universal secrets item, either text or base64 encoded binary
    version_id str
    The version id (if not specified, will retrieve the last version)
    secretName String
    Name for the new universal secrets
    uscName String
    Name of the Universal Secrets Connector item
    binaryValue Boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description String
    Description of the universal secrets
    forceDelete Boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace String
    The namespace (relevant for Hashi vault target)
    objectType String
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword String
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region String
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    tags List<String>
    Tags for the universal secrets
    uscEncryptionKey String
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscSecretId String
    The ID of this resource.
    value String
    Value of the universal secrets item, either text or base64 encoded binary
    versionId String
    The version id (if not specified, will retrieve the last version)

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SecretId string
    The ID of the universal secrets item
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretId string
    The ID of the universal secrets item
    id string
    The provider-assigned unique ID for this managed resource.
    secret_id string
    The ID of the universal secrets item
    id String
    The provider-assigned unique ID for this managed resource.
    secretId String
    The ID of the universal secrets item
    id string
    The provider-assigned unique ID for this managed resource.
    secretId string
    The ID of the universal secrets item
    id str
    The provider-assigned unique ID for this managed resource.
    secret_id str
    The ID of the universal secrets item
    id String
    The provider-assigned unique ID for this managed resource.
    secretId String
    The ID of the universal secrets item

    Look up Existing UscSecret Resource

    Get an existing UscSecret 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?: UscSecretState, opts?: CustomResourceOptions): UscSecret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        binary_value: Optional[bool] = None,
        description: Optional[str] = None,
        force_delete: Optional[bool] = None,
        namespace: Optional[str] = None,
        object_type: Optional[str] = None,
        pfx_password: Optional[str] = None,
        region: Optional[str] = None,
        secret_id: Optional[str] = None,
        secret_name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        usc_encryption_key: Optional[str] = None,
        usc_name: Optional[str] = None,
        usc_secret_id: Optional[str] = None,
        value: Optional[str] = None,
        version_id: Optional[str] = None) -> UscSecret
    func GetUscSecret(ctx *Context, name string, id IDInput, state *UscSecretState, opts ...ResourceOption) (*UscSecret, error)
    public static UscSecret Get(string name, Input<string> id, UscSecretState? state, CustomResourceOptions? opts = null)
    public static UscSecret get(String name, Output<String> id, UscSecretState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:UscSecret    get:      id: ${id}
    import {
  to = akeyless_uscsecret.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BinaryValue bool
    Use this option if the universal secrets value is a base64 encoded binary
    Description string
    Description of the universal secrets
    ForceDelete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    Namespace string
    The namespace (relevant for Hashi vault target)
    ObjectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    PfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    Region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    SecretId string
    The ID of the universal secrets item
    SecretName string
    Name for the new universal secrets
    Tags List<string>
    Tags for the universal secrets
    UscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    UscName string
    Name of the Universal Secrets Connector item
    UscSecretId string
    The ID of this resource.
    Value string
    Value of the universal secrets item, either text or base64 encoded binary
    VersionId string
    The version id (if not specified, will retrieve the last version)
    BinaryValue bool
    Use this option if the universal secrets value is a base64 encoded binary
    Description string
    Description of the universal secrets
    ForceDelete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    Namespace string
    The namespace (relevant for Hashi vault target)
    ObjectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    PfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    Region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    SecretId string
    The ID of the universal secrets item
    SecretName string
    Name for the new universal secrets
    Tags []string
    Tags for the universal secrets
    UscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    UscName string
    Name of the Universal Secrets Connector item
    UscSecretId string
    The ID of this resource.
    Value string
    Value of the universal secrets item, either text or base64 encoded binary
    VersionId string
    The version id (if not specified, will retrieve the last version)
    binary_value bool
    Use this option if the universal secrets value is a base64 encoded binary
    description string
    Description of the universal secrets
    force_delete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace string
    The namespace (relevant for Hashi vault target)
    object_type string
    Either secret or certificate (Relevant only for Azure KV targets)
    pfx_password string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    secret_id string
    The ID of the universal secrets item
    secret_name string
    Name for the new universal secrets
    tags list(string)
    Tags for the universal secrets
    usc_encryption_key string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    usc_name string
    Name of the Universal Secrets Connector item
    usc_secret_id string
    The ID of this resource.
    value string
    Value of the universal secrets item, either text or base64 encoded binary
    version_id string
    The version id (if not specified, will retrieve the last version)
    binaryValue Boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description String
    Description of the universal secrets
    forceDelete Boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace String
    The namespace (relevant for Hashi vault target)
    objectType String
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword String
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region String
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    secretId String
    The ID of the universal secrets item
    secretName String
    Name for the new universal secrets
    tags List<String>
    Tags for the universal secrets
    uscEncryptionKey String
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscName String
    Name of the Universal Secrets Connector item
    uscSecretId String
    The ID of this resource.
    value String
    Value of the universal secrets item, either text or base64 encoded binary
    versionId String
    The version id (if not specified, will retrieve the last version)
    binaryValue boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description string
    Description of the universal secrets
    forceDelete boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace string
    The namespace (relevant for Hashi vault target)
    objectType string
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword string
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region string
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    secretId string
    The ID of the universal secrets item
    secretName string
    Name for the new universal secrets
    tags string[]
    Tags for the universal secrets
    uscEncryptionKey string
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscName string
    Name of the Universal Secrets Connector item
    uscSecretId string
    The ID of this resource.
    value string
    Value of the universal secrets item, either text or base64 encoded binary
    versionId string
    The version id (if not specified, will retrieve the last version)
    binary_value bool
    Use this option if the universal secrets value is a base64 encoded binary
    description str
    Description of the universal secrets
    force_delete bool
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace str
    The namespace (relevant for Hashi vault target)
    object_type str
    Either secret or certificate (Relevant only for Azure KV targets)
    pfx_password str
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region str
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    secret_id str
    The ID of the universal secrets item
    secret_name str
    Name for the new universal secrets
    tags Sequence[str]
    Tags for the universal secrets
    usc_encryption_key str
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    usc_name str
    Name of the Universal Secrets Connector item
    usc_secret_id str
    The ID of this resource.
    value str
    Value of the universal secrets item, either text or base64 encoded binary
    version_id str
    The version id (if not specified, will retrieve the last version)
    binaryValue Boolean
    Use this option if the universal secrets value is a base64 encoded binary
    description String
    Description of the universal secrets
    forceDelete Boolean
    Force delete objects that are soft deleted by default (relevant only for Azure target)
    namespace String
    The namespace (relevant for Hashi vault target)
    objectType String
    Either secret or certificate (Relevant only for Azure KV targets)
    pfxPassword String
    Optional, the passphrase that protects the private key within the pfx certificate (Relevant only for Azure KV certificates)
    region String
    Optional, create secret in a specific region (GCP only). If empty, a global secret will be created (provider default).
    secretId String
    The ID of the universal secrets item
    secretName String
    Name for the new universal secrets
    tags List<String>
    Tags for the universal secrets
    uscEncryptionKey String
    Optional, The name of the remote key that used to encrypt the secret value (if empty, the default key will be used)
    uscName String
    Name of the Universal Secrets Connector item
    uscSecretId String
    The ID of this resource.
    value String
    Value of the universal secrets item, either text or base64 encoded binary
    versionId String
    The version id (if not specified, will retrieve the last version)

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.