« blib/lib/Paws/EC2/ModifyTransitGatewayVpcAttachmentResult.pm
↑ Summary
blib/lib/Paws/EC2/ModifyVolumeAttribute.pm »
| 1 | |||
| 2 | package Paws::EC2::ModifyVolume; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 6 | has MultiAttachEnabled => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Size => (is => 'ro', isa => 'Int'); | ||
| 8 | has Throughput => (is => 'ro', isa => 'Int'); | ||
| 9 | has VolumeId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has VolumeType => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyVolume'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ModifyVolumeResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::EC2::ModifyVolume - Arguments for method ModifyVolume on L<Paws::EC2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ModifyVolume on the | ||
| 28 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 29 | as arguments to method ModifyVolume. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyVolume. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ec2 = Paws->service('EC2'); | ||
| 36 | my $ModifyVolumeResult = $ec2->ModifyVolume( | ||
| 37 | VolumeId => 'MyVolumeId', | ||
| 38 | DryRun => 1, # OPTIONAL | ||
| 39 | Iops => 1, # OPTIONAL | ||
| 40 | MultiAttachEnabled => 1, # OPTIONAL | ||
| 41 | Size => 1, # OPTIONAL | ||
| 42 | Throughput => 1, # OPTIONAL | ||
| 43 | VolumeType => 'standard', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $VolumeModification = $ModifyVolumeResult->VolumeModification; | ||
| 48 | |||
| 49 | # Returns a L<Paws::EC2::ModifyVolumeResult> object. | ||
| 50 | |||
| 51 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyVolume> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 DryRun => Bool | ||
| 58 | |||
| 59 | Checks whether you have the required permissions for the action, | ||
| 60 | without actually making the request, and provides an error response. If | ||
| 61 | you have the required permissions, the error response is | ||
| 62 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 Iops => Int | ||
| 67 | |||
| 68 | The target IOPS rate of the volume. This parameter is valid only for | ||
| 69 | C<gp3>, C<io1>, and C<io2> volumes. | ||
| 70 | |||
| 71 | The following are the supported values for each volume type: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<gp3>: 3,000-16,000 IOPS | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<io1>: 100-64,000 IOPS | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<io2>: 100-64,000 IOPS | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | Default: If no IOPS value is specified, the existing value is retained, | ||
| 90 | unless a volume type is modified that supports different values. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 MultiAttachEnabled => Bool | ||
| 95 | |||
| 96 | Specifies whether to enable Amazon EBS Multi-Attach. If you enable | ||
| 97 | Multi-Attach, you can attach the volume to up to 16 Nitro-based | ||
| 98 | instances | ||
| 99 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) | ||
| 100 | in the same Availability Zone. This parameter is supported with C<io1> | ||
| 101 | and C<io2> volumes only. For more information, see Amazon EBS | ||
| 102 | Multi-Attach | ||
| 103 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html) | ||
| 104 | in the I<Amazon Elastic Compute Cloud User Guide>. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 Size => Int | ||
| 109 | |||
| 110 | The target size of the volume, in GiB. The target volume size must be | ||
| 111 | greater than or equal to the existing size of the volume. | ||
| 112 | |||
| 113 | The following are the supported volumes sizes for each volume type: | ||
| 114 | |||
| 115 | =over | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | C<gp2> and C<gp3>: 1-16,384 | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<io1> and C<io2>: 4-16,384 | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<st1> and C<sc1>: 125-16,384 | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<standard>: 1-1,024 | ||
| 132 | |||
| 133 | =back | ||
| 134 | |||
| 135 | Default: If no size is specified, the existing size is retained. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 Throughput => Int | ||
| 140 | |||
| 141 | The target throughput of the volume, in MiB/s. This parameter is valid | ||
| 142 | only for C<gp3> volumes. The maximum value is 1,000. | ||
| 143 | |||
| 144 | Default: If no throughput value is specified, the existing value is | ||
| 145 | retained. | ||
| 146 | |||
| 147 | Valid Range: Minimum value of 125. Maximum value of 1000. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head2 B<REQUIRED> VolumeId => Str | ||
| 152 | |||
| 153 | The ID of the volume. | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 VolumeType => Str | ||
| 158 | |||
| 159 | The target EBS volume type of the volume. For more information, see | ||
| 160 | Amazon EBS volume types | ||
| 161 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) | ||
| 162 | in the I<Amazon Elastic Compute Cloud User Guide>. | ||
| 163 | |||
| 164 | Default: If no type is specified, the existing type is retained. | ||
| 165 | |||
| 166 | Valid values are: C<"standard">, C<"io1">, C<"io2">, C<"gp2">, C<"sc1">, C<"st1">, C<"gp3"> | ||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, documenting arguments for method ModifyVolume in L<Paws::EC2> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |