CreateApplicationStatusCheckRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the CreateApplicationStatusCheck operation. Creates an application status check for monitoring the health of applications running on your instances. You can configure the protocol, port, path, and thresholds for the health check. The following rules apply:

You can create a maximum of 50 application status checks per account.
Health checks do not start until you associate the check with instances or tags using AssociateApplicationStatusCheck.
The Timeout value must be less than the Interval value.
The Path must start with a forward slash (/). Default: /.
If you do not specify Aggregation, it defaults to included, which means the check contributes to the instance-level application status.
Default values: Interval is 60 seconds, Timeout is 6 seconds, FailureThreshold is 2, SuccessThreshold is 2, StatusCodeMatcher is 200, InitializationGracePeriodSeconds is 300 seconds.
You can tag the application status check during creation. For more information, see Tag your Amazon EC2 resources.

In this article ▶

Inheritance Hierarchy

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

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

Syntax

public class CreateApplicationStatusCheckRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The CreateApplicationStatusCheckRequest type exposes the following members

Constructors

	Name	Description
	CreateApplicationStatusCheckRequest()

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`.
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. Health check paths define the network path from a source subnet to one or more destination subnets for cross-Availability Zone or Availability Zone to Local Zone health checking. If omitted, health checks are performed in the same subnet as the instance. 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. Default: `200`.
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.
TagSpecifications	System.Collections.Generic.List<Amazon.EC2.Model.TagSpecification>	Gets and sets the property TagSpecifications. The tags to apply to 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.
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 creates an application status check that monitors HTTP health on port 80.

To create an application status check


var client = new AmazonEC2Client();
var response = client.CreateApplicationStatusCheck(new CreateApplicationStatusCheckRequest 
{
    Aggregation = "included",
    Path = "/health",
    Port = 80,
    Protocol = "http"
});

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