steampipe plugin install awssteampipe plugin install aws

Table: aws_workspaces_directory

Amazon WorkSpaces Directory refers to the service that manages user identities and access control for Amazon WorkSpaces. Amazon WorkSpaces is a cloud-based desktop computing service that allows users to access virtual desktops from anywhere, on any device. The directory in Amazon WorkSpaces serves as the central source for user authentication and management. It can be thought of as the repository of user accounts and permissions that control who can access and use WorkSpaces instances.

Examples

Basic info

select
  name,
  directory_id,
  arn,
  alias,
  customer_user_name,
  directory_type,
  state
from
  aws_workspaces_directory;

List directories that have certificate authority ARN enabled

select
  name,
  directory_id,
  arn,
  alias,
  customer_user_name,
  directory_type,
  state
from
  aws_workspaces_directory
where
  certificate_based_auth_properties ->> 'Status' = 'ENABLED';

List directories of a particular type

select
  name,
  directory_id,
  arn,
  alias,
  customer_user_name,
  directory_type,
  state
from
  aws_workspaces_directory
where
  directory_type = 'SIMPLE_AD';

Get the SAML properties of a particular directory

select
  name,
  directory_id,
  arn,
  saml_properties ->> 'RelayStateParameterName' as saml_relay_state_parameter_name,
  saml_properties ->> 'Status' as saml_status,
  saml_properties ->> 'UserAccessUrl' as saml_user_access_url
from
  aws_workspaces_directory
where
  directory_id = 'd-96676995ea';

List the directories that have 'SwitchRunningMode' enabled

select
  name,
  directory_id,
  arn,
  alias,
  customer_user_name,
  directory_type,
  state,
  selfservice_permissions ->> 'SwitchRunningMode' as switch_running_mode
from
  aws_workspaces_directory
where
  selfservice_permissions ->> 'SwitchRunningMode' = 'ENABLED';

Get the workspace creation properties of a particular directory

select
  name,
  directory_id,
  arn,
  workspace_creation_properties ->> 'CustomSecurityGroupId' as custom_security_group_id,
  workspace_creation_properties ->> 'DefaultOu' as default_ou,
  workspace_creation_properties ->> 'EnableInternetAccess' as enable_internet_access,
  workspace_creation_properties ->> 'EnableMaintenanceMode' as enable_maintenance_mode,
  workspace_creation_properties ->> 'EnableWorkDocs' as enable_work_docs,
  workspace_creation_properties ->> 'UserEnabledAsLocalAdministrator' as user_enabled_as_local_administrator
from
  aws_workspaces_directory
where
  directory_id = 'd-96676995ea';

List all registered directories

select
  name,
  directory_id,
  arn,
  alias,
  customer_user_name,
  directory_type,
  state
from
  aws_workspaces_directory
where
  state = 'REGISTERED';

Get the workspace access properties of a particular directory

select
  name,
  directory_id,
  arn,
  workspace_access_properties ->> 'DeviceTypeAndroid' as device_type_android,
  workspace_access_properties ->> 'DeviceTypeChromeOs' as device_type_chrome_os,
  workspace_access_properties ->> 'DeviceTypeIos' as device_type_ios,
  workspace_access_properties ->> 'DeviceTypeLinux' as device_type_linux,
  workspace_access_properties ->> 'DeviceTypeOsx' as device_type_osx,
  workspace_access_properties ->> 'DeviceTypeWeb' as device_type_web,
  workspace_access_properties ->> 'DeviceTypeWindows' as device_type_windows,
  workspace_access_properties ->> 'DeviceTypeZeroClient' as device_type_zero_client
from
  aws_workspaces_directory
where
  directory_id = 'd-96676995ea';

.inspect aws_workspaces_directory

AWS Workspaces Directory

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
account_id	text	The AWS Account ID in which the resource is located.
akas	jsonb	Array of globally unique identifier strings (also known as) for the resource.
alias	text	The directory alias.
arn	text	The arn of the directory.
certificate_based_auth_properties	jsonb	The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
customer_user_name	text	The user name for the service account.
directory_id	text	The directory identifier.
directory_type	text	The directory type.
dns_ip_addresses	jsonb	The IP addresses of the DNS servers for the directory.
iam_role_id	text	The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
ip_group_ids	text	The identifiers of the IP access control groups associated with the directory.
name	text	The name of the directory.
partition	text	The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
region	text	The AWS Region in which the resource is located.
registration_code	text	The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
saml_properties	jsonb	Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
selfservice_permissions	jsonb	The default self-service permissions for WorkSpaces in the directory.
state	text	The state of the directory's registration with Amazon WorkSpaces.
subnet_ids	jsonb	The identifiers of the subnets used with the directory.
tags	jsonb	A map of tags for the resource.
tags_src	jsonb	The list of tags for the directory.
tenancy	text	Specifies whether the directory is dedicated or shared.
title	text	Title of the resource.
workspace_access_properties	jsonb	The devices and operating systems that users can use to access WorkSpaces.
workspace_creation_properties	jsonb	The default creation properties for all WorkSpaces in the directory.
workspace_security_group_id	text	The identifier of the security group that is assigned to new WorkSpaces.

turbot/aws