AWSEC2InstanceMetadataOptionsResponse

Objective-C

@interface AWSEC2InstanceMetadataOptionsResponse

Swift

class AWSEC2InstanceMetadataOptionsResponse

The metadata options for the instance.

  • Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

    If the value is disabled, you cannot access your instance metadata.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataEndpointState httpEndpoint;

    Swift

    var httpEndpoint: AWSEC2InstanceMetadataEndpointState { get set }

  • Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

    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. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is 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 }

  • Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataTagsState instanceMetadataTags;

    Swift

    var instanceMetadataTags: AWSEC2InstanceMetadataTagsState { get set }

  • The state of the metadata option changes.

    pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

    applied - The metadata options have been successfully applied on the instance.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataOptionsState state;

    Swift

    var state: AWSEC2InstanceMetadataOptionsState { get set }