Struct aws_sdk_ec2::types::InstanceMetadataOptionsRequest
source · #[non_exhaustive]pub struct InstanceMetadataOptionsRequest {
pub http_tokens: Option<HttpTokensState>,
pub http_put_response_hop_limit: Option<i32>,
pub http_endpoint: Option<InstanceMetadataEndpointState>,
pub http_protocol_ipv6: Option<InstanceMetadataProtocolState>,
pub instance_metadata_tags: Option<InstanceMetadataTagsState>,
}
Expand description
The metadata options for the instance.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.http_tokens: Option<HttpTokensState>
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
http_put_response_hop_limit: Option<i32>
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
http_endpoint: Option<InstanceMetadataEndpointState>
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
http_protocol_ipv6: Option<InstanceMetadataProtocolState>
Enables or disables the IPv6 endpoint for the instance metadata service.
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
Implementations§
source§impl InstanceMetadataOptionsRequest
impl InstanceMetadataOptionsRequest
sourcepub fn http_tokens(&self) -> Option<&HttpTokensState>
pub fn http_tokens(&self) -> Option<&HttpTokensState>
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
sourcepub fn http_put_response_hop_limit(&self) -> Option<i32>
pub fn http_put_response_hop_limit(&self) -> Option<i32>
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
sourcepub fn http_endpoint(&self) -> Option<&InstanceMetadataEndpointState>
pub fn http_endpoint(&self) -> Option<&InstanceMetadataEndpointState>
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
sourcepub fn http_protocol_ipv6(&self) -> Option<&InstanceMetadataProtocolState>
pub fn http_protocol_ipv6(&self) -> Option<&InstanceMetadataProtocolState>
Enables or disables the IPv6 endpoint for the instance metadata service.
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
source§impl InstanceMetadataOptionsRequest
impl InstanceMetadataOptionsRequest
sourcepub fn builder() -> InstanceMetadataOptionsRequestBuilder
pub fn builder() -> InstanceMetadataOptionsRequestBuilder
Creates a new builder-style object to manufacture InstanceMetadataOptionsRequest
.
Trait Implementations§
source§impl Clone for InstanceMetadataOptionsRequest
impl Clone for InstanceMetadataOptionsRequest
source§fn clone(&self) -> InstanceMetadataOptionsRequest
fn clone(&self) -> InstanceMetadataOptionsRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq<InstanceMetadataOptionsRequest> for InstanceMetadataOptionsRequest
impl PartialEq<InstanceMetadataOptionsRequest> for InstanceMetadataOptionsRequest
source§fn eq(&self, other: &InstanceMetadataOptionsRequest) -> bool
fn eq(&self, other: &InstanceMetadataOptionsRequest) -> bool
self
and other
values to be equal, and is used
by ==
.