AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Workspace

import "github.com/aws/aws-sdk-go/service/workspaces"

type Workspace struct { BundleId *string `type:"string"` ComputerName *string `type:"string"` DirectoryId *string `type:"string"` ErrorCode *string `type:"string"` ErrorMessage *string `type:"string"` IpAddress *string `type:"string"` ModificationStates []*ModificationState `type:"list"` RootVolumeEncryptionEnabled *bool `type:"boolean"` State *string `type:"string" enum:"WorkspaceState"` SubnetId *string `type:"string"` UserName *string `min:"1" type:"string"` UserVolumeEncryptionEnabled *bool `type:"boolean"` VolumeEncryptionKey *string `type:"string"` WorkspaceId *string `type:"string"` WorkspaceProperties *WorkspaceProperties `type:"structure"` }

Describes a WorkSpace.

BundleId

Type: *string

The identifier of the bundle used to create the WorkSpace.

ComputerName

Type: *string

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

DirectoryId

Type: *string

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

ErrorCode

Type: *string

The error code that is returned if the WorkSpace cannot be created.

ErrorMessage

Type: *string

The text of the error message that is returned if the WorkSpace cannot be created.

IpAddress

Type: *string

The IP address of the WorkSpace.

ModificationStates

Describes a WorkSpace modification.

RootVolumeEncryptionEnabled

Type: *bool

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

State

Type: *string

The operational state of the WorkSpace.

SubnetId

Type: *string

The identifier of the subnet for the WorkSpace.

UserName

Type: *string

The user for the WorkSpace.

UserVolumeEncryptionEnabled

Type: *bool

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

VolumeEncryptionKey

Type: *string

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

WorkspaceId

Type: *string

The identifier of the WorkSpace.

WorkspaceProperties

Describes a WorkSpace.

Method

GoString

func (s Workspace) GoString() string

GoString returns the string representation

SetBundleId

func (s *Workspace) SetBundleId(v string) *Workspace

SetBundleId sets the BundleId field's value.

SetComputerName

func (s *Workspace) SetComputerName(v string) *Workspace

SetComputerName sets the ComputerName field's value.

SetDirectoryId

func (s *Workspace) SetDirectoryId(v string) *Workspace

SetDirectoryId sets the DirectoryId field's value.

SetErrorCode

func (s *Workspace) SetErrorCode(v string) *Workspace

SetErrorCode sets the ErrorCode field's value.

SetErrorMessage

func (s *Workspace) SetErrorMessage(v string) *Workspace

SetErrorMessage sets the ErrorMessage field's value.

SetIpAddress

func (s *Workspace) SetIpAddress(v string) *Workspace

SetIpAddress sets the IpAddress field's value.

SetModificationStates

func (s *Workspace) SetModificationStates(v []*ModificationState) *Workspace

SetModificationStates sets the ModificationStates field's value.

SetRootVolumeEncryptionEnabled

func (s *Workspace) SetRootVolumeEncryptionEnabled(v bool) *Workspace

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

SetState

func (s *Workspace) SetState(v string) *Workspace

SetState sets the State field's value.

SetSubnetId

func (s *Workspace) SetSubnetId(v string) *Workspace

SetSubnetId sets the SubnetId field's value.

SetUserName

func (s *Workspace) SetUserName(v string) *Workspace

SetUserName sets the UserName field's value.

SetUserVolumeEncryptionEnabled

func (s *Workspace) SetUserVolumeEncryptionEnabled(v bool) *Workspace

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

SetVolumeEncryptionKey

func (s *Workspace) SetVolumeEncryptionKey(v string) *Workspace

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

SetWorkspaceId

func (s *Workspace) SetWorkspaceId(v string) *Workspace

SetWorkspaceId sets the WorkspaceId field's value.

SetWorkspaceProperties

func (s *Workspace) SetWorkspaceProperties(v *WorkspaceProperties) *Workspace

SetWorkspaceProperties sets the WorkspaceProperties field's value.

String

func (s Workspace) String() string

String returns the string representation

WorkspaceRequest

import "github.com/aws/aws-sdk-go/service/workspaces"

type WorkspaceRequest struct { BundleId *string `type:"string" required:"true"` DirectoryId *string `type:"string" required:"true"` RootVolumeEncryptionEnabled *bool `type:"boolean"` Tags []*Tag `type:"list"` UserName *string `min:"1" type:"string" required:"true"` UserVolumeEncryptionEnabled *bool `type:"boolean"` VolumeEncryptionKey *string `type:"string"` WorkspaceProperties *WorkspaceProperties `type:"structure"` }

Describes the information used to create a WorkSpace.

BundleId

Type: *string

The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

BundleId is a required field

DirectoryId

Type: *string

The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

DirectoryId is a required field

RootVolumeEncryptionEnabled

Type: *bool

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

Tags

Describes a tag.

UserName

Type: *string

The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

UserName is a required field

UserVolumeEncryptionEnabled

Type: *bool

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

VolumeEncryptionKey

Type: *string

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

WorkspaceProperties

Describes a WorkSpace.

Method

GoString

func (s WorkspaceRequest) GoString() string

GoString returns the string representation

SetBundleId

func (s *WorkspaceRequest) SetBundleId(v string) *WorkspaceRequest

SetBundleId sets the BundleId field's value.

SetDirectoryId

func (s *WorkspaceRequest) SetDirectoryId(v string) *WorkspaceRequest

SetDirectoryId sets the DirectoryId field's value.

SetRootVolumeEncryptionEnabled

func (s *WorkspaceRequest) SetRootVolumeEncryptionEnabled(v bool) *WorkspaceRequest

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

SetTags

func (s *WorkspaceRequest) SetTags(v []*Tag) *WorkspaceRequest

SetTags sets the Tags field's value.

SetUserName

func (s *WorkspaceRequest) SetUserName(v string) *WorkspaceRequest

SetUserName sets the UserName field's value.

SetUserVolumeEncryptionEnabled

func (s *WorkspaceRequest) SetUserVolumeEncryptionEnabled(v bool) *WorkspaceRequest

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

SetVolumeEncryptionKey

func (s *WorkspaceRequest) SetVolumeEncryptionKey(v string) *WorkspaceRequest

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

SetWorkspaceProperties

func (s *WorkspaceRequest) SetWorkspaceProperties(v *WorkspaceProperties) *WorkspaceRequest

SetWorkspaceProperties sets the WorkspaceProperties field's value.

String

func (s WorkspaceRequest) String() string

String returns the string representation

Validate

func (s *WorkspaceRequest) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: