published on Thursday, Nov 19, 2026 by akeyless-community
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:
- Usc
Name string - Universal Secret Connector name, If not provided all attached USC's will be synced
- Delete
From boolUsc - 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 stringId - The ID of this resource.
- Name string
- Folder name
- Namespace string
- Retry
Folder
Sync Retry - 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 boolUsc - 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 stringId - The ID of this resource.
- Name string
- Folder name
- Namespace string
- Retry
Folder
Sync Retry Args - 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_ boolusc - 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_ stringid - 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
- delete
From BooleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote Boolean - Delete the secret from the remote target as well
- engine
Name String - Hashi Vault engine name prefix, must end with '/'
- folder
Sync StringId - The ID of this resource.
- name String
- Folder name
- namespace String
- retry
Folder
Sync Retry - 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 booleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote boolean - Delete the secret from the remote target as well
- engine
Name string - Hashi Vault engine name prefix, must end with '/'
- folder
Sync stringId - The ID of this resource.
- name string
- Folder name
- namespace string
- retry
Folder
Sync Retry - 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_ boolusc - 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_ strid - The ID of this resource.
- name str
- Folder name
- namespace str
- retry
Folder
Sync Retry Args - 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 BooleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote Boolean - Delete the secret from the remote target as well
- engine
Name String - Hashi Vault engine name prefix, must end with '/'
- folder
Sync StringId - 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) -> FolderSyncfunc 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.
- Delete
From boolUsc - 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 stringId - The ID of this resource.
- Name string
- Folder name
- Namespace string
- Retry
Folder
Sync Retry - 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 boolUsc - 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 stringId - The ID of this resource.
- Name string
- Folder name
- Namespace string
- Retry
Folder
Sync Retry Args - 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_ boolusc - 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_ stringid - 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
- delete
From BooleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote Boolean - Delete the secret from the remote target as well
- engine
Name String - Hashi Vault engine name prefix, must end with '/'
- folder
Sync StringId - The ID of this resource.
- name String
- Folder name
- namespace String
- retry
Folder
Sync Retry - 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 booleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote boolean - Delete the secret from the remote target as well
- engine
Name string - Hashi Vault engine name prefix, must end with '/'
- folder
Sync stringId - The ID of this resource.
- name string
- Folder name
- namespace string
- retry
Folder
Sync Retry - 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_ boolusc - 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_ strid - The ID of this resource.
- name str
- Folder name
- namespace str
- retry
Folder
Sync Retry Args - 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 BooleanUsc - Delete the secrets from the remote target usc as well
- delete
Remote Boolean - Delete the secret from the remote target as well
- engine
Name String - Hashi Vault engine name prefix, must end with '/'
- folder
Sync StringId - 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.
- usc
Name String - Universal Secret Connector name, If not provided all attached USC's will be synced
Supporting Types
FolderSyncRetry, FolderSyncRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - 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_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - 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 numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - 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_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - 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 NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - 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
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community