ModifyApplicationStatusCheckRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the ModifyApplicationStatusCheck operation. 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.

In this article ▶

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifyApplicationStatusCheckRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class ModifyApplicationStatusCheckRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyApplicationStatusCheckRequest type exposes the following members

Constructors

	Name	Description
	ModifyApplicationStatusCheckRequest()

Properties

Name	Type	Description
Aggregation	Amazon.EC2.AggregationStatusEnum	Gets and sets the property Aggregation. 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`.
ApplicationStatusCheckId	System.String	Gets and sets the property ApplicationStatusCheckId. The ID of the application status check to modify.
ClientToken	System.String	Gets and sets the property ClientToken. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
DeviceIndex	System.Nullable<System.Int32>	Gets and sets the property DeviceIndex. The index of the network device to use for the health check. The value must be greater than or equal to 0.
DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. 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`.
FailureThreshold	System.Nullable<System.Int32>	Gets and sets the property FailureThreshold. The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
HealthCheckPaths	System.Collections.Generic.List<Amazon.EC2.Model.HealthCheckPathRequestObject>	Gets and sets the property HealthCheckPaths. 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.
InitializationGracePeriodSeconds	System.Nullable<System.Int32>	Gets and sets the property InitializationGracePeriodSeconds. The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
Interval	System.Nullable<System.Int32>	Gets and sets the property Interval. The interval, in seconds, between health checks. Valid value: 60.
IpScope	Amazon.EC2.IpScopeEnum	Gets and sets the property IpScope. The IP scope to use for the health check. Valid value: `private`.
IpVersion	Amazon.EC2.IpVersionEnum	Gets and sets the property IpVersion. The IP version to use for the health check. Valid values: `ipv4` and `ipv6`.
Path	System.String	Gets and sets the property Path. The URL path to use for the health check HTTP request (for example, `/health` or `/status`).
Port	System.Nullable<System.Int32>	Gets and sets the property Port. The port to use for the health check. Valid values: 1 to 65535.
Protocol	Amazon.EC2.NetworkProtocolEnum	Gets and sets the property Protocol. The protocol to use for the health check. Valid values: `http` \| `https`.
StatusCodeMatcher	System.String	Gets and sets the property StatusCodeMatcher. 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.
SuccessThreshold	System.Nullable<System.Int32>	Gets and sets the property SuccessThreshold. The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
Timeout	System.Nullable<System.Int32>	Gets and sets the property Timeout. 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`.

Examples

This example modifies the port and path of an existing application status check.

To modify an application status check


var client = new AmazonEC2Client();
var response = client.ModifyApplicationStatusCheck(new ModifyApplicationStatusCheckRequest 
{
    ApplicationStatusCheckId = "asc-0123456789abcdef0",
    Path = "/healthv2",
    Port = 8080
});

ApplicationStatusCheckResponseObject applicationStatusCheck = response.ApplicationStatusCheck;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer