AWSEC2InstanceMetadataOptionsRequest

Objective-C

@interface AWSEC2InstanceMetadataOptionsRequest

Swift

class AWSEC2InstanceMetadataOptionsRequest

The metadata options for the instance.

  • Enables or disables the HTTP metadata endpoint on your instances.

    If you specify a value of disabled, you cannot access your instance metadata.

    Default: enabled

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataEndpointState httpEndpoint;

    Swift

    var httpEndpoint: AWSEC2InstanceMetadataEndpointState { get set }

  • Enables or disables the IPv6 endpoint for the instance metadata service.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataProtocolState httpProtocolIpv6;

    Swift

    var httpProtocolIpv6: AWSEC2InstanceMetadataProtocolState { get set }

  • The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.

    Default: 1

    Possible values: Integers from 1 to 64

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable httpPutResponseHopLimit;

    Swift

    var httpPutResponseHopLimit: NSNumber? { get set }

  • IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).

    • optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.

    • required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

    Default: optional

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2HttpTokensState httpTokens;

    Swift

    var httpTokens: AWSEC2HttpTokensState { get set }

  • Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.

    Default: disabled

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataTagsState instanceMetadataTags;

    Swift

    var instanceMetadataTags: AWSEC2InstanceMetadataTagsState { get set }