You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WorkSpaces::Types::WorkspaceDirectory

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The directory alias.

Returns:

  • (String)

    The directory alias.

#customer_user_nameString

The user name for the service account.

Returns:

  • (String)

    The user name for the service account.

#directory_idString

The directory identifier.

Returns:

  • (String)

    The directory identifier.

#directory_nameString

The name of the directory.

Returns:

  • (String)

    The name of the directory.

#directory_typeString

The directory type.

Possible values:

  • SIMPLE_AD
  • AD_CONNECTOR

Returns:

  • (String)

    The directory type.

#dns_ip_addressesArray<String>

An array of strings that contains the IP addresses of the DNS servers for the directory.

Returns:

  • (Array<String>)

    An array of strings that contains the IP addresses of the DNS servers for the directory.

#iam_role_idString

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.

Returns:

  • (String)

    The identifier of the IAM role.

#registration_codeString

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

Returns:

  • (String)

    The registration code for the directory.

#stateString

The state of the directory\'s registration with Amazon WorkSpaces

Possible values:

  • REGISTERING
  • REGISTERED
  • DEREGISTERING
  • DEREGISTERED
  • ERROR

Returns:

  • (String)

    The state of the directory\'s registration with Amazon WorkSpaces.

#subnet_idsArray<String>

An array of strings that contains the identifiers of the subnets used with the directory.

Returns:

  • (Array<String>)

    An array of strings that contains the identifiers of the subnets used with the directory.

#workspace_creation_propertiesTypes::DefaultWorkspaceCreationProperties

A structure that specifies the default creation properties for all WorkSpaces in the directory.

Returns:

#workspace_security_group_idString

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

Returns:

  • (String)

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