AWS Tools for Windows PowerShell
Command Reference

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.

Synopsis

Calls the Amazon Elastic Compute Cloud (EC2) ModifyApplicationStatusCheck API operation.

Syntax

Edit-EC2ApplicationStatusCheck
-Aggregation <AggregationStatusEnum>
-ApplicationStatusCheckId <String>
-DeviceIndex <Int32>
-DryRun <Boolean>
-FailureThreshold <Int32>
-HealthCheckPath <HealthCheckPathRequestObject[]>
-InitializationGracePeriodSecond <Int32>
-Interval <Int32>
-IpScope <IpScopeEnum>
-IpVersion <IpVersionEnum>
-Path <String>
-Port <Int32>
-Protocol <NetworkProtocolEnum>
-StatusCodeMatcher <String>
-SuccessThreshold <Int32>
-Timeout <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEC2Config>

Description

Modifies an existing application status check. You can update the protocol, port, path, thresholds, and other configuration settings. The following rules apply:
  • The application status check must exist and belong to your account.
  • Changes take effect on the next health check interval.

Parameters

-Aggregation <AggregationStatusEnum>
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ApplicationStatusCheckId <String>
The ID of the application status check to modify.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonEC2Config>
Amazon.PowerShell.Cmdlets.EC2.AmazonEC2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DeviceIndex <Int32>
The index of the network device to use for the health check. The value must be greater than or equal to 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DryRun <Boolean>
Checks whether you have the required permissions for the operation, 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)
-FailureThreshold <Int32>
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
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)
The health check paths to use for the application status check. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHealthCheckPaths
-InitializationGracePeriodSecond <Int32>
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitializationGracePeriodSeconds
-Interval <Int32>
The interval, in seconds, between health checks. Valid value: 60.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpScope <IpScopeEnum>
The IP scope to use for the health check. Valid value: private.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IpVersion <IpVersionEnum>
The IP version to use for the health check. Valid values: ipv4 and ipv6.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Path <String>
The URL path to use for the health check HTTP request (for example, /health or /status).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port to use for the health check. Valid values: 1 to 65535.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
The protocol to use for the health check. Valid values: http | https.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ApplicationStatusCheck'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.EC2.Model.ModifyApplicationStatusCheckResponse). Specifying the name of a property of type Amazon.EC2.Model.ModifyApplicationStatusCheckResponse 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)
-StatusCodeMatcher <String>
The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SuccessThreshold <Int32>
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timeout <Int32>
The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The 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)
AliasesAK
-Credential <AWSCredentials>
An 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)
-EndpointUrl <String>
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)
-ProfileLocation <String>
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)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The 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)
AliasesStoredCredentials, 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)
AliasesRegionToCall
-SecretKey <String>
The 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)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.EC2.Model.ApplicationStatusCheckResponseObject object. The service call response (type Amazon.EC2.Model.ModifyApplicationStatusCheckResponse) can be returned by specifying '-Select *'.

Supported Version

AWS Tools for PowerShell: 2.x.y.z