published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
Folder Resource
Create Folder Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Folder(name: string, args?: FolderArgs, opts?: CustomResourceOptions);@overload
def Folder(resource_name: str,
args: Optional[FolderArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Folder(resource_name: str,
opts: Optional[ResourceOptions] = None,
akeyless_folder_id: Optional[str] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
retry: Optional[FolderRetryArgs] = None,
tags: Optional[Sequence[str]] = None)func NewFolder(ctx *Context, name string, args *FolderArgs, opts ...ResourceOption) (*Folder, error)public Folder(string name, FolderArgs? args = null, CustomResourceOptions? opts = null)
public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)
type: akeyless:Folder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_folder" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args FolderArgs
- 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 FolderArgs
- 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 FolderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FolderArgs
- 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 folderResource = new Akeyless.Folder("folderResource", new()
{
AkeylessFolderId = "string",
DeleteProtection = "string",
Description = "string",
Name = "string",
Retry = new Akeyless.Inputs.FolderRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
Tags = new[]
{
"string",
},
});
example, err := akeyless.NewFolder(ctx, "folderResource", &akeyless.FolderArgs{
AkeylessFolderId: pulumi.String("string"),
DeleteProtection: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Retry: &akeyless.FolderRetryArgs{
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"),
},
})
resource "akeyless_folder" "folderResource" {
lifecycle {
create_before_destroy = true
}
akeyless_folder_id = "string"
delete_protection = "string"
description = "string"
name = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
tags = ["string"]
}
var folderResource = new Folder("folderResource", FolderArgs.builder()
.akeylessFolderId("string")
.deleteProtection("string")
.description("string")
.name("string")
.retry(FolderRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.tags("string")
.build());
folder_resource = akeyless.Folder("folderResource",
akeyless_folder_id="string",
delete_protection="string",
description="string",
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"])
const folderResource = new akeyless.Folder("folderResource", {
akeylessFolderId: "string",
deleteProtection: "string",
description: "string",
name: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
tags: ["string"],
});
type: akeyless:Folder
properties:
akeylessFolderId: string
deleteProtection: string
description: string
name: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
tags:
- string
Folder 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 Folder resource accepts the following input properties:
- Akeyless
Folder stringId - The ID of this resource.
- Delete
Protection string - Protection from accidental deletion of this folder [true/false]
- Description string
- Description of the object
- Name string
- The name to the folder
- Retry
Folder
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.
- List<string>
- List of tags attached to this folder
- Akeyless
Folder stringId - The ID of this resource.
- Delete
Protection string - Protection from accidental deletion of this folder [true/false]
- Description string
- Description of the object
- Name string
- The name to the folder
- Retry
Folder
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.
- []string
- List of tags attached to this folder
- akeyless_
folder_ stringid - The ID of this resource.
- delete_
protection string - Protection from accidental deletion of this folder [true/false]
- description string
- Description of the object
- name string
- The name to the folder
- 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.
- list(string)
- List of tags attached to this folder
- akeyless
Folder StringId - The ID of this resource.
- delete
Protection String - Protection from accidental deletion of this folder [true/false]
- description String
- Description of the object
- name String
- The name to the folder
- retry
Folder
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.
- List<String>
- List of tags attached to this folder
- akeyless
Folder stringId - The ID of this resource.
- delete
Protection string - Protection from accidental deletion of this folder [true/false]
- description string
- Description of the object
- name string
- The name to the folder
- retry
Folder
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.
- string[]
- List of tags attached to this folder
- akeyless_
folder_ strid - The ID of this resource.
- delete_
protection str - Protection from accidental deletion of this folder [true/false]
- description str
- Description of the object
- name str
- The name to the folder
- retry
Folder
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.
- Sequence[str]
- List of tags attached to this folder
- akeyless
Folder StringId - The ID of this resource.
- delete
Protection String - Protection from accidental deletion of this folder [true/false]
- description String
- Description of the object
- name String
- The name to the folder
- 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.
- List<String>
- List of tags attached to this folder
Outputs
All input properties are implicitly available as output properties. Additionally, the Folder resource produces the following output properties:
Look up Existing Folder Resource
Get an existing Folder 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?: FolderState, opts?: CustomResourceOptions): Folder@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
akeyless_folder_id: Optional[str] = None,
delete_protection: Optional[str] = None,
description: Optional[str] = None,
folder_id: Optional[float] = None,
name: Optional[str] = None,
retry: Optional[FolderRetryArgs] = None,
tags: Optional[Sequence[str]] = None) -> Folderfunc GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)public static Folder get(String name, Output<String> id, FolderState state, CustomResourceOptions options)resources: existingFolder: type: akeyless:Folder get: id: ${id}import {
to = akeyless_folder.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 FolderState
- 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 FolderState
- 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 FolderState
- 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 FolderState
- 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.
- Akeyless
Folder stringId - The ID of this resource.
- Delete
Protection string - Protection from accidental deletion of this folder [true/false]
- Description string
- Description of the object
- Folder
Id double - The ID of the folder
- Name string
- The name to the folder
- Retry
Folder
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.
- List<string>
- List of tags attached to this folder
- Akeyless
Folder stringId - The ID of this resource.
- Delete
Protection string - Protection from accidental deletion of this folder [true/false]
- Description string
- Description of the object
- Folder
Id float64 - The ID of the folder
- Name string
- The name to the folder
- Retry
Folder
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.
- []string
- List of tags attached to this folder
- akeyless_
folder_ stringid - The ID of this resource.
- delete_
protection string - Protection from accidental deletion of this folder [true/false]
- description string
- Description of the object
- folder_
id number - The ID of the folder
- name string
- The name to the folder
- 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.
- list(string)
- List of tags attached to this folder
- akeyless
Folder StringId - The ID of this resource.
- delete
Protection String - Protection from accidental deletion of this folder [true/false]
- description String
- Description of the object
- folder
Id Double - The ID of the folder
- name String
- The name to the folder
- retry
Folder
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.
- List<String>
- List of tags attached to this folder
- akeyless
Folder stringId - The ID of this resource.
- delete
Protection string - Protection from accidental deletion of this folder [true/false]
- description string
- Description of the object
- folder
Id number - The ID of the folder
- name string
- The name to the folder
- retry
Folder
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.
- string[]
- List of tags attached to this folder
- akeyless_
folder_ strid - The ID of this resource.
- delete_
protection str - Protection from accidental deletion of this folder [true/false]
- description str
- Description of the object
- folder_
id float - The ID of the folder
- name str
- The name to the folder
- retry
Folder
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.
- Sequence[str]
- List of tags attached to this folder
- akeyless
Folder StringId - The ID of this resource.
- delete
Protection String - Protection from accidental deletion of this folder [true/false]
- description String
- Description of the object
- folder
Id Number - The ID of the folder
- name String
- The name to the folder
- 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.
- List<String>
- List of tags attached to this folder
Supporting Types
FolderRetry, FolderRetryArgs
- 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