1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayRemoteAccess
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    Remote access config

    Create GatewayRemoteAccess Resource

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

    Constructor syntax

    new GatewayRemoteAccess(name: string, args?: GatewayRemoteAccessArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayRemoteAccess(resource_name: str,
                            args: Optional[GatewayRemoteAccessArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayRemoteAccess(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            allowed_ssh_url: Optional[str] = None,
                            allowed_urls: Optional[str] = None,
                            default_session_ttl_minutes: Optional[str] = None,
                            gateway_remote_access_id: Optional[str] = None,
                            hide_session_recording: Optional[str] = None,
                            kexalgs: Optional[str] = None,
                            keyboard_layout: Optional[str] = None,
                            legacy_ssh_algorithm: Optional[str] = None,
                            rdp_target_configuration: Optional[str] = None,
                            retry: Optional[GatewayRemoteAccessRetryArgs] = None,
                            ssh_target_configuration: Optional[str] = None)
    func NewGatewayRemoteAccess(ctx *Context, name string, args *GatewayRemoteAccessArgs, opts ...ResourceOption) (*GatewayRemoteAccess, error)
    public GatewayRemoteAccess(string name, GatewayRemoteAccessArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayRemoteAccess(String name, GatewayRemoteAccessArgs args)
    public GatewayRemoteAccess(String name, GatewayRemoteAccessArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayRemoteAccess
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_gateway_remote_access" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayRemoteAccessArgs
    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 GatewayRemoteAccessArgs
    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 GatewayRemoteAccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayRemoteAccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayRemoteAccessArgs
    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 gatewayRemoteAccessResource = new Akeyless.GatewayRemoteAccess("gatewayRemoteAccessResource", new()
    {
        AllowedSshUrl = "string",
        AllowedUrls = "string",
        DefaultSessionTtlMinutes = "string",
        GatewayRemoteAccessId = "string",
        HideSessionRecording = "string",
        Kexalgs = "string",
        KeyboardLayout = "string",
        LegacySshAlgorithm = "string",
        RdpTargetConfiguration = "string",
        Retry = new Akeyless.Inputs.GatewayRemoteAccessRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        SshTargetConfiguration = "string",
    });
    
    example, err := akeyless.NewGatewayRemoteAccess(ctx, "gatewayRemoteAccessResource", &akeyless.GatewayRemoteAccessArgs{
    	AllowedSshUrl:            pulumi.String("string"),
    	AllowedUrls:              pulumi.String("string"),
    	DefaultSessionTtlMinutes: pulumi.String("string"),
    	GatewayRemoteAccessId:    pulumi.String("string"),
    	HideSessionRecording:     pulumi.String("string"),
    	Kexalgs:                  pulumi.String("string"),
    	KeyboardLayout:           pulumi.String("string"),
    	LegacySshAlgorithm:       pulumi.String("string"),
    	RdpTargetConfiguration:   pulumi.String("string"),
    	Retry: &akeyless.GatewayRemoteAccessRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	SshTargetConfiguration: pulumi.String("string"),
    })
    
    resource "akeyless_gateway_remote_access" "gatewayRemoteAccessResource" {
      lifecycle {
        create_before_destroy = true
      }
      allowed_ssh_url             = "string"
      allowed_urls                = "string"
      default_session_ttl_minutes = "string"
      gateway_remote_access_id    = "string"
      hide_session_recording      = "string"
      kexalgs                     = "string"
      keyboard_layout             = "string"
      legacy_ssh_algorithm        = "string"
      rdp_target_configuration    = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      ssh_target_configuration = "string"
    }
    
    var gatewayRemoteAccessResource = new GatewayRemoteAccess("gatewayRemoteAccessResource", GatewayRemoteAccessArgs.builder()
        .allowedSshUrl("string")
        .allowedUrls("string")
        .defaultSessionTtlMinutes("string")
        .gatewayRemoteAccessId("string")
        .hideSessionRecording("string")
        .kexalgs("string")
        .keyboardLayout("string")
        .legacySshAlgorithm("string")
        .rdpTargetConfiguration("string")
        .retry(GatewayRemoteAccessRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .sshTargetConfiguration("string")
        .build());
    
    gateway_remote_access_resource = akeyless.GatewayRemoteAccess("gatewayRemoteAccessResource",
        allowed_ssh_url="string",
        allowed_urls="string",
        default_session_ttl_minutes="string",
        gateway_remote_access_id="string",
        hide_session_recording="string",
        kexalgs="string",
        keyboard_layout="string",
        legacy_ssh_algorithm="string",
        rdp_target_configuration="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        },
        ssh_target_configuration="string")
    
    const gatewayRemoteAccessResource = new akeyless.GatewayRemoteAccess("gatewayRemoteAccessResource", {
        allowedSshUrl: "string",
        allowedUrls: "string",
        defaultSessionTtlMinutes: "string",
        gatewayRemoteAccessId: "string",
        hideSessionRecording: "string",
        kexalgs: "string",
        keyboardLayout: "string",
        legacySshAlgorithm: "string",
        rdpTargetConfiguration: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        sshTargetConfiguration: "string",
    });
    
    type: akeyless:GatewayRemoteAccess
    properties:
        allowedSshUrl: string
        allowedUrls: string
        defaultSessionTtlMinutes: string
        gatewayRemoteAccessId: string
        hideSessionRecording: string
        kexalgs: string
        keyboardLayout: string
        legacySshAlgorithm: string
        rdpTargetConfiguration: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        sshTargetConfiguration: string
    

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

    AllowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    DefaultSessionTtlMinutes string
    Default session TTL in minutes
    GatewayRemoteAccessId string
    The ID of this resource.
    HideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    Kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    KeyboardLayout string
    Enable support for additional keyboard layouts
    LegacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    RdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    Retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    AllowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    DefaultSessionTtlMinutes string
    Default session TTL in minutes
    GatewayRemoteAccessId string
    The ID of this resource.
    HideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    Kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    KeyboardLayout string
    Enable support for additional keyboard layouts
    LegacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    RdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    Retry GatewayRemoteAccessRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_ssh_url string
    Specify a valid SSH-URL to tunnel to SSH session
    allowed_urls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    default_session_ttl_minutes string
    Default session TTL in minutes
    gateway_remote_access_id string
    The ID of this resource.
    hide_session_recording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboard_layout string
    Enable support for additional keyboard layouts
    legacy_ssh_algorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdp_target_configuration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    ssh_target_configuration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl String
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes String
    Default session TTL in minutes
    gatewayRemoteAccessId String
    The ID of this resource.
    hideSessionRecording String
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs String
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout String
    Enable support for additional keyboard layouts
    legacySshAlgorithm String
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes string
    Default session TTL in minutes
    gatewayRemoteAccessId string
    The ID of this resource.
    hideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout string
    Enable support for additional keyboard layouts
    legacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_ssh_url str
    Specify a valid SSH-URL to tunnel to SSH session
    allowed_urls str
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    default_session_ttl_minutes str
    Default session TTL in minutes
    gateway_remote_access_id str
    The ID of this resource.
    hide_session_recording str
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs str
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboard_layout str
    Enable support for additional keyboard layouts
    legacy_ssh_algorithm str
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdp_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    ssh_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl String
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes String
    Default session TTL in minutes
    gatewayRemoteAccessId String
    The ID of this resource.
    hideSessionRecording String
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs String
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout String
    Enable support for additional keyboard layouts
    legacySshAlgorithm String
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email

    Outputs

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

    Get an existing GatewayRemoteAccess 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?: GatewayRemoteAccessState, opts?: CustomResourceOptions): GatewayRemoteAccess
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allowed_ssh_url: Optional[str] = None,
            allowed_urls: Optional[str] = None,
            default_session_ttl_minutes: Optional[str] = None,
            gateway_remote_access_id: Optional[str] = None,
            hide_session_recording: Optional[str] = None,
            kexalgs: Optional[str] = None,
            keyboard_layout: Optional[str] = None,
            legacy_ssh_algorithm: Optional[str] = None,
            rdp_target_configuration: Optional[str] = None,
            retry: Optional[GatewayRemoteAccessRetryArgs] = None,
            ssh_target_configuration: Optional[str] = None) -> GatewayRemoteAccess
    func GetGatewayRemoteAccess(ctx *Context, name string, id IDInput, state *GatewayRemoteAccessState, opts ...ResourceOption) (*GatewayRemoteAccess, error)
    public static GatewayRemoteAccess Get(string name, Input<string> id, GatewayRemoteAccessState? state, CustomResourceOptions? opts = null)
    public static GatewayRemoteAccess get(String name, Output<String> id, GatewayRemoteAccessState state, CustomResourceOptions options)
    resources:  existingGatewayRemoteAccess:    type: akeyless:GatewayRemoteAccess    get:      id: ${id}
    import {
      to = akeyless_gateway_remote_access.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state GatewayRemoteAccessState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GatewayRemoteAccessState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state GatewayRemoteAccessState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state GatewayRemoteAccessState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    AllowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    DefaultSessionTtlMinutes string
    Default session TTL in minutes
    GatewayRemoteAccessId string
    The ID of this resource.
    HideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    Kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    KeyboardLayout string
    Enable support for additional keyboard layouts
    LegacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    RdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    Retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    AllowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    DefaultSessionTtlMinutes string
    Default session TTL in minutes
    GatewayRemoteAccessId string
    The ID of this resource.
    HideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    Kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    KeyboardLayout string
    Enable support for additional keyboard layouts
    LegacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    RdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    Retry GatewayRemoteAccessRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_ssh_url string
    Specify a valid SSH-URL to tunnel to SSH session
    allowed_urls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    default_session_ttl_minutes string
    Default session TTL in minutes
    gateway_remote_access_id string
    The ID of this resource.
    hide_session_recording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboard_layout string
    Enable support for additional keyboard layouts
    legacy_ssh_algorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdp_target_configuration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    ssh_target_configuration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl String
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes String
    Default session TTL in minutes
    gatewayRemoteAccessId String
    The ID of this resource.
    hideSessionRecording String
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs String
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout String
    Enable support for additional keyboard layouts
    legacySshAlgorithm String
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl string
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes string
    Default session TTL in minutes
    gatewayRemoteAccessId string
    The ID of this resource.
    hideSessionRecording string
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs string
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout string
    Enable support for additional keyboard layouts
    legacySshAlgorithm string
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_ssh_url str
    Specify a valid SSH-URL to tunnel to SSH session
    allowed_urls str
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    default_session_ttl_minutes str
    Default session TTL in minutes
    gateway_remote_access_id str
    The ID of this resource.
    hide_session_recording str
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs str
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboard_layout str
    Enable support for additional keyboard layouts
    legacy_ssh_algorithm str
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdp_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry GatewayRemoteAccessRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    ssh_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedSshUrl String
    Specify a valid SSH-URL to tunnel to SSH session
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    defaultSessionTtlMinutes String
    Default session TTL in minutes
    gatewayRemoteAccessId String
    The ID of this resource.
    hideSessionRecording String
    Specifies whether to show/hide if the session is currently recorded [true/false]
    kexalgs String
    Decide which algorithm will be used as part of the SSH initial hand-shake process
    keyboardLayout String
    Enable support for additional keyboard layouts
    legacySshAlgorithm String
    Signs SSH certificates using legacy ssh-rsa-cert-01@openssh.com signing algorithm [true/false]
    rdpTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email

    Supporting Types

    GatewayRemoteAccessRetry, GatewayRemoteAccessRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial