1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. FolderSync
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

    Folder sync resource

    Create FolderSync Resource

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

    Constructor syntax

    new FolderSync(name: string, args: FolderSyncArgs, opts?: CustomResourceOptions);
    @overload
    def FolderSync(resource_name: str,
                   args: FolderSyncArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def FolderSync(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   usc_name: Optional[str] = None,
                   delete_from_usc: Optional[bool] = None,
                   delete_remote: Optional[bool] = None,
                   engine_name: Optional[str] = None,
                   folder_sync_id: Optional[str] = None,
                   name: Optional[str] = None,
                   namespace: Optional[str] = None,
                   retry: Optional[FolderSyncRetryArgs] = None)
    func NewFolderSync(ctx *Context, name string, args FolderSyncArgs, opts ...ResourceOption) (*FolderSync, error)
    public FolderSync(string name, FolderSyncArgs args, CustomResourceOptions? opts = null)
    public FolderSync(String name, FolderSyncArgs args)
    public FolderSync(String name, FolderSyncArgs args, CustomResourceOptions options)
    
    type: akeyless:FolderSync
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_folder_sync" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args FolderSyncArgs
    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 FolderSyncArgs
    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 FolderSyncArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderSyncArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderSyncArgs
    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 folderSyncResource = new Akeyless.FolderSync("folderSyncResource", new()
    {
        UscName = "string",
        DeleteFromUsc = false,
        DeleteRemote = false,
        EngineName = "string",
        FolderSyncId = "string",
        Name = "string",
        Namespace = "string",
        Retry = new Akeyless.Inputs.FolderSyncRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
    });
    
    example, err := akeyless.NewFolderSync(ctx, "folderSyncResource", &akeyless.FolderSyncArgs{
    	UscName:       pulumi.String("string"),
    	DeleteFromUsc: pulumi.Bool(false),
    	DeleteRemote:  pulumi.Bool(false),
    	EngineName:    pulumi.String("string"),
    	FolderSyncId:  pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Namespace:     pulumi.String("string"),
    	Retry: &akeyless.FolderSyncRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    })
    
    resource "akeyless_folder_sync" "folderSyncResource" {
      lifecycle {
        create_before_destroy = true
      }
      usc_name        = "string"
      delete_from_usc = false
      delete_remote   = false
      engine_name     = "string"
      folder_sync_id  = "string"
      name            = "string"
      namespace       = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
    }
    
    var folderSyncResource = new FolderSync("folderSyncResource", FolderSyncArgs.builder()
        .uscName("string")
        .deleteFromUsc(false)
        .deleteRemote(false)
        .engineName("string")
        .folderSyncId("string")
        .name("string")
        .namespace("string")
        .retry(FolderSyncRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .build());
    
    folder_sync_resource = akeyless.FolderSync("folderSyncResource",
        usc_name="string",
        delete_from_usc=False,
        delete_remote=False,
        engine_name="string",
        folder_sync_id="string",
        name="string",
        namespace="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)],
        })
    
    const folderSyncResource = new akeyless.FolderSync("folderSyncResource", {
        uscName: "string",
        deleteFromUsc: false,
        deleteRemote: false,
        engineName: "string",
        folderSyncId: "string",
        name: "string",
        namespace: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
    });
    
    type: akeyless:FolderSync
    properties:
        deleteFromUsc: false
        deleteRemote: false
        engineName: string
        folderSyncId: string
        name: string
        namespace: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        uscName: string
    

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

    UscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    DeleteFromUsc bool
    Delete the secrets from the remote target usc as well
    DeleteRemote bool
    Delete the secret from the remote target as well
    EngineName string
    Hashi Vault engine name prefix, must end with '/'
    FolderSyncId string
    The ID of this resource.
    Name string
    Folder name
    Namespace string
    Retry FolderSyncRetry
    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.
    UscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    DeleteFromUsc bool
    Delete the secrets from the remote target usc as well
    DeleteRemote bool
    Delete the secret from the remote target as well
    EngineName string
    Hashi Vault engine name prefix, must end with '/'
    FolderSyncId string
    The ID of this resource.
    Name string
    Folder name
    Namespace string
    Retry FolderSyncRetryArgs
    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.
    usc_name string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    delete_from_usc bool
    Delete the secrets from the remote target usc as well
    delete_remote bool
    Delete the secret from the remote target as well
    engine_name string
    Hashi Vault engine name prefix, must end with '/'
    folder_sync_id string
    The ID of this resource.
    name string
    Folder name
    namespace string
    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.
    uscName String
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc Boolean
    Delete the secrets from the remote target usc as well
    deleteRemote Boolean
    Delete the secret from the remote target as well
    engineName String
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId String
    The ID of this resource.
    name String
    Folder name
    namespace String
    retry FolderSyncRetry
    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.
    uscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc boolean
    Delete the secrets from the remote target usc as well
    deleteRemote boolean
    Delete the secret from the remote target as well
    engineName string
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId string
    The ID of this resource.
    name string
    Folder name
    namespace string
    retry FolderSyncRetry
    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.
    usc_name str
    Universal Secret Connector name, If not provided all attached USC's will be synced
    delete_from_usc bool
    Delete the secrets from the remote target usc as well
    delete_remote bool
    Delete the secret from the remote target as well
    engine_name str
    Hashi Vault engine name prefix, must end with '/'
    folder_sync_id str
    The ID of this resource.
    name str
    Folder name
    namespace str
    retry FolderSyncRetryArgs
    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.
    uscName String
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc Boolean
    Delete the secrets from the remote target usc as well
    deleteRemote Boolean
    Delete the secret from the remote target as well
    engineName String
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId String
    The ID of this resource.
    name String
    Folder name
    namespace String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FolderSync 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 FolderSync Resource

    Get an existing FolderSync 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?: FolderSyncState, opts?: CustomResourceOptions): FolderSync
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            delete_from_usc: Optional[bool] = None,
            delete_remote: Optional[bool] = None,
            engine_name: Optional[str] = None,
            folder_sync_id: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            retry: Optional[FolderSyncRetryArgs] = None,
            usc_name: Optional[str] = None) -> FolderSync
    func GetFolderSync(ctx *Context, name string, id IDInput, state *FolderSyncState, opts ...ResourceOption) (*FolderSync, error)
    public static FolderSync Get(string name, Input<string> id, FolderSyncState? state, CustomResourceOptions? opts = null)
    public static FolderSync get(String name, Output<String> id, FolderSyncState state, CustomResourceOptions options)
    resources:  existingFolderSync:    type: akeyless:FolderSync    get:      id: ${id}
    import {
      to = akeyless_folder_sync.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 FolderSyncState
    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 FolderSyncState
    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 FolderSyncState
    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 FolderSyncState
    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:
    DeleteFromUsc bool
    Delete the secrets from the remote target usc as well
    DeleteRemote bool
    Delete the secret from the remote target as well
    EngineName string
    Hashi Vault engine name prefix, must end with '/'
    FolderSyncId string
    The ID of this resource.
    Name string
    Folder name
    Namespace string
    Retry FolderSyncRetry
    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.
    UscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    DeleteFromUsc bool
    Delete the secrets from the remote target usc as well
    DeleteRemote bool
    Delete the secret from the remote target as well
    EngineName string
    Hashi Vault engine name prefix, must end with '/'
    FolderSyncId string
    The ID of this resource.
    Name string
    Folder name
    Namespace string
    Retry FolderSyncRetryArgs
    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.
    UscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    delete_from_usc bool
    Delete the secrets from the remote target usc as well
    delete_remote bool
    Delete the secret from the remote target as well
    engine_name string
    Hashi Vault engine name prefix, must end with '/'
    folder_sync_id string
    The ID of this resource.
    name string
    Folder name
    namespace string
    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.
    usc_name string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc Boolean
    Delete the secrets from the remote target usc as well
    deleteRemote Boolean
    Delete the secret from the remote target as well
    engineName String
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId String
    The ID of this resource.
    name String
    Folder name
    namespace String
    retry FolderSyncRetry
    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.
    uscName String
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc boolean
    Delete the secrets from the remote target usc as well
    deleteRemote boolean
    Delete the secret from the remote target as well
    engineName string
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId string
    The ID of this resource.
    name string
    Folder name
    namespace string
    retry FolderSyncRetry
    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.
    uscName string
    Universal Secret Connector name, If not provided all attached USC's will be synced
    delete_from_usc bool
    Delete the secrets from the remote target usc as well
    delete_remote bool
    Delete the secret from the remote target as well
    engine_name str
    Hashi Vault engine name prefix, must end with '/'
    folder_sync_id str
    The ID of this resource.
    name str
    Folder name
    namespace str
    retry FolderSyncRetryArgs
    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.
    usc_name str
    Universal Secret Connector name, If not provided all attached USC's will be synced
    deleteFromUsc Boolean
    Delete the secrets from the remote target usc as well
    deleteRemote Boolean
    Delete the secret from the remote target as well
    engineName String
    Hashi Vault engine name prefix, must end with '/'
    folderSyncId String
    The ID of this resource.
    name String
    Folder name
    namespace String
    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.
    uscName String
    Universal Secret Connector name, If not provided all attached USC's will be synced

    Supporting Types

    FolderSyncRetry, FolderSyncRetryArgs

    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