« blib/lib/Paws/AutoScaling/DisableMetricsCollection.pm
↑ Summary
blib/lib/Paws/AutoScaling/EnableMetricsCollection.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::Ebs; | ||
| 3 | use Moose; | ||
| 4 | has DeleteOnTermination => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Encrypted => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 7 | has SnapshotId => (is => 'ro', isa => 'Str'); | ||
| 8 | has Throughput => (is => 'ro', isa => 'Int'); | ||
| 9 | has VolumeSize => (is => 'ro', isa => 'Int'); | ||
| 10 | has VolumeType => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::AutoScaling::Ebs | ||
| 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::AutoScaling::Ebs 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::AutoScaling::Ebs object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->DeleteOnTermination | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Describes information used to set up an Amazon EBS volume specified in | ||
| 43 | a block device mapping. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 DeleteOnTermination => Bool | ||
| 49 | |||
| 50 | Indicates whether the volume is deleted on instance termination. For | ||
| 51 | Amazon EC2 Auto Scaling, the default value is C<true>. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Encrypted => Bool | ||
| 55 | |||
| 56 | Specifies whether the volume should be encrypted. Encrypted EBS volumes | ||
| 57 | can only be attached to instances that support Amazon EBS encryption. | ||
| 58 | For more information, see Supported Instance Types | ||
| 59 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). | ||
| 60 | If your AMI uses encrypted volumes, you can also only launch it on | ||
| 61 | supported instance types. | ||
| 62 | |||
| 63 | If you are creating a volume from a snapshot, you cannot specify an | ||
| 64 | encryption value. Volumes that are created from encrypted snapshots are | ||
| 65 | automatically encrypted, and volumes that are created from unencrypted | ||
| 66 | snapshots are automatically unencrypted. By default, encrypted | ||
| 67 | snapshots use the Amazon Web Services managed CMK that is used for EBS | ||
| 68 | encryption, but you can specify a custom CMK when you create the | ||
| 69 | snapshot. The ability to encrypt a snapshot during copying also allows | ||
| 70 | you to apply a new CMK to an already-encrypted snapshot. Volumes | ||
| 71 | restored from the resulting copy are only accessible using the new CMK. | ||
| 72 | |||
| 73 | Enabling encryption by default | ||
| 74 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) | ||
| 75 | results in all EBS volumes being encrypted with the Amazon Web Services | ||
| 76 | managed CMK or a customer managed CMK, whether or not the snapshot was | ||
| 77 | encrypted. | ||
| 78 | |||
| 79 | For more information, see Using Encryption with EBS-Backed AMIs | ||
| 80 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) | ||
| 81 | in the I<Amazon EC2 User Guide for Linux Instances> and Required CMK | ||
| 82 | key policy for use with encrypted volumes | ||
| 83 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/key-policy-requirements-EBS-encryption.html) | ||
| 84 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Iops => Int | ||
| 88 | |||
| 89 | The number of input/output (I/O) operations per second (IOPS) to | ||
| 90 | provision for the volume. For C<gp3> and C<io1> volumes, this | ||
| 91 | represents the number of IOPS that are provisioned for the volume. For | ||
| 92 | C<gp2> volumes, this represents the baseline performance of the volume | ||
| 93 | and the rate at which the volume accumulates I/O credits for bursting. | ||
| 94 | |||
| 95 | The following are the supported values for each volume type: | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<gp3>: 3,000-16,000 IOPS | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | C<io1>: 100-64,000 IOPS | ||
| 106 | |||
| 107 | =back | ||
| 108 | |||
| 109 | For C<io1> volumes, we guarantee 64,000 IOPS only for Instances built | ||
| 110 | on the Nitro System | ||
| 111 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). | ||
| 112 | Other instance families guarantee performance up to 32,000 IOPS. | ||
| 113 | |||
| 114 | C<Iops> is supported when the volume type is C<gp3> or C<io1> and | ||
| 115 | required only when the volume type is C<io1>. (Not used with | ||
| 116 | C<standard>, C<gp2>, C<st1>, or C<sc1> volumes.) | ||
| 117 | |||
| 118 | |||
| 119 | =head2 SnapshotId => Str | ||
| 120 | |||
| 121 | The snapshot ID of the volume to use. | ||
| 122 | |||
| 123 | You must specify either a C<VolumeSize> or a C<SnapshotId>. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Throughput => Int | ||
| 127 | |||
| 128 | The throughput (MiBps) to provision for a C<gp3> volume. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 VolumeSize => Int | ||
| 132 | |||
| 133 | The volume size, in GiBs. The following are the supported volumes sizes | ||
| 134 | for each volume type: | ||
| 135 | |||
| 136 | =over | ||
| 137 | |||
| 138 | =item * | ||
| 139 | |||
| 140 | C<gp2> and C<gp3>: 1-16,384 | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | C<io1>: 4-16,384 | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | C<st1> and C<sc1>: 125-16,384 | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<standard>: 1-1,024 | ||
| 153 | |||
| 154 | =back | ||
| 155 | |||
| 156 | You must specify either a C<SnapshotId> or a C<VolumeSize>. If you | ||
| 157 | specify both C<SnapshotId> and C<VolumeSize>, the volume size must be | ||
| 158 | equal or greater than the size of the snapshot. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 VolumeType => Str | ||
| 162 | |||
| 163 | The volume type. For more information, see Amazon EBS Volume Types | ||
| 164 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) | ||
| 165 | in the I<Amazon EC2 User Guide for Linux Instances>. | ||
| 166 | |||
| 167 | Valid Values: C<standard> | C<io1> | C<gp2> | C<st1> | C<sc1> | C<gp3> | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head1 SEE ALSO | ||
| 172 | |||
| 173 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 174 | |||
| 175 | =head1 BUGS and CONTRIBUTIONS | ||
| 176 | |||
| 177 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 178 | |||
| 179 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 180 | |||
| 181 | =cut | ||
| 182 |