FolderSync

akeyless 2.0.2, Jun 18 26

Viewing docs for akeyless 2.0.2
published on Thursday, Jun 18, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.2
published on Thursday, Jun 18, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

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)

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_foldersync" "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",
});

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"),
})

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"
}

var folderSyncResource = new FolderSync("folderSyncResource", FolderSyncArgs.builder()
    .uscName("string")
    .deleteFromUsc(false)
    .deleteRemote(false)
    .engineName("string")
    .folderSyncId("string")
    .name("string")
    .namespace("string")
    .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")

const folderSyncResource = new akeyless.FolderSync("folderSyncResource", {
    uscName: "string",
    deleteFromUsc: false,
    deleteRemote: false,
    engineName: "string",
    folderSyncId: "string",
    name: "string",
    namespace: "string",
});

type: akeyless:FolderSync
properties:
    deleteFromUsc: false
    deleteRemote: false
    engineName: string
    folderSyncId: string
    name: string
    namespace: string
    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

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

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

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

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

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

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

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,
        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:  _:    type: akeyless:FolderSync    get:      id: ${id}

import {
  to = akeyless_foldersync.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

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
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
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
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
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
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
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
uscName String: Universal Secret Connector name, If not provided all attached USC's will be synced

Package Details

Repository: akeyless akeyless-community/terraform-provider-akeyless
License
Notes: This Pulumi package is based on the akeyless Terraform Provider.

Viewing docs for akeyless 2.0.2
published on Thursday, Jun 18, 2026 by akeyless-community

Schema (JSON)

akeyless-community/terraform-provider-akeyless

akeyless.FolderSync

On this page

On this page

Create FolderSync Resource

Constructor syntax

Parameters

Constructor example

FolderSync Resource Properties

Inputs

Outputs

Look up Existing FolderSync Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

akeyless.FolderSync

On this page

On this page

Create FolderSync Resource

Constructor syntax

Parameters

Constructor example

FolderSync Resource Properties

Inputs

Outputs

Look up Existing FolderSync Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.