| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::Disk; | ||
| 3 | use Moose; | ||
| 4 | has AddOns => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::AddOn]', request_name => 'addOns', traits => ['NameInRequest']); | ||
| 5 | has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']); | ||
| 6 | has AttachedTo => (is => 'ro', isa => 'Str', request_name => 'attachedTo', traits => ['NameInRequest']); | ||
| 7 | has AttachmentState => (is => 'ro', isa => 'Str', request_name => 'attachmentState', traits => ['NameInRequest']); | ||
| 8 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 9 | has GbInUse => (is => 'ro', isa => 'Int', request_name => 'gbInUse', traits => ['NameInRequest']); | ||
| 10 | has Iops => (is => 'ro', isa => 'Int', request_name => 'iops', traits => ['NameInRequest']); | ||
| 11 | has IsAttached => (is => 'ro', isa => 'Bool', request_name => 'isAttached', traits => ['NameInRequest']); | ||
| 12 | has IsSystemDisk => (is => 'ro', isa => 'Bool', request_name => 'isSystemDisk', traits => ['NameInRequest']); | ||
| 13 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 14 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 15 | has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']); | ||
| 16 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 17 | has SizeInGb => (is => 'ro', isa => 'Int', request_name => 'sizeInGb', traits => ['NameInRequest']); | ||
| 18 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 19 | has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']); | ||
| 20 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::Lightsail::Disk | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::Lightsail::Disk object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { AddOns => $value, ..., Tags => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::Disk object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->AddOns | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Describes a system disk or a block storage disk. | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 AddOns => ArrayRef[L<Paws::Lightsail::AddOn>] | ||
| 58 | |||
| 59 | An array of objects representing the add-ons enabled on the disk. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Arn => Str | ||
| 63 | |||
| 64 | The Amazon Resource Name (ARN) of the disk. | ||
| 65 | |||
| 66 | |||
| 67 | =head2 AttachedTo => Str | ||
| 68 | |||
| 69 | The resources to which the disk is attached. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AttachmentState => Str | ||
| 73 | |||
| 74 | (Deprecated) The attachment state of the disk. | ||
| 75 | |||
| 76 | In releases prior to November 14, 2017, this parameter returned | ||
| 77 | C<attached> for system disks in the API response. It is now deprecated, | ||
| 78 | but still included in the response. Use C<isAttached> instead. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 CreatedAt => Str | ||
| 82 | |||
| 83 | The date when the disk was created. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 GbInUse => Int | ||
| 87 | |||
| 88 | (Deprecated) The number of GB in use by the disk. | ||
| 89 | |||
| 90 | In releases prior to November 14, 2017, this parameter was not included | ||
| 91 | in the API response. It is now deprecated. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 Iops => Int | ||
| 95 | |||
| 96 | The input/output operations per second (IOPS) of the disk. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 IsAttached => Bool | ||
| 100 | |||
| 101 | A Boolean value indicating whether the disk is attached. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 IsSystemDisk => Bool | ||
| 105 | |||
| 106 | A Boolean value indicating whether this disk is a system disk (has an | ||
| 107 | operating system loaded on it). | ||
| 108 | |||
| 109 | |||
| 110 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 111 | |||
| 112 | The AWS Region and Availability Zone where the disk is located. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 Name => Str | ||
| 116 | |||
| 117 | The unique name of the disk. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 Path => Str | ||
| 121 | |||
| 122 | The disk path. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 ResourceType => Str | ||
| 126 | |||
| 127 | The Lightsail resource type (e.g., C<Disk>). | ||
| 128 | |||
| 129 | |||
| 130 | =head2 SizeInGb => Int | ||
| 131 | |||
| 132 | The size of the disk in GB. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 State => Str | ||
| 136 | |||
| 137 | Describes the status of the disk. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 SupportCode => Str | ||
| 141 | |||
| 142 | The support code. Include this code in your email to support when you | ||
| 143 | have questions about an instance or another resource in Lightsail. This | ||
| 144 | code enables our support team to look up your Lightsail information | ||
| 145 | more easily. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 149 | |||
| 150 | The tag keys and optional values for the resource. For more information | ||
| 151 | about tags in Lightsail, see the Lightsail Dev Guide | ||
| 152 | (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |