constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
constellix.getTcpCheck
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
Data source for TCP check resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as constellix from "@pulumi/constellix";
const check = constellix.getTcpCheck({
name: "tcp check",
});
import pulumi
import pulumi_constellix as constellix
check = constellix.get_tcp_check(name="tcp check")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/constellix/constellix"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := constellix.LookupTcpCheck(ctx, &constellix.LookupTcpCheckArgs{
Name: "tcp check",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Constellix = Pulumi.Constellix;
return await Deployment.RunAsync(() =>
{
var check = Constellix.GetTcpCheck.Invoke(new()
{
Name = "tcp check",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.constellix.ConstellixFunctions;
import com.pulumi.constellix.inputs.GetTcpCheckArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var check = ConstellixFunctions.getTcpCheck(GetTcpCheckArgs.builder()
.name("tcp check")
.build());
}
}
variables:
check:
fn::invoke:
function: constellix:getTcpCheck
arguments:
name: tcp check
Argument Reference
name- (Required) Name of resource. Name should be unique.
Attribute Reference
name- (Required) name of the resource. Name should be unique.host- (Optional) Host for the resource, for example “constellix.com”. It can be set only once.ip_version- (Optional) Specifies the version of IP. It can be set only once.port- (Optional) Specifies the port number.check_sites- (Optional) Site ids to check.notification_groups- (Optional) List of group IDs for the notification group of TCP Check.interval- (Optional) Check Interval. Allowed values areTHIRTYSECONDS,ONEMINUTE,TWOMINUTES,THREEMINUTES,FOURMINUTES,FIVEMINUTES,TENMINUTES,THIRTYMINUTES,HALFDAYandDAY.interval_policy- (Optional) Agent Interval Run Policy. It specifies whether you want to run checks from one location or all. Allowed values arePARALLEL,ONCEPERSITEandONCEPERREGION.verification_policy- (Optional) Specifies how the check should be validated. Allowed values areSIMPLEandMAJORITY. This parameter will only work with theinterval_policyset toPARALLEL.string_to_send- (Optional) String to send along with the check. It can be any parameter to the endpoint.string_to_receive- (Optional) String which should be received as a result of TCP check.
Using getTcpCheck
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTcpCheck(args: GetTcpCheckArgs, opts?: InvokeOptions): Promise<GetTcpCheckResult>
function getTcpCheckOutput(args: GetTcpCheckOutputArgs, opts?: InvokeOptions): Output<GetTcpCheckResult>def get_tcp_check(check_sites: Optional[Sequence[float]] = None,
host: Optional[str] = None,
id: Optional[str] = None,
interval: Optional[str] = None,
interval_policy: Optional[str] = None,
ip_version: Optional[str] = None,
name: Optional[str] = None,
notification_groups: Optional[Sequence[float]] = None,
notification_report_timeout: Optional[float] = None,
port: Optional[float] = None,
string_to_receive: Optional[str] = None,
string_to_send: Optional[str] = None,
verification_policy: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTcpCheckResult
def get_tcp_check_output(check_sites: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
host: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
interval: Optional[pulumi.Input[str]] = None,
interval_policy: Optional[pulumi.Input[str]] = None,
ip_version: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
notification_groups: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
notification_report_timeout: Optional[pulumi.Input[float]] = None,
port: Optional[pulumi.Input[float]] = None,
string_to_receive: Optional[pulumi.Input[str]] = None,
string_to_send: Optional[pulumi.Input[str]] = None,
verification_policy: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTcpCheckResult]func LookupTcpCheck(ctx *Context, args *LookupTcpCheckArgs, opts ...InvokeOption) (*LookupTcpCheckResult, error)
func LookupTcpCheckOutput(ctx *Context, args *LookupTcpCheckOutputArgs, opts ...InvokeOption) LookupTcpCheckResultOutput> Note: This function is named LookupTcpCheck in the Go SDK.
public static class GetTcpCheck
{
public static Task<GetTcpCheckResult> InvokeAsync(GetTcpCheckArgs args, InvokeOptions? opts = null)
public static Output<GetTcpCheckResult> Invoke(GetTcpCheckInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetTcpCheckResult> getTcpCheck(GetTcpCheckArgs args, InvokeOptions options)
public static Output<GetTcpCheckResult> getTcpCheck(GetTcpCheckArgs args, InvokeOptions options)
fn::invoke:
function: constellix:index/getTcpCheck:getTcpCheck
arguments:
# arguments dictionaryThe following arguments are supported:
- Name string
- Check
Sites List<double> - Host string
- Id string
- Interval string
- Interval
Policy string - Ip
Version string - Notification
Groups List<double> - Notification
Report doubleTimeout - Port double
- String
To stringReceive - String
To stringSend - Verification
Policy string
- Name string
- Check
Sites []float64 - Host string
- Id string
- Interval string
- Interval
Policy string - Ip
Version string - Notification
Groups []float64 - Notification
Report float64Timeout - Port float64
- String
To stringReceive - String
To stringSend - Verification
Policy string
- name String
- check
Sites List<Double> - host String
- id String
- interval String
- interval
Policy String - ip
Version String - notification
Groups List<Double> - notification
Report DoubleTimeout - port Double
- string
To StringReceive - string
To StringSend - verification
Policy String
- name string
- check
Sites number[] - host string
- id string
- interval string
- interval
Policy string - ip
Version string - notification
Groups number[] - notification
Report numberTimeout - port number
- string
To stringReceive - string
To stringSend - verification
Policy string
- name str
- check_
sites Sequence[float] - host str
- id str
- interval str
- interval_
policy str - ip_
version str - notification_
groups Sequence[float] - notification_
report_ floattimeout - port float
- string_
to_ strreceive - string_
to_ strsend - verification_
policy str
- name String
- check
Sites List<Number> - host String
- id String
- interval String
- interval
Policy String - ip
Version String - notification
Groups List<Number> - notification
Report NumberTimeout - port Number
- string
To StringReceive - string
To StringSend - verification
Policy String
getTcpCheck Result
The following output properties are available:
- Check
Sites List<double> - Host string
- Id string
- Interval string
- Interval
Policy string - Ip
Version string - Name string
- Notification
Groups List<double> - Notification
Report doubleTimeout - Port double
- String
To stringReceive - String
To stringSend - Verification
Policy string
- Check
Sites []float64 - Host string
- Id string
- Interval string
- Interval
Policy string - Ip
Version string - Name string
- Notification
Groups []float64 - Notification
Report float64Timeout - Port float64
- String
To stringReceive - String
To stringSend - Verification
Policy string
- check
Sites List<Double> - host String
- id String
- interval String
- interval
Policy String - ip
Version String - name String
- notification
Groups List<Double> - notification
Report DoubleTimeout - port Double
- string
To StringReceive - string
To StringSend - verification
Policy String
- check
Sites number[] - host string
- id string
- interval string
- interval
Policy string - ip
Version string - name string
- notification
Groups number[] - notification
Report numberTimeout - port number
- string
To stringReceive - string
To stringSend - verification
Policy string
- check_
sites Sequence[float] - host str
- id str
- interval str
- interval_
policy str - ip_
version str - name str
- notification_
groups Sequence[float] - notification_
report_ floattimeout - port float
- string_
to_ strreceive - string_
to_ strsend - verification_
policy str
- check
Sites List<Number> - host String
- id String
- interval String
- interval
Policy String - ip
Version String - name String
- notification
Groups List<Number> - notification
Report NumberTimeout - port Number
- string
To StringReceive - string
To StringSend - verification
Policy String
Package Details
- Repository
- constellix constellix/terraform-provider-constellix
- License
- Notes
- This Pulumi package is based on the
constellixTerraform Provider.
constellix 0.4.6 published on Friday, Mar 7, 2025 by constellix
