1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayRemoteAccessDesktopApp
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 desktop app config

    Create GatewayRemoteAccessDesktopApp Resource

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

    Constructor syntax

    new GatewayRemoteAccessDesktopApp(name: string, args?: GatewayRemoteAccessDesktopAppArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayRemoteAccessDesktopApp(resource_name: str,
                                      args: Optional[GatewayRemoteAccessDesktopAppArgs] = None,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayRemoteAccessDesktopApp(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      desktop_app_secure_web_access_url: Optional[str] = None,
                                      desktop_app_secure_web_proxy: Optional[str] = None,
                                      desktop_app_ssh_cert_issuer: Optional[str] = None,
                                      gateway_remote_access_desktop_app_id: Optional[str] = None,
                                      retry: Optional[GatewayRemoteAccessDesktopAppRetryArgs] = None)
    func NewGatewayRemoteAccessDesktopApp(ctx *Context, name string, args *GatewayRemoteAccessDesktopAppArgs, opts ...ResourceOption) (*GatewayRemoteAccessDesktopApp, error)
    public GatewayRemoteAccessDesktopApp(string name, GatewayRemoteAccessDesktopAppArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayRemoteAccessDesktopApp(String name, GatewayRemoteAccessDesktopAppArgs args)
    public GatewayRemoteAccessDesktopApp(String name, GatewayRemoteAccessDesktopAppArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayRemoteAccessDesktopApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_gateway_remote_access_desktop_app" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayRemoteAccessDesktopAppArgs
    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 GatewayRemoteAccessDesktopAppArgs
    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 GatewayRemoteAccessDesktopAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayRemoteAccessDesktopAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayRemoteAccessDesktopAppArgs
    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 gatewayRemoteAccessDesktopAppResource = new Akeyless.GatewayRemoteAccessDesktopApp("gatewayRemoteAccessDesktopAppResource", new()
    {
        DesktopAppSecureWebAccessUrl = "string",
        DesktopAppSecureWebProxy = "string",
        DesktopAppSshCertIssuer = "string",
        GatewayRemoteAccessDesktopAppId = "string",
        Retry = new Akeyless.Inputs.GatewayRemoteAccessDesktopAppRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
    });
    
    example, err := akeyless.NewGatewayRemoteAccessDesktopApp(ctx, "gatewayRemoteAccessDesktopAppResource", &akeyless.GatewayRemoteAccessDesktopAppArgs{
    	DesktopAppSecureWebAccessUrl:    pulumi.String("string"),
    	DesktopAppSecureWebProxy:        pulumi.String("string"),
    	DesktopAppSshCertIssuer:         pulumi.String("string"),
    	GatewayRemoteAccessDesktopAppId: pulumi.String("string"),
    	Retry: &akeyless.GatewayRemoteAccessDesktopAppRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    })
    
    resource "akeyless_gateway_remote_access_desktop_app" "gatewayRemoteAccessDesktopAppResource" {
      lifecycle {
        create_before_destroy = true
      }
      desktop_app_secure_web_access_url    = "string"
      desktop_app_secure_web_proxy         = "string"
      desktop_app_ssh_cert_issuer          = "string"
      gateway_remote_access_desktop_app_id = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
    }
    
    var gatewayRemoteAccessDesktopAppResource = new GatewayRemoteAccessDesktopApp("gatewayRemoteAccessDesktopAppResource", GatewayRemoteAccessDesktopAppArgs.builder()
        .desktopAppSecureWebAccessUrl("string")
        .desktopAppSecureWebProxy("string")
        .desktopAppSshCertIssuer("string")
        .gatewayRemoteAccessDesktopAppId("string")
        .retry(GatewayRemoteAccessDesktopAppRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .build());
    
    gateway_remote_access_desktop_app_resource = akeyless.GatewayRemoteAccessDesktopApp("gatewayRemoteAccessDesktopAppResource",
        desktop_app_secure_web_access_url="string",
        desktop_app_secure_web_proxy="string",
        desktop_app_ssh_cert_issuer="string",
        gateway_remote_access_desktop_app_id="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)],
        })
    
    const gatewayRemoteAccessDesktopAppResource = new akeyless.GatewayRemoteAccessDesktopApp("gatewayRemoteAccessDesktopAppResource", {
        desktopAppSecureWebAccessUrl: "string",
        desktopAppSecureWebProxy: "string",
        desktopAppSshCertIssuer: "string",
        gatewayRemoteAccessDesktopAppId: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
    });
    
    type: akeyless:GatewayRemoteAccessDesktopApp
    properties:
        desktopAppSecureWebAccessUrl: string
        desktopAppSecureWebProxy: string
        desktopAppSshCertIssuer: string
        gatewayRemoteAccessDesktopAppId: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
    

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

    DesktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    DesktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    DesktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    GatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    Retry GatewayRemoteAccessDesktopAppRetry
    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.
    DesktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    DesktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    DesktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    GatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    Retry GatewayRemoteAccessDesktopAppRetryArgs
    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.
    desktop_app_secure_web_access_url string
    Specify the Web Access URL to be used by the Desktop Application
    desktop_app_secure_web_proxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktop_app_ssh_cert_issuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gateway_remote_access_desktop_app_id string
    The ID of this resource.
    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.
    desktopAppSecureWebAccessUrl String
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy String
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer String
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId String
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetry
    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.
    desktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetry
    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.
    desktop_app_secure_web_access_url str
    Specify the Web Access URL to be used by the Desktop Application
    desktop_app_secure_web_proxy str
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktop_app_ssh_cert_issuer str
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gateway_remote_access_desktop_app_id str
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetryArgs
    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.
    desktopAppSecureWebAccessUrl String
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy String
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer String
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId String
    The ID of this resource.
    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.

    Outputs

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

    Get an existing GatewayRemoteAccessDesktopApp 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?: GatewayRemoteAccessDesktopAppState, opts?: CustomResourceOptions): GatewayRemoteAccessDesktopApp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            desktop_app_secure_web_access_url: Optional[str] = None,
            desktop_app_secure_web_proxy: Optional[str] = None,
            desktop_app_ssh_cert_issuer: Optional[str] = None,
            gateway_remote_access_desktop_app_id: Optional[str] = None,
            retry: Optional[GatewayRemoteAccessDesktopAppRetryArgs] = None) -> GatewayRemoteAccessDesktopApp
    func GetGatewayRemoteAccessDesktopApp(ctx *Context, name string, id IDInput, state *GatewayRemoteAccessDesktopAppState, opts ...ResourceOption) (*GatewayRemoteAccessDesktopApp, error)
    public static GatewayRemoteAccessDesktopApp Get(string name, Input<string> id, GatewayRemoteAccessDesktopAppState? state, CustomResourceOptions? opts = null)
    public static GatewayRemoteAccessDesktopApp get(String name, Output<String> id, GatewayRemoteAccessDesktopAppState state, CustomResourceOptions options)
    resources:  existingGatewayRemoteAccessDesktopApp:    type: akeyless:GatewayRemoteAccessDesktopApp    get:      id: ${id}
    import {
      to = akeyless_gateway_remote_access_desktop_app.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 GatewayRemoteAccessDesktopAppState
    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 GatewayRemoteAccessDesktopAppState
    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 GatewayRemoteAccessDesktopAppState
    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 GatewayRemoteAccessDesktopAppState
    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:
    DesktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    DesktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    DesktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    GatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    Retry GatewayRemoteAccessDesktopAppRetry
    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.
    DesktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    DesktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    DesktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    GatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    Retry GatewayRemoteAccessDesktopAppRetryArgs
    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.
    desktop_app_secure_web_access_url string
    Specify the Web Access URL to be used by the Desktop Application
    desktop_app_secure_web_proxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktop_app_ssh_cert_issuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gateway_remote_access_desktop_app_id string
    The ID of this resource.
    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.
    desktopAppSecureWebAccessUrl String
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy String
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer String
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId String
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetry
    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.
    desktopAppSecureWebAccessUrl string
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy string
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer string
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId string
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetry
    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.
    desktop_app_secure_web_access_url str
    Specify the Web Access URL to be used by the Desktop Application
    desktop_app_secure_web_proxy str
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktop_app_ssh_cert_issuer str
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gateway_remote_access_desktop_app_id str
    The ID of this resource.
    retry GatewayRemoteAccessDesktopAppRetryArgs
    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.
    desktopAppSecureWebAccessUrl String
    Specify the Web Access URL to be used by the Desktop Application
    desktopAppSecureWebProxy String
    Specify the URL for secure web proxy to be used by the Desktop Application
    desktopAppSshCertIssuer String
    Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
    gatewayRemoteAccessDesktopAppId String
    The ID of this resource.
    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.

    Supporting Types

    GatewayRemoteAccessDesktopAppRetry, GatewayRemoteAccessDesktopAppRetryArgs

    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