Docs Packages
  1. Packages
  2. Cisco Meraki
  3. API Docs
  4. networks
  5. WebhooksHttpServers
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.WebhooksHttpServers

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.WebhooksHttpServers;
import com.pulumi.meraki.networks.WebhooksHttpServersArgs;
import com.pulumi.meraki.networks.inputs.WebhooksHttpServersPayloadTemplateArgs;
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 example = new WebhooksHttpServers("example", WebhooksHttpServersArgs.builder()
            .name("Example Webhook Server")
            .networkId("string")
            .payloadTemplate(WebhooksHttpServersPayloadTemplateArgs.builder()
                .name("Meraki (included)")
                .payload_template_id("wpt_00001")
                .build())
            .sharedSecret("shhh")
            .url("https://example.com")
            .build());

        ctx.export("merakiNetworksWebhooksHttpServersExample", example);
    }
}

    resources:
  example:
    type: meraki:networks:WebhooksHttpServers
    properties:
      name: Example Webhook Server
      networkId: string
      payloadTemplate:
        name: Meraki (included)
        payload_template_id: wpt_00001
      sharedSecret: shhh
      url: https://example.com
outputs:
  merakiNetworksWebhooksHttpServersExample: ${example}

    Create WebhooksHttpServers Resource

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

    Constructor syntax

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

@overload
def WebhooksHttpServers(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        network_id: Optional[str] = None,
                        http_server_id: Optional[str] = None,
                        name: Optional[str] = None,
                        payload_template: Optional[WebhooksHttpServersPayloadTemplateArgs] = None,
                        shared_secret: Optional[str] = None,
                        url: Optional[str] = None)
    func NewWebhooksHttpServers(ctx *Context, name string, args WebhooksHttpServersArgs, opts ...ResourceOption) (*WebhooksHttpServers, error)
    public WebhooksHttpServers(string name, WebhooksHttpServersArgs args, CustomResourceOptions? opts = null)
    public WebhooksHttpServers(String name, WebhooksHttpServersArgs args)
public WebhooksHttpServers(String name, WebhooksHttpServersArgs args, CustomResourceOptions options)

    type: meraki:networks:WebhooksHttpServers
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 WebhooksHttpServersArgs
    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 WebhooksHttpServersArgs
    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 WebhooksHttpServersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhooksHttpServersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhooksHttpServersArgs
    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 webhooksHttpServersResource = new Meraki.Networks.WebhooksHttpServers("webhooksHttpServersResource", new()
{
    NetworkId = "string",
    HttpServerId = "string",
    Name = "string",
    PayloadTemplate = new Meraki.Networks.Inputs.WebhooksHttpServersPayloadTemplateArgs
    {
        Name = "string",
        PayloadTemplateId = "string",
    },
    SharedSecret = "string",
    Url = "string",
});

    example, err := networks.NewWebhooksHttpServers(ctx, "webhooksHttpServersResource", &networks.WebhooksHttpServersArgs{
	NetworkId:    pulumi.String("string"),
	HttpServerId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	PayloadTemplate: &networks.WebhooksHttpServersPayloadTemplateArgs{
		Name:              pulumi.String("string"),
		PayloadTemplateId: pulumi.String("string"),
	},
	SharedSecret: pulumi.String("string"),
	Url:          pulumi.String("string"),
})

    var webhooksHttpServersResource = new WebhooksHttpServers("webhooksHttpServersResource", WebhooksHttpServersArgs.builder()
    .networkId("string")
    .httpServerId("string")
    .name("string")
    .payloadTemplate(WebhooksHttpServersPayloadTemplateArgs.builder()
        .name("string")
        .payloadTemplateId("string")
        .build())
    .sharedSecret("string")
    .url("string")
    .build());

    webhooks_http_servers_resource = meraki.networks.WebhooksHttpServers("webhooksHttpServersResource",
    network_id="string",
    http_server_id="string",
    name="string",
    payload_template=meraki.networks.WebhooksHttpServersPayloadTemplateArgs(
        name="string",
        payload_template_id="string",
    ),
    shared_secret="string",
    url="string")

    const webhooksHttpServersResource = new meraki.networks.WebhooksHttpServers("webhooksHttpServersResource", {
    networkId: "string",
    httpServerId: "string",
    name: "string",
    payloadTemplate: {
        name: "string",
        payloadTemplateId: "string",
    },
    sharedSecret: "string",
    url: "string",
});

    type: meraki:networks:WebhooksHttpServers
