1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. DynamicSecretRdp
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

    RDP dynamic secret resource

    Create DynamicSecretRdp Resource

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

    Constructor syntax

    new DynamicSecretRdp(name: string, args?: DynamicSecretRdpArgs, opts?: CustomResourceOptions);
    @overload
    def DynamicSecretRdp(resource_name: str,
                         args: Optional[DynamicSecretRdpArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DynamicSecretRdp(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         allow_user_extend_session: Optional[float] = None,
                         custom_username_template: Optional[str] = None,
                         delete_protection: Optional[str] = None,
                         description: Optional[str] = None,
                         dynamic_secret_rdp_id: Optional[str] = None,
                         encryption_key_name: Optional[str] = None,
                         fixed_user_claim_keyname: Optional[str] = None,
                         fixed_user_only: Optional[str] = None,
                         item_custom_fields: Optional[Mapping[str, str]] = None,
                         name: Optional[str] = None,
                         password_length: Optional[str] = None,
                         rdp_admin_name: Optional[str] = None,
                         rdp_admin_pwd: Optional[str] = None,
                         rdp_host_name: Optional[str] = None,
                         rdp_host_port: Optional[str] = None,
                         rdp_user_groups: Optional[str] = None,
                         secure_access_allow_external_user: Optional[bool] = None,
                         secure_access_certificate_issuer: Optional[str] = None,
                         secure_access_delay: Optional[float] = None,
                         secure_access_enable: Optional[str] = None,
                         secure_access_hosts: Optional[Sequence[str]] = None,
                         secure_access_rd_gateway_server: Optional[str] = None,
                         secure_access_rdp_domain: Optional[str] = None,
                         secure_access_rdp_user: Optional[str] = None,
                         secure_access_web: Optional[bool] = None,
                         tags: Optional[Sequence[str]] = None,
                         target_name: Optional[str] = None,
                         user_ttl: Optional[str] = None,
                         warn_user_before_expiration: Optional[float] = None)
    func NewDynamicSecretRdp(ctx *Context, name string, args *DynamicSecretRdpArgs, opts ...ResourceOption) (*DynamicSecretRdp, error)
    public DynamicSecretRdp(string name, DynamicSecretRdpArgs? args = null, CustomResourceOptions? opts = null)
    public DynamicSecretRdp(String name, DynamicSecretRdpArgs args)
    public DynamicSecretRdp(String name, DynamicSecretRdpArgs args, CustomResourceOptions options)
    
    type: akeyless:DynamicSecretRdp
    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 DynamicSecretRdpArgs
    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 DynamicSecretRdpArgs
    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 DynamicSecretRdpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DynamicSecretRdpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DynamicSecretRdpArgs
    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 dynamicSecretRdpResource = new Akeyless.DynamicSecretRdp("dynamicSecretRdpResource", new()
    {
        AllowUserExtendSession = 0,
        CustomUsernameTemplate = "string",
        DeleteProtection = "string",
        Description = "string",
        DynamicSecretRdpId = "string",
        EncryptionKeyName = "string",
        FixedUserClaimKeyname = "string",
        FixedUserOnly = "string",
        ItemCustomFields = 
        {
            { "string", "string" },
        },
        Name = "string",
        PasswordLength = "string",
        RdpAdminName = "string",
        RdpAdminPwd = "string",
        RdpHostName = "string",
        RdpHostPort = "string",
        RdpUserGroups = "string",
        SecureAccessAllowExternalUser = false,
        SecureAccessCertificateIssuer = "string",
        SecureAccessDelay = 0,
        SecureAccessEnable = "string",
        SecureAccessHosts = new[]
        {
            "string",
        },
        SecureAccessRdGatewayServer = "string",
        SecureAccessRdpDomain = "string",
        SecureAccessRdpUser = "string",
        SecureAccessWeb = false,
        Tags = new[]
        {
            "string",
        },
        TargetName = "string",
        UserTtl = "string",
        WarnUserBeforeExpiration = 0,
    });
    
    example, err := akeyless.NewDynamicSecretRdp(ctx, "dynamicSecretRdpResource", &akeyless.DynamicSecretRdpArgs{
    	AllowUserExtendSession: pulumi.Float64(0),
    	CustomUsernameTemplate: pulumi.String("string"),
    	DeleteProtection:       pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	DynamicSecretRdpId:     pulumi.String("string"),
    	EncryptionKeyName:      pulumi.String("string"),
    	FixedUserClaimKeyname:  pulumi.String("string"),
    	FixedUserOnly:          pulumi.String("string"),
    	ItemCustomFields: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:                          pulumi.String("string"),
    	PasswordLength:                pulumi.String("string"),
    	RdpAdminName:                  pulumi.String("string"),
    	RdpAdminPwd:                   pulumi.String("string"),
    	RdpHostName:                   pulumi.String("string"),
    	RdpHostPort:                   pulumi.String("string"),
    	RdpUserGroups:                 pulumi.String("string"),
    	SecureAccessAllowExternalUser: pulumi.Bool(false),
    	SecureAccessCertificateIssuer: pulumi.String("string"),
    	SecureAccessDelay:             pulumi.Float64(0),
    	SecureAccessEnable:            pulumi.String("string"),
    	SecureAccessHosts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SecureAccessRdGatewayServer: pulumi.String("string"),
    	SecureAccessRdpDomain:       pulumi.String("string"),
    	SecureAccessRdpUser:         pulumi.String("string"),
    	SecureAccessWeb:             pulumi.Bool(false),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TargetName:               pulumi.String("string"),
    	UserTtl:                  pulumi.String("string"),
    	WarnUserBeforeExpiration: pulumi.Float64(0),
    })
    
    var dynamicSecretRdpResource = new DynamicSecretRdp("dynamicSecretRdpResource", DynamicSecretRdpArgs.builder()
        .allowUserExtendSession(0.0)
        .customUsernameTemplate("string")
        .deleteProtection("string")
        .description("string")
        .dynamicSecretRdpId("string")
        .encryptionKeyName("string")
        .fixedUserClaimKeyname("string")
        .fixedUserOnly("string")
        .itemCustomFields(Map.of("string", "string"))
        .name("string")
        .passwordLength("string")
        .rdpAdminName("string")
        .rdpAdminPwd("string")
        .rdpHostName("string")
        .rdpHostPort("string")
        .rdpUserGroups("string")
        .secureAccessAllowExternalUser(false)
        .secureAccessCertificateIssuer("string")
        .secureAccessDelay(0.0)
        .secureAccessEnable("string")
        .secureAccessHosts("string")
        .secureAccessRdGatewayServer("string")
        .secureAccessRdpDomain("string")
        .secureAccessRdpUser("string")
        .secureAccessWeb(false)
        .tags("string")
        .targetName("string")
        .userTtl("string")
        .warnUserBeforeExpiration(0.0)
        .build());
    
    dynamic_secret_rdp_resource = akeyless.DynamicSecretRdp("dynamicSecretRdpResource",
        allow_user_extend_session=float(0),
        custom_username_template="string",
        delete_protection="string",
        description="string",
        dynamic_secret_rdp_id="string",
        encryption_key_name="string",
        fixed_user_claim_keyname="string",
        fixed_user_only="string",
        item_custom_fields={
            "string": "string",
        },
        name="string",
        password_length="string",
        rdp_admin_name="string",
        rdp_admin_pwd="string",
        rdp_host_name="string",
        rdp_host_port="string",
        rdp_user_groups="string",
        secure_access_allow_external_user=False,
        secure_access_certificate_issuer="string",
        secure_access_delay=float(0),
        secure_access_enable="string",
        secure_access_hosts=["string"],
        secure_access_rd_gateway_server="string",
        secure_access_rdp_domain="string",
        secure_access_rdp_user="string",
        secure_access_web=False,
        tags=["string"],
        target_name="string",
        user_ttl="string",
        warn_user_before_expiration=float(0))
    
    const dynamicSecretRdpResource = new akeyless.DynamicSecretRdp("dynamicSecretRdpResource", {
        allowUserExtendSession: 0,
        customUsernameTemplate: "string",
        deleteProtection: "string",
        description: "string",
        dynamicSecretRdpId: "string",
        encryptionKeyName: "string",
        fixedUserClaimKeyname: "string",
        fixedUserOnly: "string",
        itemCustomFields: {
            string: "string",
        },
        name: "string",
        passwordLength: "string",
        rdpAdminName: "string",
        rdpAdminPwd: "string",
        rdpHostName: "string",
        rdpHostPort: "string",
        rdpUserGroups: "string",
        secureAccessAllowExternalUser: false,
        secureAccessCertificateIssuer: "string",
        secureAccessDelay: 0,
        secureAccessEnable: "string",
        secureAccessHosts: ["string"],
        secureAccessRdGatewayServer: "string",
        secureAccessRdpDomain: "string",
        secureAccessRdpUser: "string",
        secureAccessWeb: false,
        tags: ["string"],
        targetName: "string",
        userTtl: "string",
        warnUserBeforeExpiration: 0,
    });
    
    type: akeyless:DynamicSecretRdp
    properties:
        allowUserExtendSession: 0
        customUsernameTemplate: string
        deleteProtection: string
        description: string
        dynamicSecretRdpId: string
        encryptionKeyName: string
        fixedUserClaimKeyname: string
        fixedUserOnly: string
        itemCustomFields:
            string: string
        name: string
        passwordLength: string
        rdpAdminName: string
        rdpAdminPwd: string
        rdpHostName: string
        rdpHostPort: string
        rdpUserGroups: string
        secureAccessAllowExternalUser: false
        secureAccessCertificateIssuer: string
        secureAccessDelay: 0
        secureAccessEnable: string
        secureAccessHosts:
            - string
        secureAccessRdGatewayServer: string
        secureAccessRdpDomain: string
        secureAccessRdpUser: string
        secureAccessWeb: false
        tags:
            - string
        targetName: string
        userTtl: string
        warnUserBeforeExpiration: 0
    

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

    AllowUserExtendSession double
    Allow user to extend session
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretRdpId string
    The ID of this resource.
    EncryptionKeyName string
    Dynamic producer encryption key
    FixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    FixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    RdpAdminName string
    RDP Admin Name
    RdpAdminPwd string
    RDP Admin password
    RdpHostName string
    Hostname
    RdpHostPort string
    Port
    RdpUserGroups string
    Groups
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDelay double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts List<string>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdGatewayServer string
    RD Gateway server
    SecureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    Target name
    UserTtl string
    User TTL
    WarnUserBeforeExpiration double
    Warn user before expiration in minutes
    AllowUserExtendSession float64
    Allow user to extend session
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretRdpId string
    The ID of this resource.
    EncryptionKeyName string
    Dynamic producer encryption key
    FixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    FixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    RdpAdminName string
    RDP Admin Name
    RdpAdminPwd string
    RDP Admin password
    RdpHostName string
    Hostname
    RdpHostPort string
    Port
    RdpUserGroups string
    Groups
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDelay float64
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts []string
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdGatewayServer string
    RD Gateway server
    SecureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    Target name
    UserTtl string
    User TTL
    WarnUserBeforeExpiration float64
    Warn user before expiration in minutes
    allowUserExtendSession Double
    Allow user to extend session
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretRdpId String
    The ID of this resource.
    encryptionKeyName String
    Dynamic producer encryption key
    fixedUserClaimKeyname String
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly String
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    rdpAdminName String
    RDP Admin Name
    rdpAdminPwd String
    RDP Admin password
    rdpHostName String
    Hostname
    rdpHostPort String
    Port
    rdpUserGroups String
    Groups
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay Double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer String
    RD Gateway server
    secureAccessRdpDomain String
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    Target name
    userTtl String
    User TTL
    warnUserBeforeExpiration Double
    Warn user before expiration in minutes
    allowUserExtendSession number
    Allow user to extend session
    customUsernameTemplate string
    Customize how temporary usernames are generated using go template
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dynamicSecretRdpId string
    The ID of this resource.
    encryptionKeyName string
    Dynamic producer encryption key
    fixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    name string
    Dynamic secret name
    passwordLength string
    The length of the password to be generated
    rdpAdminName string
    RDP Admin Name
    rdpAdminPwd string
    RDP Admin password
    rdpHostName string
    Hostname
    rdpHostPort string
    Port
    rdpUserGroups string
    Groups
    secureAccessAllowExternalUser boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts string[]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer string
    RD Gateway server
    secureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser string
    Override the RDP Domain username
    secureAccessWeb boolean
    Enable Web Secure Remote Access
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName string
    Target name
    userTtl string
    User TTL
    warnUserBeforeExpiration number
    Warn user before expiration in minutes
    allow_user_extend_session float
    Allow user to extend session
    custom_username_template str
    Customize how temporary usernames are generated using go template
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    dynamic_secret_rdp_id str
    The ID of this resource.
    encryption_key_name str
    Dynamic producer encryption key
    fixed_user_claim_keyname str
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixed_user_only str
    Allow access using externally (IdP) provided username [true/false]
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    name str
    Dynamic secret name
    password_length str
    The length of the password to be generated
    rdp_admin_name str
    RDP Admin Name
    rdp_admin_pwd str
    RDP Admin password
    rdp_host_name str
    Hostname
    rdp_host_port str
    Port
    rdp_user_groups str
    Groups
    secure_access_allow_external_user bool
    Allow providing external user for a domain users
    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_delay float
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secure_access_enable str
    Enable/Disable secure remote access, [true/false]
    secure_access_hosts Sequence[str]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secure_access_rd_gateway_server str
    RD Gateway server
    secure_access_rdp_domain str
    Required when the Dynamic Secret is used for a domain user
    secure_access_rdp_user str
    Override the RDP Domain username
    secure_access_web bool
    Enable Web Secure Remote Access
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    target_name str
    Target name
    user_ttl str
    User TTL
    warn_user_before_expiration float
    Warn user before expiration in minutes
    allowUserExtendSession Number
    Allow user to extend session
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretRdpId String
    The ID of this resource.
    encryptionKeyName String
    Dynamic producer encryption key
    fixedUserClaimKeyname String
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly String
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    rdpAdminName String
    RDP Admin Name
    rdpAdminPwd String
    RDP Admin password
    rdpHostName String
    Hostname
    rdpHostPort String
    Port
    rdpUserGroups String
    Groups
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay Number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer String
    RD Gateway server
    secureAccessRdpDomain String
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    Target name
    userTtl String
    User TTL
    warnUserBeforeExpiration Number
    Warn user before expiration in minutes

    Outputs

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

    Get an existing DynamicSecretRdp 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?: DynamicSecretRdpState, opts?: CustomResourceOptions): DynamicSecretRdp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_user_extend_session: Optional[float] = None,
            custom_username_template: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            dynamic_secret_rdp_id: Optional[str] = None,
            encryption_key_name: Optional[str] = None,
            fixed_user_claim_keyname: Optional[str] = None,
            fixed_user_only: Optional[str] = None,
            item_custom_fields: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            password_length: Optional[str] = None,
            rdp_admin_name: Optional[str] = None,
            rdp_admin_pwd: Optional[str] = None,
            rdp_host_name: Optional[str] = None,
            rdp_host_port: Optional[str] = None,
            rdp_user_groups: Optional[str] = None,
            secure_access_allow_external_user: Optional[bool] = None,
            secure_access_certificate_issuer: Optional[str] = None,
            secure_access_delay: Optional[float] = None,
            secure_access_enable: Optional[str] = None,
            secure_access_hosts: Optional[Sequence[str]] = None,
            secure_access_rd_gateway_server: Optional[str] = None,
            secure_access_rdp_domain: Optional[str] = None,
            secure_access_rdp_user: Optional[str] = None,
            secure_access_web: Optional[bool] = None,
            tags: Optional[Sequence[str]] = None,
            target_name: Optional[str] = None,
            user_ttl: Optional[str] = None,
            warn_user_before_expiration: Optional[float] = None) -> DynamicSecretRdp
    func GetDynamicSecretRdp(ctx *Context, name string, id IDInput, state *DynamicSecretRdpState, opts ...ResourceOption) (*DynamicSecretRdp, error)
    public static DynamicSecretRdp Get(string name, Input<string> id, DynamicSecretRdpState? state, CustomResourceOptions? opts = null)
    public static DynamicSecretRdp get(String name, Output<String> id, DynamicSecretRdpState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:DynamicSecretRdp    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:
    AllowUserExtendSession double
    Allow user to extend session
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretRdpId string
    The ID of this resource.
    EncryptionKeyName string
    Dynamic producer encryption key
    FixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    FixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    RdpAdminName string
    RDP Admin Name
    RdpAdminPwd string
    RDP Admin password
    RdpHostName string
    Hostname
    RdpHostPort string
    Port
    RdpUserGroups string
    Groups
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDelay double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts List<string>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdGatewayServer string
    RD Gateway server
    SecureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    Target name
    UserTtl string
    User TTL
    WarnUserBeforeExpiration double
    Warn user before expiration in minutes
    AllowUserExtendSession float64
    Allow user to extend session
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretRdpId string
    The ID of this resource.
    EncryptionKeyName string
    Dynamic producer encryption key
    FixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    FixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    RdpAdminName string
    RDP Admin Name
    RdpAdminPwd string
    RDP Admin password
    RdpHostName string
    Hostname
    RdpHostPort string
    Port
    RdpUserGroups string
    Groups
    SecureAccessAllowExternalUser bool
    Allow providing external user for a domain users
    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDelay float64
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts []string
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    SecureAccessRdGatewayServer string
    RD Gateway server
    SecureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    SecureAccessRdpUser string
    Override the RDP Domain username
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    Target name
    UserTtl string
    User TTL
    WarnUserBeforeExpiration float64
    Warn user before expiration in minutes
    allowUserExtendSession Double
    Allow user to extend session
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretRdpId String
    The ID of this resource.
    encryptionKeyName String
    Dynamic producer encryption key
    fixedUserClaimKeyname String
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly String
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    rdpAdminName String
    RDP Admin Name
    rdpAdminPwd String
    RDP Admin password
    rdpHostName String
    Hostname
    rdpHostPort String
    Port
    rdpUserGroups String
    Groups
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay Double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer String
    RD Gateway server
    secureAccessRdpDomain String
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    Target name
    userTtl String
    User TTL
    warnUserBeforeExpiration Double
    Warn user before expiration in minutes
    allowUserExtendSession number
    Allow user to extend session
    customUsernameTemplate string
    Customize how temporary usernames are generated using go template
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dynamicSecretRdpId string
    The ID of this resource.
    encryptionKeyName string
    Dynamic producer encryption key
    fixedUserClaimKeyname string
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly string
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    name string
    Dynamic secret name
    passwordLength string
    The length of the password to be generated
    rdpAdminName string
    RDP Admin Name
    rdpAdminPwd string
    RDP Admin password
    rdpHostName string
    Hostname
    rdpHostPort string
    Port
    rdpUserGroups string
    Groups
    secureAccessAllowExternalUser boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts string[]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer string
    RD Gateway server
    secureAccessRdpDomain string
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser string
    Override the RDP Domain username
    secureAccessWeb boolean
    Enable Web Secure Remote Access
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName string
    Target name
    userTtl string
    User TTL
    warnUserBeforeExpiration number
    Warn user before expiration in minutes
    allow_user_extend_session float
    Allow user to extend session
    custom_username_template str
    Customize how temporary usernames are generated using go template
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    dynamic_secret_rdp_id str
    The ID of this resource.
    encryption_key_name str
    Dynamic producer encryption key
    fixed_user_claim_keyname str
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixed_user_only str
    Allow access using externally (IdP) provided username [true/false]
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    name str
    Dynamic secret name
    password_length str
    The length of the password to be generated
    rdp_admin_name str
    RDP Admin Name
    rdp_admin_pwd str
    RDP Admin password
    rdp_host_name str
    Hostname
    rdp_host_port str
    Port
    rdp_user_groups str
    Groups
    secure_access_allow_external_user bool
    Allow providing external user for a domain users
    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_delay float
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secure_access_enable str
    Enable/Disable secure remote access, [true/false]
    secure_access_hosts Sequence[str]
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secure_access_rd_gateway_server str
    RD Gateway server
    secure_access_rdp_domain str
    Required when the Dynamic Secret is used for a domain user
    secure_access_rdp_user str
    Override the RDP Domain username
    secure_access_web bool
    Enable Web Secure Remote Access
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    target_name str
    Target name
    user_ttl str
    User TTL
    warn_user_before_expiration float
    Warn user before expiration in minutes
    allowUserExtendSession Number
    Allow user to extend session
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretRdpId String
    The ID of this resource.
    encryptionKeyName String
    Dynamic producer encryption key
    fixedUserClaimKeyname String
    For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for fixed-user-only=true)
    fixedUserOnly String
    Allow access using externally (IdP) provided username [true/false]
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    rdpAdminName String
    RDP Admin Name
    rdpAdminPwd String
    RDP Admin password
    rdpHostName String
    Hostname
    rdpHostPort String
    Port
    rdpUserGroups String
    Groups
    secureAccessAllowExternalUser Boolean
    Allow providing external user for a domain users
    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDelay Number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
    secureAccessRdGatewayServer String
    RD Gateway server
    secureAccessRdpDomain String
    Required when the Dynamic Secret is used for a domain user
    secureAccessRdpUser String
    Override the RDP Domain username
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    Target name
    userTtl String
    User TTL
    warnUserBeforeExpiration Number
    Warn user before expiration in minutes

    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.1
    published on Monday, Apr 27, 2026 by akeyless-community
      Try Pulumi Cloud free. Your team will thank you.