akeyless.DynamicSecretCustom

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create DynamicSecretCustom Resource

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

Constructor syntax

new DynamicSecretCustom(name: string, args: DynamicSecretCustomArgs, opts?: CustomResourceOptions);

@overload
def DynamicSecretCustom(resource_name: str,
                        args: DynamicSecretCustomArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def DynamicSecretCustom(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        revoke_sync_url: Optional[str] = None,
                        create_sync_url: Optional[str] = None,
                        encryption_key_name: Optional[str] = None,
                        description: Optional[str] = None,
                        dynamic_secret_custom_id: Optional[str] = None,
                        enable_admin_rotation: Optional[bool] = None,
                        admin_rotation_interval_days: Optional[float] = None,
                        item_custom_fields: Optional[Mapping[str, str]] = None,
                        name: Optional[str] = None,
                        payload: Optional[str] = None,
                        delete_protection: Optional[str] = None,
                        rotate_sync_url: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None,
                        timeout_sec: Optional[float] = None,
                        user_ttl: Optional[str] = None)

func NewDynamicSecretCustom(ctx *Context, name string, args DynamicSecretCustomArgs, opts ...ResourceOption) (*DynamicSecretCustom, error)

public DynamicSecretCustom(string name, DynamicSecretCustomArgs args, CustomResourceOptions? opts = null)

public DynamicSecretCustom(String name, DynamicSecretCustomArgs args)
public DynamicSecretCustom(String name, DynamicSecretCustomArgs args, CustomResourceOptions options)

type: akeyless:DynamicSecretCustom
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_dynamicsecretcustom" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args DynamicSecretCustomArgs: 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 DynamicSecretCustomArgs: 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 DynamicSecretCustomArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DynamicSecretCustomArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DynamicSecretCustomArgs: 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 dynamicSecretCustomResource = new Akeyless.DynamicSecretCustom("dynamicSecretCustomResource", new()
{
    RevokeSyncUrl = "string",
    CreateSyncUrl = "string",
    EncryptionKeyName = "string",
    Description = "string",
    DynamicSecretCustomId = "string",
    EnableAdminRotation = false,
    AdminRotationIntervalDays = 0,
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    Name = "string",
    Payload = "string",
    DeleteProtection = "string",
    RotateSyncUrl = "string",
    Tags = new[]
    {
        "string",
    },
    TimeoutSec = 0,
    UserTtl = "string",
});

example, err := akeyless.NewDynamicSecretCustom(ctx, "dynamicSecretCustomResource", &akeyless.DynamicSecretCustomArgs{
	RevokeSyncUrl:             pulumi.String("string"),
	CreateSyncUrl:             pulumi.String("string"),
	EncryptionKeyName:         pulumi.String("string"),
	Description:               pulumi.String("string"),
	DynamicSecretCustomId:     pulumi.String("string"),
	EnableAdminRotation:       pulumi.Bool(false),
	AdminRotationIntervalDays: pulumi.Float64(0),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:             pulumi.String("string"),
	Payload:          pulumi.String("string"),
	DeleteProtection: pulumi.String("string"),
	RotateSyncUrl:    pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TimeoutSec: pulumi.Float64(0),
	UserTtl:    pulumi.String("string"),
})

resource "akeyless_dynamicsecretcustom" "dynamicSecretCustomResource" {
  revoke_sync_url              = "string"
  create_sync_url              = "string"
  encryption_key_name          = "string"
  description                  = "string"
  dynamic_secret_custom_id     = "string"
  enable_admin_rotation        = false
  admin_rotation_interval_days = 0
  item_custom_fields = {
    "string" = "string"
  }
  name              = "string"
  payload           = "string"
  delete_protection = "string"
  rotate_sync_url   = "string"
  tags              = ["string"]
  timeout_sec       = 0
  user_ttl          = "string"
}

var dynamicSecretCustomResource = new DynamicSecretCustom("dynamicSecretCustomResource", DynamicSecretCustomArgs.builder()
    .revokeSyncUrl("string")
    .createSyncUrl("string")
    .encryptionKeyName("string")
    .description("string")
    .dynamicSecretCustomId("string")
    .enableAdminRotation(false)
    .adminRotationIntervalDays(0.0)
    .itemCustomFields(Map.of("string", "string"))
    .name("string")
    .payload("string")
    .deleteProtection("string")
    .rotateSyncUrl("string")
    .tags("string")
    .timeoutSec(0.0)
    .userTtl("string")
    .build());

dynamic_secret_custom_resource = akeyless.DynamicSecretCustom("dynamicSecretCustomResource",
    revoke_sync_url="string",
    create_sync_url="string",
    encryption_key_name="string",
    description="string",
    dynamic_secret_custom_id="string",
    enable_admin_rotation=False,
    admin_rotation_interval_days=float(0),
    item_custom_fields={
        "string": "string",
    },
    name="string",
    payload="string",
    delete_protection="string",
    rotate_sync_url="string",
    tags=["string"],
    timeout_sec=float(0),
    user_ttl="string")

