1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. Usc
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 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,
            item_custom_fields: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            gcp_folder_id: Optional[str] = None,
            gcp_organization_id: Optional[str] = None,
            gcp_project_id: Optional[str] = None,
            gcp_scope: Optional[str] = None,
            description: Optional[str] = None,
            gcp_sm_regions: Optional[str] = None,
            k8s_namespace: Optional[str] = None,
            azure_kv_name: Optional[str] = None,
            retry: Optional[UscRetryArgs] = None,
            tags: Optional[Sequence[str]] = None,
            delete_protection: Optional[str] = None,
            usc_id: Optional[str] = None,
            usc_prefix: Optional[str] = None,
            use_prefix_as_filter: 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.
    
    
    resource "akeyless_usc" "name" {
        # resource properties
    }

    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",
        ItemCustomFields = 
        {
            { "string", "string" },
        },
        Name = "string",
        GcpFolderId = "string",
        GcpOrganizationId = "string",
        GcpProjectId = "string",
        GcpScope = "string",
        Description = "string",
        GcpSmRegions = "string",
        K8sNamespace = "string",
        AzureKvName = "string",
        Retry = new Akeyless.Inputs.UscRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        Tags = new[]
        {
            "string",
        },
        DeleteProtection = "string",
        UscId = "string",
        UscPrefix = "string",
        UsePrefixAsFilter = "string",
    });
    
    example, err := akeyless.NewUsc(ctx, "uscResource", &akeyless.UscArgs{
    	TargetToAssociate: pulumi.String("string"),
    	ItemCustomFields: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:              pulumi.String("string"),
    	GcpFolderId:       pulumi.String("string"),
    	GcpOrganizationId: pulumi.String("string"),
    	GcpProjectId:      pulumi.String("string"),
    	GcpScope:          pulumi.String("string"),
    	Description:       pulumi.String("string"),
    	GcpSmRegions:      pulumi.String("string"),
    	K8sNamespace:      pulumi.String("string"),
    	AzureKvName:       pulumi.String("string"),
    	Retry: &akeyless.UscRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DeleteProtection:  pulumi.String("string"),
    	UscId:             pulumi.String("string"),
    	UscPrefix:         pulumi.String("string"),
    	UsePrefixAsFilter: pulumi.String("string"),
    })
    
    resource "akeyless_usc" "uscResource" {
      lifecycle {
        create_before_destroy = true
      }
      target_to_associate = "string"
      item_custom_fields = {
        "string" = "string"
      }
      name                = "string"
      gcp_folder_id       = "string"
      gcp_organization_id = "string"
      gcp_project_id      = "string"
      gcp_scope           = "string"
      description         = "string"
      gcp_sm_regions      = "string"
      k8s_namespace       = "string"
      azure_kv_name       = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      tags                 = ["string"]
      delete_protection    = "string"
      usc_id               = "string"
      usc_prefix           = "string"
      use_prefix_as_filter = "string"
    }
    
    var uscResource = new Usc("uscResource", UscArgs.builder()
        .targetToAssociate("string")
        .itemCustomFields(Map.of("string", "string"))
        .name("string")
        .gcpFolderId("string")
        .gcpOrganizationId("string")
        .gcpProjectId("string")
        .gcpScope("string")
        .description("string")
        .gcpSmRegions("string")
        .k8sNamespace("string")
        .azureKvName("string")
        .retry(UscRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .tags("string")
        .deleteProtection("string")
        .uscId("string")
        .uscPrefix("string")
        .usePrefixAsFilter("string")
        .build());
    
    usc_resource = akeyless.Usc("uscResource",
        target_to_associate="string",
        item_custom_fields={
            "string": "string",
        },
        name="string",
        gcp_folder_id="string",
        gcp_organization_id="string",
        gcp_project_id="string",
        gcp_scope="string",
        description="string",
        gcp_sm_regions="string",
        k8s_namespace="string",
        azure_kv_name="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        },
        tags=["string"],
        delete_protection="string",
        usc_id="string",
        usc_prefix="string",
        use_prefix_as_filter="string")
    
    const uscResource = new akeyless.Usc("uscResource", {
        targetToAssociate: "string",
        itemCustomFields: {
            string: "string",
        },
        name: "string",
        gcpFolderId: "string",
        gcpOrganizationId: "string",
        gcpProjectId: "string",
        gcpScope: "string",
        description: "string",
        gcpSmRegions: "string",
        k8sNamespace: "string",
        azureKvName: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        tags: ["string"],
        deleteProtection: "string",
        uscId: "string",
        uscPrefix: "string",
        usePrefixAsFilter: "string",
    });
    
    type: akeyless:Usc
    properties:
        azureKvName: string
        deleteProtection: string
        description: string
        gcpFolderId: string
        gcpOrganizationId: string
        gcpProjectId: string
        gcpScope: string
        gcpSmRegions: string
        itemCustomFields:
            string: string
        k8sNamespace: string
        name: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        tags:
            - string
        targetToAssociate: string
        uscId: string
        uscPrefix: string
        usePrefixAsFilter: 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
    GcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    GcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    GcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    GcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    GcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    Tags List<string>
    List of the tags attached to this Universal Secrets Connector
    UscId string
    The ID of this resource.
    UscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    UsePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    GcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    GcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    GcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    GcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    GcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Retry UscRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    Tags []string
    List of the tags attached to this Universal Secrets Connector
    UscId string
    The ID of this resource.
    UscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    UsePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    target_to_associate string
    Target Universal Secrets Connector to connect
    azure_kv_name string
    Azure Key Vault name (Relevant only for Azure targets)
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the Universal Secrets Connector
    gcp_folder_id string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcp_organization_id string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcp_project_id string
    GCP Project ID (Relevant only for GCP targets)
    gcp_scope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcp_sm_regions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    item_custom_fields map(string)
    Additional custom fields to associate with the item
    k8s_namespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags list(string)
    List of the tags attached to this Universal Secrets Connector
    usc_id string
    The ID of this resource.
    usc_prefix string
    Prefix for all secrets created in AWS Secrets Manager
    use_prefix_as_filter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId String
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId String
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId String
    GCP Project ID (Relevant only for GCP targets)
    gcpScope String
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions String
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    uscId String
    The ID of this resource.
    uscPrefix String
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter String
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    gcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    k8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags string[]
    List of the tags attached to this Universal Secrets Connector
    uscId string
    The ID of this resource.
    uscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcp_folder_id str
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcp_organization_id str
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcp_project_id str
    GCP Project ID (Relevant only for GCP targets)
    gcp_scope str
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcp_sm_regions str
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    k8s_namespace str
    K8s namespace (Relevant to Kubernetes targets)
    name str
    Universal Secrets Connector name
    retry UscRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags Sequence[str]
    List of the tags attached to this Universal Secrets Connector
    usc_id str
    The ID of this resource.
    usc_prefix str
    Prefix for all secrets created in AWS Secrets Manager
    use_prefix_as_filter str
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId String
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId String
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId String
    GCP Project ID (Relevant only for GCP targets)
    gcpScope String
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions String
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags List<String>
    List of the tags attached to this Universal Secrets Connector
    uscId String
    The ID of this resource.
    uscPrefix String
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter String
    Whether to filter the USC secret list using the specified usc-prefix [true/false]

    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 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,
            gcp_folder_id: Optional[str] = None,
            gcp_organization_id: Optional[str] = None,
            gcp_project_id: Optional[str] = None,
            gcp_scope: Optional[str] = None,
            gcp_sm_regions: Optional[str] = None,
            item_custom_fields: Optional[Mapping[str, str]] = None,
            k8s_namespace: Optional[str] = None,
            name: Optional[str] = None,
            retry: Optional[UscRetryArgs] = None,
            tags: Optional[Sequence[str]] = None,
            target_to_associate: Optional[str] = None,
            usc_id: Optional[str] = None,
            usc_prefix: Optional[str] = None,
            use_prefix_as_filter: 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:  existingUsc:    type: akeyless:Usc    get:      id: ${id}
    import {
      to = akeyless_usc.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state UscState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state UscState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state UscState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state UscState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control 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
    GcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    GcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    GcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    GcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    GcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    UscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    UsePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    GcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    GcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    GcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    GcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    GcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    K8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    Name string
    Universal Secrets Connector name
    Retry UscRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    UscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    UsePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    azure_kv_name string
    Azure Key Vault name (Relevant only for Azure targets)
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the Universal Secrets Connector
    gcp_folder_id string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcp_organization_id string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcp_project_id string
    GCP Project ID (Relevant only for GCP targets)
    gcp_scope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcp_sm_regions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    item_custom_fields map(string)
    Additional custom fields to associate with the item
    k8s_namespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    tags list(string)
    List of the tags attached to this Universal Secrets Connector
    target_to_associate string
    Target Universal Secrets Connector to connect
    usc_id string
    The ID of this resource.
    usc_prefix string
    Prefix for all secrets created in AWS Secrets Manager
    use_prefix_as_filter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId String
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId String
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId String
    GCP Project ID (Relevant only for GCP targets)
    gcpScope String
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions String
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    uscPrefix String
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter String
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId string
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId string
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId string
    GCP Project ID (Relevant only for GCP targets)
    gcpScope string
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions string
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    k8sNamespace string
    K8s namespace (Relevant to Kubernetes targets)
    name string
    Universal Secrets Connector name
    retry UscRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    uscPrefix string
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter string
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcp_folder_id str
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcp_organization_id str
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcp_project_id str
    GCP Project ID (Relevant only for GCP targets)
    gcp_scope str
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcp_sm_regions str
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    k8s_namespace str
    K8s namespace (Relevant to Kubernetes targets)
    name str
    Universal Secrets Connector name
    retry UscRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    usc_prefix str
    Prefix for all secrets created in AWS Secrets Manager
    use_prefix_as_filter str
    Whether to filter the USC secret list using the specified usc-prefix [true/false]
    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
    gcpFolderId String
    GCP Folder ID (Relevant only for GCP targets with folder scope)
    gcpOrganizationId String
    GCP Organization ID (Relevant only for GCP targets with folder or organization scope)
    gcpProjectId String
    GCP Project ID (Relevant only for GCP targets)
    gcpScope String
    The GCP USC scope [project/folder/organization]. With folder/organization, all projects under the folder/org are manageable. Relevant only for GCP targets. Defaults to project when empty
    gcpSmRegions String
    GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    k8sNamespace String
    K8s namespace (Relevant to Kubernetes targets)
    name String
    Universal Secrets Connector name
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.
    uscPrefix String
    Prefix for all secrets created in AWS Secrets Manager
    usePrefixAsFilter String
    Whether to filter the USC secret list using the specified usc-prefix [true/false]

    Supporting Types

    UscRetry, UscRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial