Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Amazon WorkSpaces

Least Privileged User

Navigate to the AWS console and create an IAM user with programmatic access. The user will need the following permissions. You can create a policy specifically for these permissions and apply the permissions to the user.

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "VisualEditor0",
      "Effect": "Allow",
      "Action": [
        "workspaces:DescribeWorkspacesConnectionStatus",
        "workspaces:DescribeTags",
        "workspaces:DescribeWorkspaceBundles",
        "workspaces:DescribeWorkspaces",
        "workspaces:DescribeWorkspaceDirectories",
        "cloudwatch:GetMetricStatistics",
        "cloudwatch:ListMetrics"
      ],
      "Resource": "*"
    }
  ]
}

Connection Parameters

Name
Required?
Description

Region

Access Key ID

Required

Secret Access Key

Required

Additional Threads

The number of additional threads allowed to be utilized during collection.

Request Timeout (seconds)

The number of seconds to allow for the API to return a response.

Collect CloudWatch Metrics

CloudWatch Historic Mode

If enabled, retrieves a history of data points from CloudWatch. Otherwise, collects only the most recent data point for each metric.

Metrics

Bundle

Name
Description

Compute Type

The compute type for the Bundle.

Description

The description of the Bundle.

ID

ID of the Amazon WorkSpaces Bundle.

Name

The name of the Bundle.

Owner

The owner of the Bundle.

Region

The AWS Region this object belongs to.

Root Storage Capacity (Gibibytes)

The size of the root volume for the Bundle.

User Storage Capacity (Gibibytes)

The size of the user storage for the Bundle.

Directory

Name
Description

Alias

The Directory alias.

Available Workspaces

The number of WorkSpaces that returned a healthy status.

Average In Session Latency (Milliseconds)

The average round trip time between the WorkSpaces client and the WorkSpace.

Average Session Launch Time (Seconds)

The average amount of time it takes to initiate a WorkSpaces session.

Connection Attempts (Connections)

The number of connection attempts.

Connection Failures (Connections)

The number of failed connections.

Connection Successes (Connections)

The number of successful connections.

Custom Security Group ID

The identifier of any security groups to apply to WorkSpaces when they are created.

Customer User Name

The user name for the service account.

Default OU

The organizational unit (OU) in the Directory for the WorkSpace machine accounts.

DNS IP Addresses

The IP addresses of the DNS servers for the Directory.

Enable Internet Access

Indicates whether internet access is enabled for the Directory.

Enable WorkDocs

Indicates whether the Directory is enabled for Amazon WorkDocs.

IAM Role ID

The identifier of the IAM role.

ID

ID of the Amazon WorkSpaces Directory.

Name

The name of the Directory.

Region

The AWS Region this object belongs to.

Registration Code

The registration code for the Directory.

Session Disconnects (Connections)

The number of connections that were closed, including user-initiated and failed connections.

State

The state of the Directory's registration with Amazon WorkSpaces.

Stopped Workspaces

The number of WorkSpaces that are stopped.

Subnet IDs

The identifiers of the subnets used with the Directory.

Type

The Directory type.

Unhealthy Workspaces

The number of WorkSpaces that returned an unhealthy status.

User Is Local Administrator

Indicates whether the WorkSpace user is an administrator on the WorkSpace.

Workspace Security Group ID

The identifier of the security group that is assigned to new WorkSpaces.

Workspaces In Maintenance

The number of WorkSpaces that are under maintenance.

Workspaces With Connections

The number of WorkSpaces that have a user connected.

Workspace

Name
Description

Available

If the WorkSpace returned a healthy status.

Bundle ID

The identifier of the bundle used to create the WorkSpace.

Compute Type

The bundle compute type of the Workspace.

Computer Name

The name of the WorkSpace, as seen by the operating system.

Connection Attempts (Connections)

The number of connection attempts.

Connection Failures (Connections)

The number of failed connections.

Connection State

The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

Connection State Timestamp

The timestamp of the connection state check.

Connection Successes (Connections)

The number of successful connections.

Directory ID

The identifier of the AWS Directory Service directory for the WorkSpace.

Error Code

If the WorkSpace could not be created, contains the error code.

Error Message

If the WorkSpace could not be created, contains a textual error message that describes the failure.

ID

ID of the Amazon WorkSpaces WorkSpace.

In Session Latency (Milliseconds)

The round trip time between the WorkSpaces client and the WorkSpace.

IP Address

The IP address of the WorkSpace.

Last Known User Connection Timestamp

The timestamp of the last known user connection.

Maintenance

If the WorkSpace is under maintenance.

Region

The AWS Region this object belongs to.

Root Volume Encryption Enabled

Indicates whether the data stored on the root volume is encrypted.

Root Volume Size (Gibibytes)

The size of the root volume.

Running Mode

The running mode of the Workspace.

Running Mode Auto Stop Timeout (Minutes)

The time after a user logs off when WorkSpaces are automatically stopped.

Session Disconnects (Connections)

The number of connections that were closed, including user-initiated and failed connections.

Session Launch Time (Seconds)

The amount of time it takes to initiate a WorkSpaces session.

State

The operational state of the WorkSpace.

Stopped

If the WorkSpace is stopped.

Subnet ID

The identifier of the subnet for the WorkSpace.

Unhealthy

If the WorkSpace returned an unhealthy status.

User Connected

If the WorkSpace has a user connected.

User Name

The user for the WorkSpace.

User Volume Encryption Enabled

Indicates whether the data stored on the user volume is encrypted.

User Volume Size (Gibibytes)

The size of the user storage.

Volume Encryption Key

The KMS key used to encrypt data stored on your WorkSpace.