const dynamicSecretCustomResource = new akeyless.DynamicSecretCustom("dynamicSecretCustomResource", {
    revokeSyncUrl: "string",
    createSyncUrl: "string",
    encryptionKeyName: "string",
    description: "string",
    dynamicSecretCustomId: "string",
    enableAdminRotation: false,
    adminRotationIntervalDays: 0,
    itemCustomFields: {
        string: "string",
    },
    name: "string",
    payload: "string",
    deleteProtection: "string",
    rotateSyncUrl: "string",
    tags: ["string"],
    timeoutSec: 0,
    userTtl: "string",
});

type: akeyless:DynamicSecretCustom
properties:
    adminRotationIntervalDays: 0
    createSyncUrl: string
    deleteProtection: string
    description: string
    dynamicSecretCustomId: string
    enableAdminRotation: false
    encryptionKeyName: string
    itemCustomFields:
        string: string
    name: string
    payload: string
    revokeSyncUrl: string
    rotateSyncUrl: string
    tags:
        - string
    timeoutSec: 0
    userTtl: string

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

CreateSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
RevokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
AdminRotationIntervalDays double: Define rotation interval in days
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretCustomId string: The ID of this resource.
EnableAdminRotation bool: Should admin credentials be rotated
EncryptionKeyName string: Dynamic producer encryption key
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Payload string: Secret payload to be sent with each create/revoke webhook request
RotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
Tags List<string>: Add tags attached to this object
TimeoutSec double: Maximum allowed time in seconds for the webhook to return the results
UserTtl string: User TTL

CreateSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
RevokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
AdminRotationIntervalDays float64: Define rotation interval in days
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretCustomId string: The ID of this resource.
EnableAdminRotation bool: Should admin credentials be rotated
EncryptionKeyName string: Dynamic producer encryption key
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Payload string: Secret payload to be sent with each create/revoke webhook request
RotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
Tags []string: Add tags attached to this object
TimeoutSec float64: Maximum allowed time in seconds for the webhook to return the results
UserTtl string: User TTL

create_sync_url string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
revoke_sync_url string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
admin_rotation_interval_days number: Define rotation interval in days
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamic_secret_custom_id string: The ID of this resource.
enable_admin_rotation bool: Should admin credentials be rotated
encryption_key_name string: Dynamic producer encryption key
item_custom_fields map(string): Additional custom fields to associate with the item
name string: Dynamic secret name
payload string: Secret payload to be sent with each create/revoke webhook request
rotate_sync_url string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags list(string): Add tags attached to this object
timeout_sec number: Maximum allowed time in seconds for the webhook to return the results
user_ttl string: User TTL

createSyncUrl String: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
revokeSyncUrl String: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
adminRotationIntervalDays Double: Define rotation interval in days
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretCustomId String: The ID of this resource.
enableAdminRotation Boolean: Should admin credentials be rotated
encryptionKeyName String: Dynamic producer encryption key
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
payload String: Secret payload to be sent with each create/revoke webhook request
rotateSyncUrl String: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags List<String>: Add tags attached to this object
timeoutSec Double: Maximum allowed time in seconds for the webhook to return the results
userTtl String: User TTL

createSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
revokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
adminRotationIntervalDays number: Define rotation interval in days
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretCustomId string: The ID of this resource.
enableAdminRotation boolean: Should admin credentials be rotated
encryptionKeyName string: Dynamic producer encryption key
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
payload string: Secret payload to be sent with each create/revoke webhook request
rotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags string[]: Add tags attached to this object
timeoutSec number: Maximum allowed time in seconds for the webhook to return the results
userTtl string: User TTL

create_sync_url str: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
revoke_sync_url str: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
admin_rotation_interval_days float: Define rotation interval in days
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_custom_id str: The ID of this resource.
enable_admin_rotation bool: Should admin credentials be rotated
encryption_key_name str: Dynamic producer encryption key
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
payload str: Secret payload to be sent with each create/revoke webhook request
rotate_sync_url str: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags Sequence[str]: Add tags attached to this object
timeout_sec float: Maximum allowed time in seconds for the webhook to return the results
user_ttl str: User TTL

createSyncUrl String: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
revokeSyncUrl String: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
adminRotationIntervalDays Number: Define rotation interval in days
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretCustomId String: The ID of this resource.
enableAdminRotation Boolean: Should admin credentials be rotated
encryptionKeyName String: Dynamic producer encryption key
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
payload String: Secret payload to be sent with each create/revoke webhook request
rotateSyncUrl String: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags List<String>: Add tags attached to this object
timeoutSec Number: Maximum allowed time in seconds for the webhook to return the results
userTtl String: User TTL

Outputs

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

