Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. GatewayRemoteAccess
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.GatewayRemoteAccess

Explore with Pulumi AI

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

    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_urls: 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,
                        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.

    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()
{
    AllowedUrls = "string",
    GatewayRemoteAccessId = "string",
    HideSessionRecording = "string",
    Kexalgs = "string",
    KeyboardLayout = "string",
    LegacySshAlgorithm = "string",
    RdpTargetConfiguration = "string",
    SshTargetConfiguration = "string",
});

    example, err := akeyless.NewGatewayRemoteAccess(ctx, "gatewayRemoteAccessResource", &akeyless.GatewayRemoteAccessArgs{
	AllowedUrls:            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"),
	SshTargetConfiguration: pulumi.String("string"),
})

    var gatewayRemoteAccessResource = new GatewayRemoteAccess("gatewayRemoteAccessResource", GatewayRemoteAccessArgs.builder()
    .allowedUrls("string")
    .gatewayRemoteAccessId("string")
    .hideSessionRecording("string")
    .kexalgs("string")
    .keyboardLayout("string")
    .legacySshAlgorithm("string")
    .rdpTargetConfiguration("string")
    .sshTargetConfiguration("string")
    .build());

    gateway_remote_access_resource = akeyless.GatewayRemoteAccess("gatewayRemoteAccessResource",
    allowed_urls="string",
    gateway_remote_access_id="string",
    hide_session_recording="string",
    kexalgs="string",
    keyboard_layout="string",
    legacy_ssh_algorithm="string",
    rdp_target_configuration="string",
    ssh_target_configuration="string")

    const gatewayRemoteAccessResource = new akeyless.GatewayRemoteAccess("gatewayRemoteAccessResource", {
    allowedUrls: "string",
    gatewayRemoteAccessId: "string",
    hideSessionRecording: "string",
    kexalgs: "string",
    keyboardLayout: "string",
    legacySshAlgorithm: "string",
    rdpTargetConfiguration: "string",
    sshTargetConfiguration: "string",
});

    type: akeyless:GatewayRemoteAccess
properties:
    allowedUrls: string
    gatewayRemoteAccessId: string
    hideSessionRecording: string
    kexalgs: string
    keyboardLayout: string
    legacySshAlgorithm: string
    rdpTargetConfiguration: string
    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:

    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    sshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_urls str
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    ssh_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    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 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_urls: 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,
        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:  _:    type: akeyless:GatewayRemoteAccess    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:
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    AllowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    SshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls string
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    sshTargetConfiguration string
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowed_urls str
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    ssh_target_configuration str
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email
    allowedUrls String
    List of valid URLs to redirect from the Portal back to the remote access server (in a comma-delimited list)
    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
    sshTargetConfiguration String
    Specify the usernameSubClaim that exists inside the IDP JWT, e.g. email

    Package Details

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