properties:
    httpServerId: string
    name: string
    networkId: string
    payloadTemplate:
        name: string
        payloadTemplateId: string
    sharedSecret: string
    url: string

    WebhooksHttpServers Resource Properties

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

    Inputs

    The WebhooksHttpServers resource accepts the following input properties:

    NetworkId string
    A Meraki network ID.
    HttpServerId string
    httpServerId path parameter. Http server ID
    Name string
    A name for easy reference to the HTTP server
    PayloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    SharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    Url string
    The URL of the HTTP server.
    NetworkId string
    A Meraki network ID.
    HttpServerId string
    httpServerId path parameter. Http server ID
    Name string
    A name for easy reference to the HTTP server
    PayloadTemplate WebhooksHttpServersPayloadTemplateArgs
    The payload template to use when posting data to the HTTP server.
    SharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    Url string
    The URL of the HTTP server.
    networkId String
    A Meraki network ID.
    httpServerId String
    httpServerId path parameter. Http server ID
    name String
    A name for easy reference to the HTTP server
    payloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    sharedSecret String
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url String
    The URL of the HTTP server.
    networkId string
    A Meraki network ID.
    httpServerId string
    httpServerId path parameter. Http server ID
    name string
    A name for easy reference to the HTTP server
    payloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    sharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url string
    The URL of the HTTP server.
    network_id str
    A Meraki network ID.
    http_server_id str
    httpServerId path parameter. Http server ID
    name str
    A name for easy reference to the HTTP server
    payload_template WebhooksHttpServersPayloadTemplateArgs
    The payload template to use when posting data to the HTTP server.
    shared_secret str
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url str
    The URL of the HTTP server.
    networkId String
    A Meraki network ID.
    httpServerId String
    httpServerId path parameter. Http server ID
    name String
    A name for easy reference to the HTTP server
    payloadTemplate Property Map
    The payload template to use when posting data to the HTTP server.
    sharedSecret String
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url String
    The URL of the HTTP server.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WebhooksHttpServers 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 WebhooksHttpServers Resource

    Get an existing WebhooksHttpServers 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?: WebhooksHttpServersState, opts?: CustomResourceOptions): WebhooksHttpServers
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        http_server_id: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        payload_template: Optional[WebhooksHttpServersPayloadTemplateArgs] = None,
        shared_secret: Optional[str] = None,
        url: Optional[str] = None) -> WebhooksHttpServers
    func GetWebhooksHttpServers(ctx *Context, name string, id IDInput, state *WebhooksHttpServersState, opts ...ResourceOption) (*WebhooksHttpServers, error)
    public static WebhooksHttpServers Get(string name, Input<string> id, WebhooksHttpServersState? state, CustomResourceOptions? opts = null)
    public static WebhooksHttpServers get(String name, Output<String> id, WebhooksHttpServersState 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:
    HttpServerId string
    httpServerId path parameter. Http server ID
    Name string
    A name for easy reference to the HTTP server
    NetworkId string
    A Meraki network ID.
    PayloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    SharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    Url string
    The URL of the HTTP server.
    HttpServerId string
    httpServerId path parameter. Http server ID
    Name string
    A name for easy reference to the HTTP server
    NetworkId string
    A Meraki network ID.
    PayloadTemplate WebhooksHttpServersPayloadTemplateArgs
    The payload template to use when posting data to the HTTP server.
    SharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    Url string
    The URL of the HTTP server.
    httpServerId String
    httpServerId path parameter. Http server ID
    name String
    A name for easy reference to the HTTP server
    networkId String
    A Meraki network ID.
    payloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    sharedSecret String
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url String
    The URL of the HTTP server.
    httpServerId string
    httpServerId path parameter. Http server ID
    name string
    A name for easy reference to the HTTP server
    networkId string
    A Meraki network ID.
    payloadTemplate WebhooksHttpServersPayloadTemplate
    The payload template to use when posting data to the HTTP server.
    sharedSecret string
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url string
    The URL of the HTTP server.
    http_server_id str
    httpServerId path parameter. Http server ID
    name str
    A name for easy reference to the HTTP server
    network_id str
    A Meraki network ID.
    payload_template WebhooksHttpServersPayloadTemplateArgs
    The payload template to use when posting data to the HTTP server.
    shared_secret str
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url str
    The URL of the HTTP server.
    httpServerId String
    httpServerId path parameter. Http server ID
    name String
    A name for easy reference to the HTTP server
    networkId String
    A Meraki network ID.
    payloadTemplate Property Map
    The payload template to use when posting data to the HTTP server.
    sharedSecret String
    A shared secret that will be included in POSTs sent to the HTTP server. This secret can be used to verify that the request was sent by Meraki.
    url String
    The URL of the HTTP server.

    Supporting Types

    WebhooksHttpServersPayloadTemplate, WebhooksHttpServersPayloadTemplateArgs

    Name string
    The name of the payload template.
    PayloadTemplateId string
    The ID of the payload template.
    Name string
    The name of the payload template.
    PayloadTemplateId string
    The ID of the payload template.
    name String
    The name of the payload template.
    payloadTemplateId String
    The ID of the payload template.
    name string
    The name of the payload template.
    payloadTemplateId string
    The ID of the payload template.
    name str
    The name of the payload template.
    payload_template_id str
    The ID of the payload template.
    name String
    The name of the payload template.
    payloadTemplateId String
    The ID of the payload template.

    Import

    $ pulumi import meraki:networks/webhooksHttpServers:WebhooksHttpServers example "http_server_id,network_id"

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
    pulumi/pulumi-meraki