UptimeCheckConfigArgs class
The set of arguments for UptimeCheckConfig. The set of arguments for UptimeCheckConfig.
Constructors
-
UptimeCheckConfigArgs({Input<
String?> ? checkerType, Input<List< ? contentMatchers, Input<UptimeCheckConfigContentMatcher> ?>String?> ? deletionPolicy, required Input<String> displayName, Input<UptimeCheckConfigHttpCheck?> ? httpCheck, Input<bool?> ? logCheckFailures, Input<UptimeCheckConfigMonitoredResource?> ? monitoredResource, Input<String?> ? period, Input<String?> ? project, Input<UptimeCheckConfigResourceGroup?> ? resourceGroup, Input<List< ? selectedRegions, Input<String> ?>UptimeCheckConfigSyntheticMonitor?> ? syntheticMonitor, Input<UptimeCheckConfigTcpCheck?> ? tcpCheck, required Input<String> timeout, Input<Map< ? userLabels})String, String> ?> -
Creates a new UptimeCheckConfigArgs.
checkerTypeThe checker type to use for the check. If the monitored resource type isservicedirectoryService,checkerTypemust be set toVPC_CHECKERS.contentMatchersThe expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.deletionPolicyWhether Terraform will be prevented from destroying the resource. Defaults to DELETE.displayNameA human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.httpCheckContains information needed to make an HTTP or HTTPS check.logCheckFailuresSpecifies whether to log the results of failed probes to Cloud Logging.monitoredResourceThe monitored resource associated with theperiodHow often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.projectThe ID of the project in which the resource belongs.resourceGroupThe group resource associated with the configuration.selectedRegionsThe list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.syntheticMonitorA Synthetic Monitor deployed to a Cloud Functions V2 instance.tcpCheckContains information needed to make a TCP check.timeoutThe maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formatsuserLabelsUser-supplied key/value data to be used for organizing and identifying theUptimeCheckConfigobjects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.const -
UptimeCheckConfigArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
checkerType
→ Input<
String?> ? -
The checker type to use for the check. If the monitored resource type is
servicedirectoryService,checkerTypemust be set toVPC_CHECKERS. Possible values are:STATIC_IP_CHECKERS,VPC_CHECKERS.final -
contentMatchers
→ Input<
List< ?UptimeCheckConfigContentMatcher> ?> -
The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.
Structure is documented below.
final
-
deletionPolicy
→ Input<
String?> ? -
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
When a 'terraform destroy' or 'pulumi up' would delete the resource,
the command will fail if this field is set to "PREVENT" in Terraform state.
When set to "ABANDON", the command will remove the resource from Terraform
management without updating or deleting the resource in the API.
When set to "DELETE", deleting the resource is allowed.
final
-
displayName
→ Input<
String> -
A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
httpCheck
→ Input<
UptimeCheckConfigHttpCheck?> ? -
Contains information needed to make an HTTP or HTTPS check.
Structure is documented below.
final
-
logCheckFailures
→ Input<
bool?> ? -
Specifies whether to log the results of failed probes to Cloud Logging.
final
-
monitoredResource
→ Input<
UptimeCheckConfigMonitoredResource?> ? -
The monitored resource associated with the
configuration. The following monitored resource types are supported for
uptime checks:
final
-
period
→ Input<
String?> ? -
How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.
final
-
project
→ Input<
String?> ? -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
final
-
resourceGroup
→ Input<
UptimeCheckConfigResourceGroup?> ? -
The group resource associated with the configuration.
Structure is documented below.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selectedRegions
→ Input<
List< ?String> ?> -
The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
final
-
syntheticMonitor
→ Input<
UptimeCheckConfigSyntheticMonitor?> ? -
A Synthetic Monitor deployed to a Cloud Functions V2 instance.
Structure is documented below.
final
-
tcpCheck
→ Input<
UptimeCheckConfigTcpCheck?> ? -
Contains information needed to make a TCP check.
Structure is documented below.
final
-
timeout
→ Input<
String> -
The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
final
-
userLabels
→ Input<
Map< ?String, String> ?> -
User-supplied key/value data to be used for organizing and identifying the
UptimeCheckConfigobjects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited