« blib/lib/Paws/EC2/ModifyInstanceEventStartTimeResult.pm
↑ Summary
blib/lib/Paws/EC2/ModifyInstanceMetadataOptionsResult.pm »
| 1 | |||
| 2 | package Paws::EC2::ModifyInstanceMetadataOptions; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has HttpEndpoint => (is => 'ro', isa => 'Str'); | ||
| 6 | has HttpPutResponseHopLimit => (is => 'ro', isa => 'Int'); | ||
| 7 | has HttpTokens => (is => 'ro', isa => 'Str'); | ||
| 8 | has InstanceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyInstanceMetadataOptions'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ModifyInstanceMetadataOptionsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::ModifyInstanceMetadataOptions - Arguments for method ModifyInstanceMetadataOptions on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ModifyInstanceMetadataOptions on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method ModifyInstanceMetadataOptions. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyInstanceMetadataOptions. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $ModifyInstanceMetadataOptionsResult = | ||
| 35 | $ec2->ModifyInstanceMetadataOptions( | ||
| 36 | InstanceId => 'MyInstanceId', | ||
| 37 | DryRun => 1, # OPTIONAL | ||
| 38 | HttpEndpoint => 'disabled', # OPTIONAL | ||
| 39 | HttpPutResponseHopLimit => 1, # OPTIONAL | ||
| 40 | HttpTokens => 'optional', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $InstanceId = $ModifyInstanceMetadataOptionsResult->InstanceId; | ||
| 45 | my $InstanceMetadataOptions = | ||
| 46 | $ModifyInstanceMetadataOptionsResult->InstanceMetadataOptions; | ||
| 47 | |||
| 48 | # Returns a L<Paws::EC2::ModifyInstanceMetadataOptionsResult> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyInstanceMetadataOptions> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 DryRun => Bool | ||
| 57 | |||
| 58 | Checks whether you have the required permissions for the action, | ||
| 59 | without actually making the request, and provides an error response. If | ||
| 60 | you have the required permissions, the error response is | ||
| 61 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 HttpEndpoint => Str | ||
| 66 | |||
| 67 | This parameter enables or disables the HTTP metadata endpoint on your | ||
| 68 | instances. If the parameter is not specified, the existing state is | ||
| 69 | maintained. | ||
| 70 | |||
| 71 | If you specify a value of C<disabled>, you will not be able to access | ||
| 72 | your instance metadata. | ||
| 73 | |||
| 74 | Valid values are: C<"disabled">, C<"enabled"> | ||
| 75 | |||
| 76 | =head2 HttpPutResponseHopLimit => Int | ||
| 77 | |||
| 78 | The desired HTTP PUT response hop limit for instance metadata requests. | ||
| 79 | The larger the number, the further instance metadata requests can | ||
| 80 | travel. If no parameter is specified, the existing state is maintained. | ||
| 81 | |||
| 82 | Possible values: Integers from 1 to 64 | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 HttpTokens => Str | ||
| 87 | |||
| 88 | The state of token usage for your instance metadata requests. If the | ||
| 89 | parameter is not specified in the request, the default state is | ||
| 90 | C<optional>. | ||
| 91 | |||
| 92 | If the state is C<optional>, you can choose to retrieve instance | ||
| 93 | metadata with or without a signed token header on your request. If you | ||
| 94 | retrieve the IAM role credentials without a token, the version 1.0 role | ||
| 95 | credentials are returned. If you retrieve the IAM role credentials | ||
| 96 | using a valid signed token, the version 2.0 role credentials are | ||
| 97 | returned. | ||
| 98 | |||
| 99 | If the state is C<required>, you must send a signed token header with | ||
| 100 | any instance metadata retrieval requests. In this state, retrieving the | ||
| 101 | IAM role credential always returns the version 2.0 credentials; the | ||
| 102 | version 1.0 credentials are not available. | ||
| 103 | |||
| 104 | Valid values are: C<"optional">, C<"required"> | ||
| 105 | |||
| 106 | =head2 B<REQUIRED> InstanceId => Str | ||
| 107 | |||
| 108 | The ID of the instance. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method ModifyInstanceMetadataOptions in L<Paws::EC2> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |