1. Packages
  2. Akeyless Provider
  3. API Docs
  4. Usc
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.Usc

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Universal Secrets Connector resource

    Create Usc Resource

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

    Constructor syntax

    new Usc(name: string, args: UscArgs, opts?: CustomResourceOptions);
    @overload
    def Usc(resource_name: str,
            args: UscArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Usc(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            target_to_associate: Optional[str] = None,
            azure_kv_name: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            k8s_namespace: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            usc_id: Optional[str] = None)
    func NewUsc(ctx *Context, name string, args UscArgs, opts ...ResourceOption) (*Usc, error)
    public Usc(string name, UscArgs args, CustomResourceOptions? opts = null)
    public Usc(String name, UscArgs args)
    public Usc(String name, UscArgs args, CustomResourceOptions options)
    
    type: akeyless:Usc
    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 UscArgs
    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 UscArgs
    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 UscArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UscArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UscArgs
    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 uscResource = new Akeyless.Usc("uscResource", new()
    {
        TargetToAssociate = "string",
        AzureKvName = "string",
        DeleteProtection = "string",
        Description = "string",
        K8sNamespace = "string",
        Name = "string",
        Tags = new[]
        {
            "string",
        },
        UscId = "string",
    });
    
    example, err := akeyless.NewUsc(ctx, "uscResource", &akeyless.UscArgs{
    	TargetToAssociate: pulumi.String("string"),
    	AzureKvName:       pulumi.String("string"),
    	DeleteProtection:  pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	K8sNamespace:      pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	UscId: pulumi.String("string"),
    })
    
    var uscResource = new Usc("uscResource", UscArgs.builder()
        .targetToAssociate("string")
        .azureKvName("string")
        .deleteProtection("string")
        .description("string")
        .k8sNamespace("string")
        .name("string")
        .tags("string")
        .uscId("string")
        .build());
    
    usc_resource = akeyless.Usc("uscResource",
        target_to_associate="string",
        azure_kv_name="string",
        delete_protection="string",
        description="string",
        k8s_namespace="string",
        name="string",
        tags=["string"],
        usc_id="string")
    
    const uscResource = new akeyless.Usc("uscResource", {
        targetToAssociate: "string",
        azureKvName: "string",
        deleteProtection: "string",
        description: "string",
        k8sNamespace: "string",
        name: "string",
        tags: ["string"],
        uscId: "string",
    });
    
    type: akeyless:Usc
    properties:
        azureKvName: string
        deleteProtection: string
        description: string
        k8sNamespace: string
        name: string
        tags:
            - string
        targetToAssociate: string
        uscId: string
    

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

    TargetToAssociate string
    Target Universal Secrets Connector to connect
    AzureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    DeleteProtection string
    Protection from accidental deletion of this object, [true/false]
    Description string
    Description of the Universal Secrets Connector
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Tags List<string>
    List of the tags attached to this Universal Secrets Connector
    UscId string
    The ID of this resource.
    TargetToAssociate string
    Target Universal Secrets Connector to connect
    AzureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    DeleteProtection string
    Protection from accidental deletion of this object, [true/false]
    Description string
    Description of the Universal Secrets Connector
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Tags []string
    List of the tags attached to this Universal Secrets Connector
    UscId string
    The ID of this resource.
    targetToAssociate String
    Target Universal Secrets Connector to connect
    azureKvName String
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection String
    Protection from accidental deletion of this object, [true/false]
    description String
    Description of the Universal Secrets Connector
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    uscId String
    The ID of this resource.
    targetToAssociate string
    Target Universal Secrets Connector to connect
    azureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection string
    Protection from accidental deletion of this object, [true/false]
    description string
    Description of the Universal Secrets Connector
    k8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    tags string[]
    List of the tags attached to this Universal Secrets Connector
    uscId string
    The ID of this resource.
    target_to_associate str
    Target Universal Secrets Connector to connect
    azure_kv_name str
    Azure Key Vault name (Relevant only for Azure targets)
    delete_protection str
    Protection from accidental deletion of this object, [true/false]
    description str
    Description of the Universal Secrets Connector
    k8s_namespace str
    K8s namespace (Relevant to Kubernetes targets)
    name str
    Universal Secrets Connector name
    tags Sequence[str]
    List of the tags attached to this Universal Secrets Connector
    usc_id str
    The ID of this resource.
    targetToAssociate String
    Target Universal Secrets Connector to connect
    azureKvName String
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection String
    Protection from accidental deletion of this object, [true/false]
    description String
    Description of the Universal Secrets Connector
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    uscId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Usc Resource

    Get an existing Usc 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?: UscState, opts?: CustomResourceOptions): Usc
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            azure_kv_name: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            k8s_namespace: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            target_to_associate: Optional[str] = None,
            usc_id: Optional[str] = None) -> Usc
    func GetUsc(ctx *Context, name string, id IDInput, state *UscState, opts ...ResourceOption) (*Usc, error)
    public static Usc Get(string name, Input<string> id, UscState? state, CustomResourceOptions? opts = null)
    public static Usc get(String name, Output<String> id, UscState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:Usc    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:
    AzureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    DeleteProtection string
    Protection from accidental deletion of this object, [true/false]
    Description string
    Description of the Universal Secrets Connector
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Tags List<string>
    List of the tags attached to this Universal Secrets Connector
    TargetToAssociate string
    Target Universal Secrets Connector to connect
    UscId string
    The ID of this resource.
    AzureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    DeleteProtection string
    Protection from accidental deletion of this object, [true/false]
    Description string
    Description of the Universal Secrets Connector
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Tags []string
    List of the tags attached to this Universal Secrets Connector
    TargetToAssociate string
    Target Universal Secrets Connector to connect
    UscId string
    The ID of this resource.
    azureKvName String
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection String
    Protection from accidental deletion of this object, [true/false]
    description String
    Description of the Universal Secrets Connector
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    targetToAssociate String
    Target Universal Secrets Connector to connect
    uscId String
    The ID of this resource.
    azureKvName string
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection string
    Protection from accidental deletion of this object, [true/false]
    description string
    Description of the Universal Secrets Connector
    k8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    tags string[]
    List of the tags attached to this Universal Secrets Connector
    targetToAssociate string
    Target Universal Secrets Connector to connect
    uscId string
    The ID of this resource.
    azure_kv_name str
    Azure Key Vault name (Relevant only for Azure targets)
    delete_protection str
    Protection from accidental deletion of this object, [true/false]
    description str
    Description of the Universal Secrets Connector
    k8s_namespace str
    K8s namespace (Relevant to Kubernetes targets)
    name str
    Universal Secrets Connector name
    tags Sequence[str]
    List of the tags attached to this Universal Secrets Connector
    target_to_associate str
    Target Universal Secrets Connector to connect
    usc_id str
    The ID of this resource.
    azureKvName String
    Azure Key Vault name (Relevant only for Azure targets)
    deleteProtection String
    Protection from accidental deletion of this object, [true/false]
    description String
    Description of the Universal Secrets Connector
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    targetToAssociate String
    Target Universal Secrets Connector to connect
    uscId String
    The ID of this resource.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community