Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. devices
  5. LiveToolsThroughputTest
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.devices.LiveToolsThroughputTest

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 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.devices.LiveToolsThroughputTest;
import com.pulumi.meraki.devices.LiveToolsThroughputTestArgs;
import com.pulumi.meraki.devices.inputs.LiveToolsThroughputTestCallbackArgs;
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 LiveToolsThroughputTest("example", LiveToolsThroughputTestArgs.builder()
            .callback(LiveToolsThroughputTestCallbackArgs.builder()
                .http_server(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .payload_template(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .shared_secret("secret")
                .url("https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031")
                .build())
            .serial("string")
            .build());

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

    resources:
  example:
    type: meraki:devices:LiveToolsThroughputTest
    properties:
      callback:
        http_server:
          id: aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vd2ViaG9va3M=
        payload_template:
          id: wpt_2100
        shared_secret: secret
        url: https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031
      serial: string
outputs:
  merakiDevicesLiveToolsThroughputTestExample: ${example}

    Create LiveToolsThroughputTest Resource

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

    Constructor syntax

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

@overload
def LiveToolsThroughputTest(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            serial: Optional[str] = None,
                            callback: Optional[LiveToolsThroughputTestCallbackArgs] = None,
                            throughput_test_id: Optional[str] = None)
    func NewLiveToolsThroughputTest(ctx *Context, name string, args LiveToolsThroughputTestArgs, opts ...ResourceOption) (*LiveToolsThroughputTest, error)
    public LiveToolsThroughputTest(string name, LiveToolsThroughputTestArgs args, CustomResourceOptions? opts = null)
    public LiveToolsThroughputTest(String name, LiveToolsThroughputTestArgs args)
public LiveToolsThroughputTest(String name, LiveToolsThroughputTestArgs args, CustomResourceOptions options)

    type: meraki:devices:LiveToolsThroughputTest
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 LiveToolsThroughputTestArgs
    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 LiveToolsThroughputTestArgs
    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 LiveToolsThroughputTestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LiveToolsThroughputTestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LiveToolsThroughputTestArgs
    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 liveToolsThroughputTestResource = new Meraki.Devices.LiveToolsThroughputTest("liveToolsThroughputTestResource", new()
{
    Serial = "string",
    Callback = new Meraki.Devices.Inputs.LiveToolsThroughputTestCallbackArgs
    {
        HttpServer = new Meraki.Devices.Inputs.LiveToolsThroughputTestCallbackHttpServerArgs
        {
            Id = "string",
        },
        PayloadTemplate = new Meraki.Devices.Inputs.LiveToolsThroughputTestCallbackPayloadTemplateArgs
        {
            Id = "string",
        },
        SharedSecret = "string",
        Url = "string",
    },
    ThroughputTestId = "string",
});

    example, err := devices.NewLiveToolsThroughputTest(ctx, "liveToolsThroughputTestResource", &devices.LiveToolsThroughputTestArgs{
	Serial: pulumi.String("string"),
	Callback: &devices.LiveToolsThroughputTestCallbackArgs{
		HttpServer: &devices.LiveToolsThroughputTestCallbackHttpServerArgs{
			Id: pulumi.String("string"),
		},
		PayloadTemplate: &devices.LiveToolsThroughputTestCallbackPayloadTemplateArgs{
			Id: pulumi.String("string"),
		},
		SharedSecret: pulumi.String("string"),
		Url:          pulumi.String("string"),
	},
	ThroughputTestId: pulumi.String("string"),
})

    var liveToolsThroughputTestResource = new LiveToolsThroughputTest("liveToolsThroughputTestResource", LiveToolsThroughputTestArgs.builder()
    .serial("string")
    .callback(LiveToolsThroughputTestCallbackArgs.builder()
        .httpServer(LiveToolsThroughputTestCallbackHttpServerArgs.builder()
            .id("string")
            .build())
        .payloadTemplate(LiveToolsThroughputTestCallbackPayloadTemplateArgs.builder()
            .id("string")
            .build())
        .sharedSecret("string")
        .url("string")
        .build())
    .throughputTestId("string")
    .build());

    live_tools_throughput_test_resource = meraki.devices.LiveToolsThroughputTest("liveToolsThroughputTestResource",
    serial="string",
    callback={
        "http_server": {
            "id": "string",
        },
        "payload_template": {
            "id": "string",
        },
        "shared_secret": "string",
        "url": "string",
    },
    throughput_test_id="string")

    const liveToolsThroughputTestResource = new meraki.devices.LiveToolsThroughputTest("liveToolsThroughputTestResource", {
    serial: "string",
    callback: {
        httpServer: {
            id: "string",
        },
        payloadTemplate: {
            id: "string",
        },
        sharedSecret: "string",
        url: "string",
    },
    throughputTestId: "string",
});

    type: meraki:devices:LiveToolsThroughputTest
properties:
    callback:
        httpServer:
            id: string
        payloadTemplate:
            id: string
        sharedSecret: string
        url: string
    serial: string
    throughputTestId: string

    LiveToolsThroughputTest 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 LiveToolsThroughputTest resource accepts the following input properties:

    Serial string
    serial path parameter.
    Callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ThroughputTestId string
    ID of throughput test job
    Serial string
    serial path parameter.
    Callback LiveToolsThroughputTestCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    ThroughputTestId string
    ID of throughput test job
    serial String
    serial path parameter.
    callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    throughputTestId String
    ID of throughput test job
    serial string
    serial path parameter.
    callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    throughputTestId string
    ID of throughput test job
    serial str
    serial path parameter.
    callback LiveToolsThroughputTestCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    throughput_test_id str
    ID of throughput test job
    serial String
    serial path parameter.
    callback Property Map
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    throughputTestId String
    ID of throughput test job

    Outputs

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

    Error string
    Description of the error.
    Id string
    The provider-assigned unique ID for this managed resource.
    Request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    Result LiveToolsThroughputTestResult
    Result of the throughput test request
    Status string
    Status of the throughput test request
    Url string
    GET this url to check the status of your throughput test request
    Error string
    Description of the error.
    Id string
    The provider-assigned unique ID for this managed resource.
    Request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    Result LiveToolsThroughputTestResult
    Result of the throughput test request
    Status string
    Status of the throughput test request
    Url string
    GET this url to check the status of your throughput test request
    error String
    Description of the error.
    id String
    The provider-assigned unique ID for this managed resource.
    request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    result LiveToolsThroughputTestResult
    Result of the throughput test request
    status String
    Status of the throughput test request
    url String
    GET this url to check the status of your throughput test request
    error string
    Description of the error.
    id string
    The provider-assigned unique ID for this managed resource.
    request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    result LiveToolsThroughputTestResult
    Result of the throughput test request
    status string
    Status of the throughput test request
    url string
    GET this url to check the status of your throughput test request
    error str
    Description of the error.
    id str
    The provider-assigned unique ID for this managed resource.
    request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    result LiveToolsThroughputTestResult
    Result of the throughput test request
    status str
    Status of the throughput test request
    url str
    GET this url to check the status of your throughput test request
    error String
    Description of the error.
    id String
    The provider-assigned unique ID for this managed resource.
    request Property Map
    The parameters of the throughput test request
    result Property Map
    Result of the throughput test request
    status String
    Status of the throughput test request
    url String
    GET this url to check the status of your throughput test request

    Look up Existing LiveToolsThroughputTest Resource

    Get an existing LiveToolsThroughputTest 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?: LiveToolsThroughputTestState, opts?: CustomResourceOptions): LiveToolsThroughputTest
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        callback: Optional[LiveToolsThroughputTestCallbackArgs] = None,
        error: Optional[str] = None,
        request: Optional[LiveToolsThroughputTestRequestArgs] = None,
        result: Optional[LiveToolsThroughputTestResultArgs] = None,
        serial: Optional[str] = None,
        status: Optional[str] = None,
        throughput_test_id: Optional[str] = None,
        url: Optional[str] = None) -> LiveToolsThroughputTest
    func GetLiveToolsThroughputTest(ctx *Context, name string, id IDInput, state *LiveToolsThroughputTestState, opts ...ResourceOption) (*LiveToolsThroughputTest, error)
    public static LiveToolsThroughputTest Get(string name, Input<string> id, LiveToolsThroughputTestState? state, CustomResourceOptions? opts = null)
    public static LiveToolsThroughputTest get(String name, Output<String> id, LiveToolsThroughputTestState 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:
    Callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Error string
    Description of the error.
    Request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    Result LiveToolsThroughputTestResult
    Result of the throughput test request
    Serial string
    serial path parameter.
    Status string
    Status of the throughput test request
    ThroughputTestId string
    ID of throughput test job
    Url string
    GET this url to check the status of your throughput test request
    Callback LiveToolsThroughputTestCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    Error string
    Description of the error.
    Request LiveToolsThroughputTestRequestArgs
    The parameters of the throughput test request
    Result LiveToolsThroughputTestResultArgs
    Result of the throughput test request
    Serial string
    serial path parameter.
    Status string
    Status of the throughput test request
    ThroughputTestId string
    ID of throughput test job
    Url string
    GET this url to check the status of your throughput test request
    callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error String
    Description of the error.
    request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    result LiveToolsThroughputTestResult
    Result of the throughput test request
    serial String
    serial path parameter.
    status String
    Status of the throughput test request
    throughputTestId String
    ID of throughput test job
    url String
    GET this url to check the status of your throughput test request
    callback LiveToolsThroughputTestCallback
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error string
    Description of the error.
    request LiveToolsThroughputTestRequest
    The parameters of the throughput test request
    result LiveToolsThroughputTestResult
    Result of the throughput test request
    serial string
    serial path parameter.
    status string
    Status of the throughput test request
    throughputTestId string
    ID of throughput test job
    url string
    GET this url to check the status of your throughput test request
    callback LiveToolsThroughputTestCallbackArgs
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error str
    Description of the error.
    request LiveToolsThroughputTestRequestArgs
    The parameters of the throughput test request
    result LiveToolsThroughputTestResultArgs
    Result of the throughput test request
    serial str
    serial path parameter.
    status str
    Status of the throughput test request
    throughput_test_id str
    ID of throughput test job
    url str
    GET this url to check the status of your throughput test request
    callback Property Map
    Details for the callback. Please include either an httpServerId OR url and sharedSecret
    error String
    Description of the error.
    request Property Map
    The parameters of the throughput test request
    result Property Map
    Result of the throughput test request
    serial String
    serial path parameter.
    status String
    Status of the throughput test request
    throughputTestId String
    ID of throughput test job
    url String
    GET this url to check the status of your throughput test request

    Supporting Types

    LiveToolsThroughputTestCallback, LiveToolsThroughputTestCallbackArgs

    HttpServer LiveToolsThroughputTestCallbackHttpServer
    The webhook receiver used for the callback webhook.
    PayloadTemplate LiveToolsThroughputTestCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    SharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    Url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    HttpServer LiveToolsThroughputTestCallbackHttpServer
    The webhook receiver used for the callback webhook.
    PayloadTemplate LiveToolsThroughputTestCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    SharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    Url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer LiveToolsThroughputTestCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payloadTemplate LiveToolsThroughputTestCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    sharedSecret String
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url String
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer LiveToolsThroughputTestCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payloadTemplate LiveToolsThroughputTestCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    sharedSecret string
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url string
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    http_server LiveToolsThroughputTestCallbackHttpServer
    The webhook receiver used for the callback webhook.
    payload_template LiveToolsThroughputTestCallbackPayloadTemplate
    The payload template of the webhook used for the callback
    shared_secret str
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url str
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.
    httpServer Property Map
    The webhook receiver used for the callback webhook.
    payloadTemplate Property Map
    The payload template of the webhook used for the callback
    sharedSecret String
    A shared secret that will be included in the requests sent to the callback URL. It can be used to verify that the request was sent by Meraki. If using this field, please also specify an url.
    url String
    The callback URL for the webhook target. If using this field, please also specify a sharedSecret.

    LiveToolsThroughputTestCallbackHttpServer, LiveToolsThroughputTestCallbackHttpServerArgs

    Id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    Id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id String
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id string
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id str
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.
    id String
    The webhook receiver ID that will receive information. If specifying this, please leave the url and sharedSecret fields blank.

    LiveToolsThroughputTestCallbackPayloadTemplate, LiveToolsThroughputTestCallbackPayloadTemplateArgs

    Id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    Id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id String
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id string
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id str
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.
    id String
    The ID of the payload template. Defaults to 'wpt_00005' for the Callback (included) template.

    LiveToolsThroughputTestRequest, LiveToolsThroughputTestRequestArgs

    Serial string
    Device serial number
    Serial string
    Device serial number
    serial String
    Device serial number
    serial string
    Device serial number
    serial str
    Device serial number
    serial String
    Device serial number

    LiveToolsThroughputTestResult, LiveToolsThroughputTestResultArgs

    speeds Property Map
    Shows the speeds (Mbps)

    LiveToolsThroughputTestResultSpeeds, LiveToolsThroughputTestResultSpeedsArgs

    Downstream int
    Shows the download speed from shard (Mbps)
    Downstream int
    Shows the download speed from shard (Mbps)
    downstream Integer
    Shows the download speed from shard (Mbps)
    downstream number
    Shows the download speed from shard (Mbps)
    downstream int
    Shows the download speed from shard (Mbps)
    downstream Number
    Shows the download speed from shard (Mbps)

    Import

    $ pulumi import meraki:devices/liveToolsThroughputTest:LiveToolsThroughputTest example "serial,throughput_test_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.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-meraki