gui_session_access_details

Creates, updates, deletes, gets or lists a gui_session_access_details resource.

Overview

Name	gui_session_access_details
Type	Resource
Id	aws.lightsail.gui_session_access_details

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_gui_session_access_details	insert	region, resourceName		Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session. Use StartGUISession to open the session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

create_gui_session_access_details

Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session. Use StartGUISession to open the session.

INSERT INTO aws.lightsail.gui_session_access_details (
resourceName,
region
)
SELECT 
'{{ resourceName }}' /* required */,
'{{ region }}'
RETURNING
failure_reason,
percentage_complete,
resource_name,
sessions,
status
;

Manifest

# Description fields are for documentation purposes
- name: gui_session_access_details
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the gui_session_access_details resource.
  - name: resourceName
    value: "{{ resourceName }}"
    description: |
      The resource name.