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.

Disk

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

type Disk struct { Arn *string `locationName:"arn" type:"string"` AttachedTo *string `locationName:"attachedTo" type:"string"` AttachmentState *string `locationName:"attachmentState" deprecated:"true" type:"string"` CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"` GbInUse *int64 `locationName:"gbInUse" deprecated:"true" type:"integer"` Iops *int64 `locationName:"iops" type:"integer"` IsAttached *bool `locationName:"isAttached" type:"boolean"` IsSystemDisk *bool `locationName:"isSystemDisk" type:"boolean"` Location *ResourceLocation `locationName:"location" type:"structure"` Name *string `locationName:"name" type:"string"` Path *string `locationName:"path" type:"string"` ResourceType *string `locationName:"resourceType" type:"string" enum:"ResourceType"` SizeInGb *int64 `locationName:"sizeInGb" type:"integer"` State *string `locationName:"state" type:"string" enum:"DiskState"` SupportCode *string `locationName:"supportCode" type:"string"` Tags []*Tag `locationName:"tags" type:"list"` }

Describes a system disk or an block storage disk.

Arn

Type: *string

The Amazon Resource Name (ARN) of the disk.

AttachedTo

Type: *string

The resources to which the disk is attached.

AttachmentState

Type: *string

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

Deprecated: AttachmentState has been deprecated

CreatedAt

Type: *time.Time

The date when the disk was created.

GbInUse

Type: *int64

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

Deprecated: GbInUse has been deprecated

Iops

Type: *int64

The input/output operations per second (IOPS) of the disk.

IsAttached

Type: *bool

A Boolean value indicating whether the disk is attached.

IsSystemDisk

Type: *bool

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

Location

Describes the resource location.

Name

Type: *string

The unique name of the disk.

Path

Type: *string

The disk path.

ResourceType

Type: *string

The Lightsail resource type (e.g., Disk).

SizeInGb

Type: *int64

The size of the disk in GB.

State

Type: *string

Describes the status of the disk.

SupportCode

Type: *string

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

Tags

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).

Method

GoString

func (s Disk) GoString() string

GoString returns the string representation

SetArn

func (s *Disk) SetArn(v string) *Disk

SetArn sets the Arn field's value.

SetAttachedTo

func (s *Disk) SetAttachedTo(v string) *Disk

SetAttachedTo sets the AttachedTo field's value.

SetAttachmentState

func (s *Disk) SetAttachmentState(v string) *Disk

SetAttachmentState sets the AttachmentState field's value.

SetCreatedAt

func (s *Disk) SetCreatedAt(v time.Time) *Disk

SetCreatedAt sets the CreatedAt field's value.

SetGbInUse

func (s *Disk) SetGbInUse(v int64) *Disk

SetGbInUse sets the GbInUse field's value.

SetIops

func (s *Disk) SetIops(v int64) *Disk

SetIops sets the Iops field's value.

SetIsAttached

func (s *Disk) SetIsAttached(v bool) *Disk

SetIsAttached sets the IsAttached field's value.

SetIsSystemDisk

func (s *Disk) SetIsSystemDisk(v bool) *Disk

SetIsSystemDisk sets the IsSystemDisk field's value.

SetLocation

func (s *Disk) SetLocation(v *ResourceLocation) *Disk

SetLocation sets the Location field's value.

SetName

func (s *Disk) SetName(v string) *Disk

SetName sets the Name field's value.

SetPath

func (s *Disk) SetPath(v string) *Disk

SetPath sets the Path field's value.

SetResourceType

func (s *Disk) SetResourceType(v string) *Disk

SetResourceType sets the ResourceType field's value.

SetSizeInGb

func (s *Disk) SetSizeInGb(v int64) *Disk

SetSizeInGb sets the SizeInGb field's value.

SetState

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

SetState sets the State field's value.

SetSupportCode

func (s *Disk) SetSupportCode(v string) *Disk

SetSupportCode sets the SupportCode field's value.

SetTags

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

SetTags sets the Tags field's value.

String

func (s Disk) String() string

String returns the string representation

On this page: