1. Packages
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. KibanaSyntheticsParameter
Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.KibanaSyntheticsParameter

Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Creates or updates a Kibana synthetics parameter.

    See Working with secrets and sensitive values and API docs

    Example Usage

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

const example = new elasticstack.KibanaSyntheticsParameter("example", {
    key: "example_key",
    value: "example_value",
    description: "Example description",
    tags: [
        "tag-a",
        "tag-b",
    ],
});

    import pulumi
import pulumi_elasticstack as elasticstack

example = elasticstack.KibanaSyntheticsParameter("example",
    key="example_key",
    value="example_value",
    description="Example description",
    tags=[
        "tag-a",
        "tag-b",
    ])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticstack.NewKibanaSyntheticsParameter(ctx, "example", &elasticstack.KibanaSyntheticsParameterArgs{
			Key:         pulumi.String("example_key"),
			Value:       pulumi.String("example_value"),
			Description: pulumi.String("Example description"),
			Tags: pulumi.StringArray{
				pulumi.String("tag-a"),
				pulumi.String("tag-b"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var example = new Elasticstack.KibanaSyntheticsParameter("example", new()
    {
        Key = "example_key",
        Value = "example_value",
        Description = "Example description",
        Tags = new[]
        {
            "tag-a",
            "tag-b",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSyntheticsParameter;
import com.pulumi.elasticstack.KibanaSyntheticsParameterArgs;
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 KibanaSyntheticsParameter("example", KibanaSyntheticsParameterArgs.builder()
            .key("example_key")
            .value("example_value")
            .description("Example description")
            .tags(            
                "tag-a",
                "tag-b")
            .build());

    }
}

    resources:
  example:
    type: elasticstack:KibanaSyntheticsParameter
    properties:
      key: example_key
      value: example_value
      description: Example description
      tags:
        - tag-a
        - tag-b

    Example coming soon!

    Create KibanaSyntheticsParameter Resource

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

    Constructor syntax

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

@overload
def KibanaSyntheticsParameter(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              key: Optional[str] = None,
                              value: Optional[str] = None,
                              description: Optional[str] = None,
                              kibana_connections: Optional[Sequence[KibanaSyntheticsParameterKibanaConnectionArgs]] = None,
                              share_across_spaces: Optional[bool] = None,
                              tags: Optional[Sequence[str]] = None)
    func NewKibanaSyntheticsParameter(ctx *Context, name string, args KibanaSyntheticsParameterArgs, opts ...ResourceOption) (*KibanaSyntheticsParameter, error)
    public KibanaSyntheticsParameter(string name, KibanaSyntheticsParameterArgs args, CustomResourceOptions? opts = null)
    public KibanaSyntheticsParameter(String name, KibanaSyntheticsParameterArgs args)
public KibanaSyntheticsParameter(String name, KibanaSyntheticsParameterArgs args, CustomResourceOptions options)

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


    resource "elasticstack_kibanasyntheticsparameter" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args KibanaSyntheticsParameterArgs
    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 KibanaSyntheticsParameterArgs
    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 KibanaSyntheticsParameterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KibanaSyntheticsParameterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KibanaSyntheticsParameterArgs
    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 kibanaSyntheticsParameterResource = new Elasticstack.KibanaSyntheticsParameter("kibanaSyntheticsParameterResource", new()
{
    Key = "string",
    Value = "string",
    Description = "string",
    KibanaConnections = new[]
    {
        new Elasticstack.Inputs.KibanaSyntheticsParameterKibanaConnectionArgs
        {
            ApiKey = "string",
            BearerToken = "string",
            CaCerts = new[]
            {
                "string",
            },
            Endpoints = new[]
            {
                "string",
            },
            Insecure = false,
            Password = "string",
            Username = "string",
        },
    },
    ShareAcrossSpaces = false,
    Tags = new[]
    {
        "string",
    },
});

    example, err := elasticstack.NewKibanaSyntheticsParameter(ctx, "kibanaSyntheticsParameterResource", &elasticstack.KibanaSyntheticsParameterArgs{
	Key:         pulumi.String("string"),
	Value:       pulumi.String("string"),
	Description: pulumi.String("string"),
	KibanaConnections: elasticstack.KibanaSyntheticsParameterKibanaConnectionArray{
		&elasticstack.KibanaSyntheticsParameterKibanaConnectionArgs{
			ApiKey:      pulumi.String("string"),
			BearerToken: pulumi.String("string"),
			CaCerts: pulumi.StringArray{
				pulumi.String("string"),
			},
			Endpoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			Insecure: pulumi.Bool(false),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
	},
	ShareAcrossSpaces: pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "elasticstack_kibanasyntheticsparameter" "kibanaSyntheticsParameterResource" {
  key         = "string"
  value       = "string"
  description = "string"
  kibana_connections {
    api_key      = "string"
    bearer_token = "string"
    ca_certs     = ["string"]
    endpoints    = ["string"]
    insecure     = false
    password     = "string"
    username     = "string"
  }
  share_across_spaces = false
  tags                = ["string"]
}

    var kibanaSyntheticsParameterResource = new KibanaSyntheticsParameter("kibanaSyntheticsParameterResource", KibanaSyntheticsParameterArgs.builder()
    .key("string")
    .value("string")
    .description("string")
    .kibanaConnections(KibanaSyntheticsParameterKibanaConnectionArgs.builder()
        .apiKey("string")
        .bearerToken("string")
        .caCerts("string")
        .endpoints("string")
        .insecure(false)
        .password("string")
        .username("string")
        .build())
    .shareAcrossSpaces(false)
    .tags("string")
    .build());

    kibana_synthetics_parameter_resource = elasticstack.KibanaSyntheticsParameter("kibanaSyntheticsParameterResource",
    key="string",
    value="string",
    description="string",
    kibana_connections=[{
        "api_key": "string",
        "bearer_token": "string",
        "ca_certs": ["string"],
        "endpoints": ["string"],
        "insecure": False,
        "password": "string",
        "username": "string",
    }],
    share_across_spaces=False,
    tags=["string"])

    const kibanaSyntheticsParameterResource = new elasticstack.KibanaSyntheticsParameter("kibanaSyntheticsParameterResource", {
    key: "string",
    value: "string",
    description: "string",
    kibanaConnections: [{
        apiKey: "string",
        bearerToken: "string",
        caCerts: ["string"],
        endpoints: ["string"],
        insecure: false,
        password: "string",
        username: "string",
    }],
    shareAcrossSpaces: false,
    tags: ["string"],
});

    type: elasticstack:KibanaSyntheticsParameter
properties:
    description: string
    key: string
    kibanaConnections:
        - apiKey: string
          bearerToken: string
          caCerts:
            - string
          endpoints:
            - string
          insecure: false
          password: string
          username: string
    shareAcrossSpaces: false
    tags:
        - string
    value: string

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

    Key string
    The key of the parameter.
    Value string
    The value associated with the parameter.
    Description string
    A description of the parameter.
    KibanaConnections List<KibanaSyntheticsParameterKibanaConnection>
    Kibana connection configuration block.
    ShareAcrossSpaces bool
    Whether the parameter should be shared across spaces.
    Tags List<string>
    An array of tags to categorize the parameter.
    Key string
    The key of the parameter.
    Value string
    The value associated with the parameter.
    Description string
    A description of the parameter.
    KibanaConnections []KibanaSyntheticsParameterKibanaConnectionArgs
    Kibana connection configuration block.
    ShareAcrossSpaces bool
    Whether the parameter should be shared across spaces.
    Tags []string
    An array of tags to categorize the parameter.
    key string
    The key of the parameter.
    value string
    The value associated with the parameter.
    description string
    A description of the parameter.
    kibana_connections list(object)
    Kibana connection configuration block.
    share_across_spaces bool
    Whether the parameter should be shared across spaces.
    tags list(string)
    An array of tags to categorize the parameter.
    key String
    The key of the parameter.
    value String
    The value associated with the parameter.
    description String
    A description of the parameter.
    kibanaConnections List<KibanaSyntheticsParameterKibanaConnection>
    Kibana connection configuration block.
    shareAcrossSpaces Boolean
    Whether the parameter should be shared across spaces.
    tags List<String>
    An array of tags to categorize the parameter.
    key string
    The key of the parameter.
    value string
    The value associated with the parameter.
    description string
    A description of the parameter.
    kibanaConnections KibanaSyntheticsParameterKibanaConnection[]
    Kibana connection configuration block.
    shareAcrossSpaces boolean
    Whether the parameter should be shared across spaces.
    tags string[]
    An array of tags to categorize the parameter.
    key str
    The key of the parameter.
    value str
    The value associated with the parameter.
    description str
    A description of the parameter.
    kibana_connections Sequence[KibanaSyntheticsParameterKibanaConnectionArgs]
    Kibana connection configuration block.
    share_across_spaces bool
    Whether the parameter should be shared across spaces.
    tags Sequence[str]
    An array of tags to categorize the parameter.
    key String
    The key of the parameter.
    value String
    The value associated with the parameter.
    description String
    A description of the parameter.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    shareAcrossSpaces Boolean
    Whether the parameter should be shared across spaces.
    tags List<String>
    An array of tags to categorize the parameter.

    Outputs

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

    Get an existing KibanaSyntheticsParameter 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?: KibanaSyntheticsParameterState, opts?: CustomResourceOptions): KibanaSyntheticsParameter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        key: Optional[str] = None,
        kibana_connections: Optional[Sequence[KibanaSyntheticsParameterKibanaConnectionArgs]] = None,
        share_across_spaces: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        value: Optional[str] = None) -> KibanaSyntheticsParameter
    func GetKibanaSyntheticsParameter(ctx *Context, name string, id IDInput, state *KibanaSyntheticsParameterState, opts ...ResourceOption) (*KibanaSyntheticsParameter, error)
    public static KibanaSyntheticsParameter Get(string name, Input<string> id, KibanaSyntheticsParameterState? state, CustomResourceOptions? opts = null)
    public static KibanaSyntheticsParameter get(String name, Output<String> id, KibanaSyntheticsParameterState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:KibanaSyntheticsParameter    get:      id: ${id}
    import {
  to = elasticstack_kibanasyntheticsparameter.example
  id = "${id}"
}
    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:
    Description string
    A description of the parameter.
    Key string
    The key of the parameter.
    KibanaConnections List<KibanaSyntheticsParameterKibanaConnection>
    Kibana connection configuration block.
    ShareAcrossSpaces bool
    Whether the parameter should be shared across spaces.
    Tags List<string>
    An array of tags to categorize the parameter.
    Value string
    The value associated with the parameter.
    Description string
    A description of the parameter.
    Key string
    The key of the parameter.
    KibanaConnections []KibanaSyntheticsParameterKibanaConnectionArgs
    Kibana connection configuration block.
    ShareAcrossSpaces bool
    Whether the parameter should be shared across spaces.
    Tags []string
    An array of tags to categorize the parameter.
    Value string
    The value associated with the parameter.
    description string
    A description of the parameter.
    key string
    The key of the parameter.
    kibana_connections list(object)
    Kibana connection configuration block.
    share_across_spaces bool
    Whether the parameter should be shared across spaces.
    tags list(string)
    An array of tags to categorize the parameter.
    value string
    The value associated with the parameter.
    description String
    A description of the parameter.
    key String
    The key of the parameter.
    kibanaConnections List<KibanaSyntheticsParameterKibanaConnection>
    Kibana connection configuration block.
    shareAcrossSpaces Boolean
    Whether the parameter should be shared across spaces.
    tags List<String>
    An array of tags to categorize the parameter.
    value String
    The value associated with the parameter.
    description string
    A description of the parameter.
    key string
    The key of the parameter.
    kibanaConnections KibanaSyntheticsParameterKibanaConnection[]
    Kibana connection configuration block.
    shareAcrossSpaces boolean
    Whether the parameter should be shared across spaces.
    tags string[]
    An array of tags to categorize the parameter.
    value string
    The value associated with the parameter.
    description str
    A description of the parameter.
    key str
    The key of the parameter.
    kibana_connections Sequence[KibanaSyntheticsParameterKibanaConnectionArgs]
    Kibana connection configuration block.
    share_across_spaces bool
    Whether the parameter should be shared across spaces.
    tags Sequence[str]
    An array of tags to categorize the parameter.
    value str
    The value associated with the parameter.
    description String
    A description of the parameter.
    key String
    The key of the parameter.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    shareAcrossSpaces Boolean
    Whether the parameter should be shared across spaces.
    tags List<String>
    An array of tags to categorize the parameter.
    value String
    The value associated with the parameter.

    Supporting Types

    KibanaSyntheticsParameterKibanaConnection, KibanaSyntheticsParameterKibanaConnectionArgs

    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts List<string>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints List<string>
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts []string
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints []string
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    api_key string
    API Key to use for authentication to Kibana
    bearer_token string
    Bearer Token to use for authentication to Kibana
    ca_certs list(string)
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints list(string)
    insecure bool
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.
    apiKey string
    API Key to use for authentication to Kibana
    bearerToken string
    Bearer Token to use for authentication to Kibana
    caCerts string[]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints string[]
    insecure boolean
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    api_key str
    API Key to use for authentication to Kibana
    bearer_token str
    Bearer Token to use for authentication to Kibana
    ca_certs Sequence[str]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints Sequence[str]
    insecure bool
    Disable TLS certificate validation
    password str
    Password to use for API authentication to Kibana.
    username str
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.

    Import

    The pulumi import command can be used, for example:

    $ pulumi import elasticstack:index/kibanaSyntheticsParameter:KibanaSyntheticsParameter my_param <space id>/<param_id>

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

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    Viewing docs for elasticstack 0.15.0
    published on Thursday, May 14, 2026 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack
      Try Pulumi Cloud free. Your team will thank you.