published on Thursday, Nov 19, 2026 by akeyless-community
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:
- Desktop
App stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- Desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- Desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- Gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- Retry
Gateway
Remote Access Desktop App Retry - 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 stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- Desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- Desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- Gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- Retry
Gateway
Remote Access Desktop App Retry Args - 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_ stringsecure_ web_ access_ url - Specify the Web Access URL to be used by the Desktop Application
- desktop_
app_ stringsecure_ web_ proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop_
app_ stringssh_ cert_ issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway_
remote_ stringaccess_ desktop_ app_ id - 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.
- desktop
App StringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App StringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App StringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote StringAccess Desktop App Id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry - 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 stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry - 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_ strsecure_ web_ access_ url - Specify the Web Access URL to be used by the Desktop Application
- desktop_
app_ strsecure_ web_ proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop_
app_ strssh_ cert_ issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway_
remote_ straccess_ desktop_ app_ id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry Args - 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 StringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App StringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App StringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote StringAccess Desktop App Id - 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) -> GatewayRemoteAccessDesktopAppfunc 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.
- Desktop
App stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- Desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- Desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- Gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- Retry
Gateway
Remote Access Desktop App Retry - 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 stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- Desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- Desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- Gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- Retry
Gateway
Remote Access Desktop App Retry Args - 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_ stringsecure_ web_ access_ url - Specify the Web Access URL to be used by the Desktop Application
- desktop_
app_ stringsecure_ web_ proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop_
app_ stringssh_ cert_ issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway_
remote_ stringaccess_ desktop_ app_ id - 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.
- desktop
App StringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App StringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App StringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote StringAccess Desktop App Id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry - 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 stringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App stringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App stringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote stringAccess Desktop App Id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry - 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_ strsecure_ web_ access_ url - Specify the Web Access URL to be used by the Desktop Application
- desktop_
app_ strsecure_ web_ proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop_
app_ strssh_ cert_ issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway_
remote_ straccess_ desktop_ app_ id - The ID of this resource.
- retry
Gateway
Remote Access Desktop App Retry Args - 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 StringSecure Web Access Url - Specify the Web Access URL to be used by the Desktop Application
- desktop
App StringSecure Web Proxy - Specify the URL for secure web proxy to be used by the Desktop Application
- desktop
App StringSsh Cert Issuer - Specify the default SSH-CERT-ISSUER that will be used as a fallback for Desktop Application
- gateway
Remote StringAccess Desktop App Id - 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
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - 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_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - 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 numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - 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_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - 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 NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - 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
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community