Get an existing DynamicSecretCustom 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?: DynamicSecretCustomState, opts?: CustomResourceOptions): DynamicSecretCustom

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_rotation_interval_days: Optional[float] = None,
        create_sync_url: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_secret_custom_id: Optional[str] = None,
        enable_admin_rotation: Optional[bool] = None,
        encryption_key_name: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        payload: Optional[str] = None,
        revoke_sync_url: Optional[str] = None,
        rotate_sync_url: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeout_sec: Optional[float] = None,
        user_ttl: Optional[str] = None) -> DynamicSecretCustom

func GetDynamicSecretCustom(ctx *Context, name string, id IDInput, state *DynamicSecretCustomState, opts ...ResourceOption) (*DynamicSecretCustom, error)

public static DynamicSecretCustom Get(string name, Input<string> id, DynamicSecretCustomState? state, CustomResourceOptions? opts = null)

public static DynamicSecretCustom get(String name, Output<String> id, DynamicSecretCustomState state, CustomResourceOptions options)

resources:  _:    type: akeyless:DynamicSecretCustom    get:      id: ${id}

import {
  to = akeyless_dynamicsecretcustom.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:

AdminRotationIntervalDays double: Define rotation interval in days
CreateSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretCustomId string: The ID of this resource.
EnableAdminRotation bool: Should admin credentials be rotated
EncryptionKeyName string: Dynamic producer encryption key
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
Payload string: Secret payload to be sent with each create/revoke webhook request
RevokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
RotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
Tags List<string>: Add tags attached to this object
TimeoutSec double: Maximum allowed time in seconds for the webhook to return the results
UserTtl string: User TTL

AdminRotationIntervalDays float64: Define rotation interval in days
CreateSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretCustomId string: The ID of this resource.
EnableAdminRotation bool: Should admin credentials be rotated
EncryptionKeyName string: Dynamic producer encryption key
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
Payload string: Secret payload to be sent with each create/revoke webhook request
RevokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
RotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
Tags []string: Add tags attached to this object
TimeoutSec float64: Maximum allowed time in seconds for the webhook to return the results
UserTtl string: User TTL

admin_rotation_interval_days number: Define rotation interval in days
create_sync_url string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamic_secret_custom_id string: The ID of this resource.
enable_admin_rotation bool: Should admin credentials be rotated
encryption_key_name string: Dynamic producer encryption key
item_custom_fields map(string): Additional custom fields to associate with the item
name string: Dynamic secret name
payload string: Secret payload to be sent with each create/revoke webhook request
revoke_sync_url string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
rotate_sync_url string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags list(string): Add tags attached to this object
timeout_sec number: Maximum allowed time in seconds for the webhook to return the results
user_ttl string: User TTL

adminRotationIntervalDays Double: Define rotation interval in days
createSyncUrl String: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretCustomId String: The ID of this resource.
enableAdminRotation Boolean: Should admin credentials be rotated
encryptionKeyName String: Dynamic producer encryption key
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
payload String: Secret payload to be sent with each create/revoke webhook request
revokeSyncUrl String: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
rotateSyncUrl String: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags List<String>: Add tags attached to this object
timeoutSec Double: Maximum allowed time in seconds for the webhook to return the results
userTtl String: User TTL

adminRotationIntervalDays number: Define rotation interval in days
createSyncUrl string: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretCustomId string: The ID of this resource.
enableAdminRotation boolean: Should admin credentials be rotated
encryptionKeyName string: Dynamic producer encryption key
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
payload string: Secret payload to be sent with each create/revoke webhook request
revokeSyncUrl string: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
rotateSyncUrl string: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags string[]: Add tags attached to this object
timeoutSec number: Maximum allowed time in seconds for the webhook to return the results
userTtl string: User TTL

admin_rotation_interval_days float: Define rotation interval in days
create_sync_url str: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_custom_id str: The ID of this resource.
enable_admin_rotation bool: Should admin credentials be rotated
encryption_key_name str: Dynamic producer encryption key
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
payload str: Secret payload to be sent with each create/revoke webhook request
revoke_sync_url str: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
rotate_sync_url str: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags Sequence[str]: Add tags attached to this object
timeout_sec float: Maximum allowed time in seconds for the webhook to return the results
user_ttl str: User TTL

adminRotationIntervalDays Number: Define rotation interval in days
createSyncUrl String: URL of an endpoint that implements /sync/create method, for example https://webhook.example.com/sync/create
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretCustomId String: The ID of this resource.
enableAdminRotation Boolean: Should admin credentials be rotated
encryptionKeyName String: Dynamic producer encryption key
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
payload String: Secret payload to be sent with each create/revoke webhook request
revokeSyncUrl String: URL of an endpoint that implements /sync/revoke method, for example https://webhook.example.com/sync/revoke
rotateSyncUrl String: URL of an endpoint that implements /sync/rotate method, for example https://webhook.example.com/sync/rotate
tags List<String>: Add tags attached to this object
timeoutSec Number: Maximum allowed time in seconds for the webhook to return the results
userTtl String: User TTL