1. Packages
  2. Akeyless Provider
  3. API Docs
  4. DynamicSecretCustom
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.DynamicSecretCustom

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Custom dynamic secret resource

    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,
                            create_sync_url: Optional[str] = None,
                            revoke_sync_url: Optional[str] = None,
                            admin_rotation_interval_days: Optional[float] = None,
                            dynamic_secret_custom_id: Optional[str] = None,
                            enable_admin_rotation: Optional[bool] = None,
                            encryption_key_name: Optional[str] = None,
                            name: Optional[str] = None,
                            payload: 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.
    
    

    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()
    {
        CreateSyncUrl = "string",
        RevokeSyncUrl = "string",
        AdminRotationIntervalDays = 0,
        DynamicSecretCustomId = "string",
        EnableAdminRotation = false,
        EncryptionKeyName = "string",
        Name = "string",
        Payload = "string",
        RotateSyncUrl = "string",
        Tags = new[]
        {
            "string",
        },
        TimeoutSec = 0,
        UserTtl = "string",
    });
    
    example, err := akeyless.NewDynamicSecretCustom(ctx, "dynamicSecretCustomResource", &akeyless.DynamicSecretCustomArgs{
    	CreateSyncUrl:             pulumi.String("string"),
    	RevokeSyncUrl:             pulumi.String("string"),
    	AdminRotationIntervalDays: pulumi.Float64(0),
    	DynamicSecretCustomId:     pulumi.String("string"),
    	EnableAdminRotation:       pulumi.Bool(false),
    	EncryptionKeyName:         pulumi.String("string"),
    	Name:                      pulumi.String("string"),
    	Payload:                   pulumi.String("string"),
    	RotateSyncUrl:             pulumi.String("string"),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TimeoutSec: pulumi.Float64(0),
    	UserTtl:    pulumi.String("string"),
    })
    
    var dynamicSecretCustomResource = new DynamicSecretCustom("dynamicSecretCustomResource", DynamicSecretCustomArgs.builder()
        .createSyncUrl("string")
        .revokeSyncUrl("string")
        .adminRotationIntervalDays(0)
        .dynamicSecretCustomId("string")
        .enableAdminRotation(false)
        .encryptionKeyName("string")
        .name("string")
        .payload("string")
        .rotateSyncUrl("string")
        .tags("string")
        .timeoutSec(0)
        .userTtl("string")
        .build());
    
    dynamic_secret_custom_resource = akeyless.DynamicSecretCustom("dynamicSecretCustomResource",
        create_sync_url="string",
        revoke_sync_url="string",
        admin_rotation_interval_days=0,
        dynamic_secret_custom_id="string",
        enable_admin_rotation=False,
        encryption_key_name="string",
        name="string",
        payload="string",
        rotate_sync_url="string",
        tags=["string"],
        timeout_sec=0,
        user_ttl="string")
    
    const dynamicSecretCustomResource = new akeyless.DynamicSecretCustom("dynamicSecretCustomResource", {
        createSyncUrl: "string",
        revokeSyncUrl: "string",
        adminRotationIntervalDays: 0,
        dynamicSecretCustomId: "string",
        enableAdminRotation: false,
        encryptionKeyName: "string",
        name: "string",
        payload: "string",
        rotateSyncUrl: "string",
        tags: ["string"],
        timeoutSec: 0,
        userTtl: "string",
    });
    
    type: akeyless:DynamicSecretCustom
    properties:
        adminRotationIntervalDays: 0
        createSyncUrl: string
        dynamicSecretCustomId: string
        enableAdminRotation: false
        encryptionKeyName: 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
    RevokeSyncUrl string
    URL of an endpoint that implements /sync/revoke method
    AdminRotationIntervalDays double
    Rotation period in days
    DynamicSecretCustomId string
    The ID of this resource.
    EnableAdminRotation bool
    Enable automatic admin credentials rotation
    EncryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    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
    RevokeSyncUrl string
    URL of an endpoint that implements /sync/revoke method
    AdminRotationIntervalDays float64
    Rotation period in days
    DynamicSecretCustomId string
    The ID of this resource.
    EnableAdminRotation bool
    Enable automatic admin credentials rotation
    EncryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TimeoutSec float64
    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
    revokeSyncUrl String
    URL of an endpoint that implements /sync/revoke method
    adminRotationIntervalDays Double
    Rotation period in days
    dynamicSecretCustomId String
    The ID of this resource.
    enableAdminRotation Boolean
    Enable automatic admin credentials rotation
    encryptionKeyName String
    Encrypt dynamic secret details with following key
    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
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    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
    revokeSyncUrl string
    URL of an endpoint that implements /sync/revoke method
    adminRotationIntervalDays number
    Rotation period in days
    dynamicSecretCustomId string
    The ID of this resource.
    enableAdminRotation boolean
    Enable automatic admin credentials rotation
    encryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    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
    revoke_sync_url str
    URL of an endpoint that implements /sync/revoke method
    admin_rotation_interval_days float
    Rotation period in days
    dynamic_secret_custom_id str
    The ID of this resource.
    enable_admin_rotation bool
    Enable automatic admin credentials rotation
    encryption_key_name str
    Encrypt dynamic secret details with following key
    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
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    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
    revokeSyncUrl String
    URL of an endpoint that implements /sync/revoke method
    adminRotationIntervalDays Number
    Rotation period in days
    dynamicSecretCustomId String
    The ID of this resource.
    enableAdminRotation Boolean
    Enable automatic admin credentials rotation
    encryptionKeyName String
    Encrypt dynamic secret details with following key
    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
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    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 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,
            dynamic_secret_custom_id: Optional[str] = None,
            enable_admin_rotation: Optional[bool] = None,
            encryption_key_name: Optional[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}
    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
    Rotation period in days
    CreateSyncUrl string
    URL of an endpoint that implements /sync/create method
    DynamicSecretCustomId string
    The ID of this resource.
    EnableAdminRotation bool
    Enable automatic admin credentials rotation
    EncryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    RotateSyncUrl string
    URL of an endpoint that implements /sync/rotate method
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TimeoutSec double
    Maximum allowed time in seconds for the webhook to return the results
    UserTtl string
    User TTL
    AdminRotationIntervalDays float64
    Rotation period in days
    CreateSyncUrl string
    URL of an endpoint that implements /sync/create method
    DynamicSecretCustomId string
    The ID of this resource.
    EnableAdminRotation bool
    Enable automatic admin credentials rotation
    EncryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    RotateSyncUrl string
    URL of an endpoint that implements /sync/rotate method
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TimeoutSec float64
    Maximum allowed time in seconds for the webhook to return the results
    UserTtl string
    User TTL
    adminRotationIntervalDays Double
    Rotation period in days
    createSyncUrl String
    URL of an endpoint that implements /sync/create method
    dynamicSecretCustomId String
    The ID of this resource.
    enableAdminRotation Boolean
    Enable automatic admin credentials rotation
    encryptionKeyName String
    Encrypt dynamic secret details with following key
    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
    rotateSyncUrl String
    URL of an endpoint that implements /sync/rotate method
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    timeoutSec Double
    Maximum allowed time in seconds for the webhook to return the results
    userTtl String
    User TTL
    adminRotationIntervalDays number
    Rotation period in days
    createSyncUrl string
    URL of an endpoint that implements /sync/create method
    dynamicSecretCustomId string
    The ID of this resource.
    enableAdminRotation boolean
    Enable automatic admin credentials rotation
    encryptionKeyName string
    Encrypt dynamic secret details with following key
    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
    rotateSyncUrl string
    URL of an endpoint that implements /sync/rotate method
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    timeoutSec number
    Maximum allowed time in seconds for the webhook to return the results
    userTtl string
    User TTL
    admin_rotation_interval_days float
    Rotation period in days
    create_sync_url str
    URL of an endpoint that implements /sync/create method
    dynamic_secret_custom_id str
    The ID of this resource.
    enable_admin_rotation bool
    Enable automatic admin credentials rotation
    encryption_key_name str
    Encrypt dynamic secret details with following key
    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
    rotate_sync_url str
    URL of an endpoint that implements /sync/rotate method
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    timeout_sec float
    Maximum allowed time in seconds for the webhook to return the results
    user_ttl str
    User TTL
    adminRotationIntervalDays Number
    Rotation period in days
    createSyncUrl String
    URL of an endpoint that implements /sync/create method
    dynamicSecretCustomId String
    The ID of this resource.
    enableAdminRotation Boolean
    Enable automatic admin credentials rotation
    encryptionKeyName String
    Encrypt dynamic secret details with following key
    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
    rotateSyncUrl String
    URL of an endpoint that implements /sync/rotate method
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    timeoutSec Number
    Maximum allowed time in seconds for the webhook to return the results
    userTtl String
    User TTL

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community