« blib/lib/Paws/AutoScaling/GetPredictiveScalingForecastAnswer.pm
↑ Summary
blib/lib/Paws/AutoScaling/InstanceMonitoring.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::InstanceMetadataOptions; | ||
| 3 | use Moose; | ||
| 4 | has HttpEndpoint => (is => 'ro', isa => 'Str'); | ||
| 5 | has HttpPutResponseHopLimit => (is => 'ro', isa => 'Int'); | ||
| 6 | has HttpTokens => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::AutoScaling::InstanceMetadataOptions | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::AutoScaling::InstanceMetadataOptions object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { HttpEndpoint => $value, ..., HttpTokens => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::InstanceMetadataOptions object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->HttpEndpoint | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | The metadata options for the instances. For more information, see | ||
| 39 | Configuring the Instance Metadata Options | ||
| 40 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds) | ||
| 41 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 HttpEndpoint => Str | ||
| 47 | |||
| 48 | This parameter enables or disables the HTTP metadata endpoint on your | ||
| 49 | instances. If the parameter is not specified, the default state is | ||
| 50 | C<enabled>. | ||
| 51 | |||
| 52 | If you specify a value of C<disabled>, you will not be able to access | ||
| 53 | your instance metadata. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 HttpPutResponseHopLimit => Int | ||
| 57 | |||
| 58 | The desired HTTP PUT response hop limit for instance metadata requests. | ||
| 59 | The larger the number, the further instance metadata requests can | ||
| 60 | travel. | ||
| 61 | |||
| 62 | Default: 1 | ||
| 63 | |||
| 64 | |||
| 65 | =head2 HttpTokens => Str | ||
| 66 | |||
| 67 | The state of token usage for your instance metadata requests. If the | ||
| 68 | parameter is not specified in the request, the default state is | ||
| 69 | C<optional>. | ||
| 70 | |||
| 71 | If the state is C<optional>, you can choose to retrieve instance | ||
| 72 | metadata with or without a signed token header on your request. If you | ||
| 73 | retrieve the IAM role credentials without a token, the version 1.0 role | ||
| 74 | credentials are returned. If you retrieve the IAM role credentials | ||
| 75 | using a valid signed token, the version 2.0 role credentials are | ||
| 76 | returned. | ||
| 77 | |||
| 78 | If the state is C<required>, you must send a signed token header with | ||
| 79 | any instance metadata retrieval requests. In this state, retrieving the | ||
| 80 | IAM role credentials always returns the version 2.0 credentials; the | ||
| 81 | version 1.0 credentials are not available. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head1 SEE ALSO | ||
| 86 | |||
| 87 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 88 | |||
| 89 | =head1 BUGS and CONTRIBUTIONS | ||
| 90 | |||
| 91 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 92 | |||
| 93 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 94 | |||
| 95 | =cut | ||
| 96 |