« blib/lib/Paws/EC2/DiskImageVolumeDescription.pm
↑ Summary
blib/lib/Paws/EC2/EbsInstanceBlockDevice.pm »
| 1 | package Paws::EC2::EbsBlockDevice; | ||
| 2 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 3 | 1 | has DeleteOnTermination => (is => 'ro', isa => 'Bool', request_name => 'deleteOnTermination', traits => ['NameInRequest']); | |
| 4 | 1 | has Encrypted => (is => 'ro', isa => 'Bool', request_name => 'encrypted', traits => ['NameInRequest']); | |
| 5 | 1 | has Iops => (is => 'ro', isa => 'Int', request_name => 'iops', traits => ['NameInRequest']); | |
| 6 | 1 | has KmsKeyId => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has OutpostArn => (is => 'ro', isa => 'Str', request_name => 'outpostArn', traits => ['NameInRequest']); | |
| 8 | 1 | has SnapshotId => (is => 'ro', isa => 'Str', request_name => 'snapshotId', traits => ['NameInRequest']); | |
| 9 | 1 | has Throughput => (is => 'ro', isa => 'Int', request_name => 'throughput', traits => ['NameInRequest']); | |
| 10 | 1 | has VolumeSize => (is => 'ro', isa => 'Int', request_name => 'volumeSize', traits => ['NameInRequest']); | |
| 11 | 1 | has VolumeType => (is => 'ro', isa => 'Str', request_name => 'volumeType', traits => ['NameInRequest']); | |
| 12 | 1 | 1; | |
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::EC2::EbsBlockDevice | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::EC2::EbsBlockDevice object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { DeleteOnTermination => $value, ..., VolumeType => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::EC2::EbsBlockDevice object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->DeleteOnTermination | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | This class has no description | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DeleteOnTermination => Bool | ||
| 48 | |||
| 49 | Indicates whether the EBS volume is deleted on instance termination. | ||
| 50 | For more information, see Preserving Amazon EBS volumes on instance | ||
| 51 | termination | ||
| 52 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) | ||
| 53 | in the I<Amazon EC2 User Guide>. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Encrypted => Bool | ||
| 57 | |||
| 58 | Indicates whether the encryption state of an EBS volume is changed | ||
| 59 | while being restored from a backing snapshot. The effect of setting the | ||
| 60 | encryption state to C<true> depends on the volume origin (new or from a | ||
| 61 | snapshot), starting encryption state, ownership, and whether encryption | ||
| 62 | by default is enabled. For more information, see Amazon EBS encryption | ||
| 63 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-parameters) | ||
| 64 | in the I<Amazon EC2 User Guide>. | ||
| 65 | |||
| 66 | In no case can you remove encryption from an encrypted volume. | ||
| 67 | |||
| 68 | Encrypted volumes can only be attached to instances that support Amazon | ||
| 69 | EBS encryption. For more information, see Supported instance types | ||
| 70 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). | ||
| 71 | |||
| 72 | This parameter is not returned by . | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Iops => Int | ||
| 76 | |||
| 77 | The number of I/O operations per second (IOPS). For C<gp3>, C<io1>, and | ||
| 78 | C<io2> volumes, this represents the number of IOPS that are provisioned | ||
| 79 | for the volume. For C<gp2> volumes, this represents the baseline | ||
| 80 | performance of the volume and the rate at which the volume accumulates | ||
| 81 | I/O credits for bursting. | ||
| 82 | |||
| 83 | The following are the supported values for each volume type: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<gp3>: 3,000-16,000 IOPS | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<io1>: 100-64,000 IOPS | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<io2>: 100-64,000 IOPS | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | For C<io1> and C<io2> volumes, we guarantee 64,000 IOPS only for | ||
| 102 | Instances built on the Nitro System | ||
| 103 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). | ||
| 104 | Other instance families guarantee performance up to 32,000 IOPS. | ||
| 105 | |||
| 106 | This parameter is required for C<io1> and C<io2> volumes. The default | ||
| 107 | for C<gp3> volumes is 3,000 IOPS. This parameter is not supported for | ||
| 108 | C<gp2>, C<st1>, C<sc1>, or C<standard> volumes. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 KmsKeyId => Str | ||
| 112 | |||
| 113 | Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer | ||
| 114 | managed CMK under which the EBS volume is encrypted. | ||
| 115 | |||
| 116 | This parameter is only supported on C<BlockDeviceMapping> objects | ||
| 117 | called by RunInstances | ||
| 118 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html), | ||
| 119 | RequestSpotFleet | ||
| 120 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), | ||
| 121 | and RequestSpotInstances | ||
| 122 | (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html). | ||
| 123 | |||
| 124 | |||
| 125 | =head2 OutpostArn => Str | ||
| 126 | |||
| 127 | The ARN of the Outpost on which the snapshot is stored. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 SnapshotId => Str | ||
| 131 | |||
| 132 | The ID of the snapshot. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 Throughput => Int | ||
| 136 | |||
| 137 | The throughput that the volume supports, in MiB/s. | ||
| 138 | |||
| 139 | This parameter is valid only for C<gp3> volumes. | ||
| 140 | |||
| 141 | Valid Range: Minimum value of 125. Maximum value of 1000. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 VolumeSize => Int | ||
| 145 | |||
| 146 | The size of the volume, in GiBs. You must specify either a snapshot ID | ||
| 147 | or a volume size. If you specify a snapshot, the default is the | ||
| 148 | snapshot size. You can specify a volume size that is equal to or larger | ||
| 149 | than the snapshot size. | ||
| 150 | |||
| 151 | The following are the supported volumes sizes for each volume type: | ||
| 152 | |||
| 153 | =over | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<gp2> and C<gp3>:1-16,384 | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | C<io1> and C<io2>: 4-16,384 | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | C<st1> and C<sc1>: 125-16,384 | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<standard>: 1-1,024 | ||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 VolumeType => Str | ||
| 176 | |||
| 177 | The volume type. For more information, see Amazon EBS volume types | ||
| 178 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) | ||
| 179 | in the I<Amazon EC2 User Guide>. If the volume type is C<io1> or | ||
| 180 | C<io2>, you must specify the IOPS that the volume supports. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head1 SEE ALSO | ||
| 185 | |||
| 186 | This class forms part of L<Paws>, describing an object used in L<Paws::EC2> | ||
| 187 | |||
| 188 | =head1 BUGS and CONTRIBUTIONS | ||
| 189 | |||
| 190 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 191 | |||
| 192 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 193 | |||
| 194 | =cut | ||