Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixPeriodicPing
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixPeriodicPing

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    The aviatrix_periodic_ping resource manages the periodic ping feature for Aviatrix gateways.

    Example Usage

    using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Enable Periodic Ping for a Gateway
    var testPing = new Aviatrix.AviatrixPeriodicPing("testPing", new()
    {
        GwName = "test-gw",
        Interval = 600,
        IpAddress = "127.0.0.1",
    });

});

    package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixPeriodicPing(ctx, "testPing", &aviatrix.AviatrixPeriodicPingArgs{
			GwName:    pulumi.String("test-gw"),
			Interval:  pulumi.Int(600),
			IpAddress: pulumi.String("127.0.0.1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixPeriodicPing;
import com.pulumi.aviatrix.AviatrixPeriodicPingArgs;
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) {
        var testPing = new AviatrixPeriodicPing("testPing", AviatrixPeriodicPingArgs.builder()        
            .gwName("test-gw")
            .interval(600)
            .ipAddress("127.0.0.1")
            .build());

    }
}

    import pulumi
import pulumi_aviatrix as aviatrix

# Enable Periodic Ping for a Gateway
test_ping = aviatrix.AviatrixPeriodicPing("testPing",
    gw_name="test-gw",
    interval=600,
    ip_address="127.0.0.1")

    import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Enable Periodic Ping for a Gateway
const testPing = new aviatrix.AviatrixPeriodicPing("test_ping", {
    gwName: "test-gw",
    interval: 600,
    ipAddress: "127.0.0.1",
});

    resources:
  # Enable Periodic Ping for a Gateway
  testPing:
    type: aviatrix:AviatrixPeriodicPing
    properties:
      gwName: test-gw
      interval: 600
      ipAddress: 127.0.0.1

    Create AviatrixPeriodicPing Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AviatrixPeriodicPing(name: string, args: AviatrixPeriodicPingArgs, opts?: CustomResourceOptions);
    @overload
def AviatrixPeriodicPing(resource_name: str,
                         args: AviatrixPeriodicPingArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def AviatrixPeriodicPing(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         gw_name: Optional[str] = None,
                         interval: Optional[int] = None,
                         ip_address: Optional[str] = None)
    func NewAviatrixPeriodicPing(ctx *Context, name string, args AviatrixPeriodicPingArgs, opts ...ResourceOption) (*AviatrixPeriodicPing, error)
    public AviatrixPeriodicPing(string name, AviatrixPeriodicPingArgs args, CustomResourceOptions? opts = null)
    public AviatrixPeriodicPing(String name, AviatrixPeriodicPingArgs args)
public AviatrixPeriodicPing(String name, AviatrixPeriodicPingArgs args, CustomResourceOptions options)

    type: aviatrix:AviatrixPeriodicPing
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AviatrixPeriodicPingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AviatrixPeriodicPingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AviatrixPeriodicPingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AviatrixPeriodicPingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AviatrixPeriodicPingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aviatrixPeriodicPingResource = new Aviatrix.AviatrixPeriodicPing("aviatrixPeriodicPingResource", new()
{
    GwName = "string",
    Interval = 0,
    IpAddress = "string",
});

    example, err := aviatrix.NewAviatrixPeriodicPing(ctx, "aviatrixPeriodicPingResource", &aviatrix.AviatrixPeriodicPingArgs{
	GwName:    pulumi.String("string"),
	Interval:  pulumi.Int(0),
	IpAddress: pulumi.String("string"),
})

    var aviatrixPeriodicPingResource = new AviatrixPeriodicPing("aviatrixPeriodicPingResource", AviatrixPeriodicPingArgs.builder()
    .gwName("string")
    .interval(0)
    .ipAddress("string")
    .build());

    aviatrix_periodic_ping_resource = aviatrix.AviatrixPeriodicPing("aviatrixPeriodicPingResource",
    gw_name="string",
    interval=0,
    ip_address="string")

    const aviatrixPeriodicPingResource = new aviatrix.AviatrixPeriodicPing("aviatrixPeriodicPingResource", {
    gwName: "string",
    interval: 0,
    ipAddress: "string",
});

    type: aviatrix:AviatrixPeriodicPing
properties:
    gwName: string
    interval: 0
    ipAddress: string

    AviatrixPeriodicPing Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AviatrixPeriodicPing resource accepts the following input properties:

    GwName string
    Name of the gateway.
    Interval int
    Interval between pings in seconds.
    IpAddress string
    IP Address to ping.
    GwName string
    Name of the gateway.
    Interval int
    Interval between pings in seconds.
    IpAddress string
    IP Address to ping.
    gwName String
    Name of the gateway.
    interval Integer
    Interval between pings in seconds.
    ipAddress String
    IP Address to ping.
    gwName string
    Name of the gateway.
    interval number
    Interval between pings in seconds.
    ipAddress string
    IP Address to ping.
    gw_name str
    Name of the gateway.
    interval int
    Interval between pings in seconds.
    ip_address str
    IP Address to ping.
    gwName String
    Name of the gateway.
    interval Number
    Interval between pings in seconds.
    ipAddress String
    IP Address to ping.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AviatrixPeriodicPing resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AviatrixPeriodicPing Resource

    Get an existing AviatrixPeriodicPing resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AviatrixPeriodicPingState, opts?: CustomResourceOptions): AviatrixPeriodicPing
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gw_name: Optional[str] = None,
        interval: Optional[int] = None,
        ip_address: Optional[str] = None) -> AviatrixPeriodicPing
    func GetAviatrixPeriodicPing(ctx *Context, name string, id IDInput, state *AviatrixPeriodicPingState, opts ...ResourceOption) (*AviatrixPeriodicPing, error)
    public static AviatrixPeriodicPing Get(string name, Input<string> id, AviatrixPeriodicPingState? state, CustomResourceOptions? opts = null)
    public static AviatrixPeriodicPing get(String name, Output<String> id, AviatrixPeriodicPingState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GwName string
    Name of the gateway.
    Interval int
    Interval between pings in seconds.
    IpAddress string
    IP Address to ping.
    GwName string
    Name of the gateway.
    Interval int
    Interval between pings in seconds.
    IpAddress string
    IP Address to ping.
    gwName String
    Name of the gateway.
    interval Integer
    Interval between pings in seconds.
    ipAddress String
    IP Address to ping.
    gwName string
    Name of the gateway.
    interval number
    Interval between pings in seconds.
    ipAddress string
    IP Address to ping.
    gw_name str
    Name of the gateway.
    interval int
    Interval between pings in seconds.
    ip_address str
    IP Address to ping.
    gwName String
    Name of the gateway.
    interval Number
    Interval between pings in seconds.
    ipAddress String
    IP Address to ping.

    Import

    aviatrix_periodic_ping can be imported using the gw_name, e.g.

     $ pulumi import aviatrix:index/aviatrixPeriodicPing:AviatrixPeriodicPing test gw_name

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
    astipkovits/pulumi-aviatrix