AWSEC2ModifyInstanceMetadataOptionsRequest

Objective-C

@interface AWSEC2ModifyInstanceMetadataOptionsRequest

Swift

class AWSEC2ModifyInstanceMetadataOptionsRequest

  • Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    Declaration

    Objective-C

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

    Swift

    var dryRun: NSNumber? { get set }

  • Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.

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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataEndpointState httpEndpoint;

    Swift

    var httpEndpoint: AWSEC2InstanceMetadataEndpointState { get set }

  • Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.

    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. If no parameter is specified, the existing state is maintained.

    Possible values: Integers from 1 to 64

    Declaration

    Objective-C

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

    Swift

    var httpPutResponseHopLimit: NSNumber? { get set }

  • Indicates whether IMDSv2 is required.

    • optional - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials.

    • required - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.

    Default:

    • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0 and the account level default is set to no-preference, the default is required.

    • If the value of ImdsSupport for the Amazon Machine Image (AMI) for your instance is v2.0, but the account level default is set to V1 or V2, the default is optional.

    The default value can also be affected by other combinations of parameters. For more information, see Order of precedence for instance metadata options in the Amazon EC2 User Guide.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2HttpTokensState httpTokens;

    Swift

    var httpTokens: AWSEC2HttpTokensState { get set }

  • The ID of the instance.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceId;

    Swift

    var instanceId: String? { 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2InstanceMetadataTagsState instanceMetadataTags;

    Swift

    var instanceMetadataTags: AWSEC2InstanceMetadataTagsState { get set }