AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Calls the Amazon Elastic Compute Cloud (EC2) ModifyInstanceMetadataOptions API operation.
Edit-EC2InstanceMetadataOption
-InstanceId <String>
-DryRun <Boolean>
-HttpEndpoint <InstanceMetadataEndpointState>
-HttpProtocolIpv6 <InstanceMetadataProtocolState>
-HttpPutResponseHopLimit <Int32>
-HttpToken <HttpTokensState>
-InstanceMetadataTag <InstanceMetadataTagsState>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>
Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of âpendingâ. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from âpendingâ to âappliedâ in subsequent describe-instances API calls. For more information, see
Instance metadata and user datain the
Amazon EC2 User Guide.
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required? False Position? Named Accept pipeline input? True (ByPropertyName)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 .
Required? False Position? Named Accept pipeline input? True (ByPropertyName)This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? False Position? Named Accept pipeline input? True (ByPropertyName)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.
Required? False Position? Named Accept pipeline input? True (ByPropertyName)Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
Required? False Position? Named Accept pipeline input? True (ByPropertyName)-HttpPutResponseHopLimit <
Int32>
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
Required? False Position? Named Accept pipeline input? True (ByPropertyName)Indicates whether IMDSv2 is required.
Default:
The default value can also be affected by other combinations of parameters. For more information, see
Order of precedence for instance metadata optionsin the
Amazon EC2 User Guide.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases HttpTokensThe ID of the instance.
Required? True Position? 1 Accept pipeline input? True (ByValue, ByPropertyName) Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases InstanceMetadataTagsUse the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse). Specifying the name of a property of type Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Common Credential and Region ParametersThe AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases AKAn AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False Position? Named Accept pipeline input? True (ByValue, ByPropertyName)The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required? False Position? Named Accept pipeline input? True (ByPropertyName)-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False Position? Named Accept pipeline input? True (ByValue, ByPropertyName)Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases AWSProfilesLocation, ProfilesLocationThe user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases StoredCredentials, AWSProfileName-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases RegionToCallThe AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases SK, SecretAccessKeyThe session token if the access and secret keys are temporary session-based credentials.
Required? False Position? Named Accept pipeline input? True (ByPropertyName) Aliases STThis cmdlet returns an Amazon.EC2.Model.ModifyInstanceMetadataOptionsResponse object containing multiple properties.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4