1. Packages
  2. Grafana Cloud
  3. API Docs
  4. SyntheticMonitoringInstallation
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

grafana.SyntheticMonitoringInstallation

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

    Sets up Synthetic Monitoring on a Grafana cloud stack and generates a token. Once a Grafana Cloud stack is created, a user can either use this resource or go into the UI to install synthetic monitoring. This resource cannot be imported but it can be used on an existing Synthetic Monitoring installation without issues.

    Note that this resource must be used on a provider configured with Grafana Cloud credentials.

    Required access policy scopes:

    • stacks:read

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as grafana from "@pulumi/grafana";
    import * as grafana from "@pulumiverse/grafana";
    
    const config = new pulumi.Config();
    const cloudAccessPolicyToken = config.requireObject("cloudAccessPolicyToken");
    const stackSlug = config.requireObject("stackSlug");
    const cloudRegion = config.get("cloudRegion") || "us";
    // Step 1: Create a stack
    const cloud = new grafana.Provider("cloud", {cloudAccessPolicyToken: cloudAccessPolicyToken});
    const smStackCloudStack = new grafana.CloudStack("smStackCloudStack", {
        slug: stackSlug,
        regionSlug: cloudRegion,
    }, {
        provider: grafana.cloud,
    });
    // Step 2: Install Synthetic Monitoring on the stack
    const smMetricsPublishCloudAccessPolicy = new grafana.CloudAccessPolicy("smMetricsPublishCloudAccessPolicy", {
        region: cloudRegion,
        scopes: [
            "metrics:write",
            "stacks:read",
        ],
        realms: [{
            type: "stack",
            identifier: smStackCloudStack.id,
        }],
    }, {
        provider: grafana.cloud,
    });
    const smMetricsPublishCloudAccessPolicyToken = new grafana.CloudAccessPolicyToken("smMetricsPublishCloudAccessPolicyToken", {
        region: cloudRegion,
        accessPolicyId: smMetricsPublishCloudAccessPolicy.policyId,
    }, {
        provider: grafana.cloud,
    });
    const smStackSyntheticMonitoringInstallation = new grafana.SyntheticMonitoringInstallation("smStackSyntheticMonitoringInstallation", {
        stackId: smStackCloudStack.id,
        metricsPublisherKey: smMetricsPublishCloudAccessPolicyToken.token,
    }, {
        provider: grafana.cloud,
    });
    // Step 3: Interact with Synthetic Monitoring
    const sm = new grafana.Provider("sm", {
        smAccessToken: smStackSyntheticMonitoringInstallation.smAccessToken,
        smUrl: smStackSyntheticMonitoringInstallation.stackSmApiUrl,
    });
    const main = grafana.getSyntheticMonitoringProbes({});
    
    import pulumi
    import pulumi_grafana as grafana
    import pulumiverse_grafana as grafana
    
    config = pulumi.Config()
    cloud_access_policy_token = config.require_object("cloudAccessPolicyToken")
    stack_slug = config.require_object("stackSlug")
    cloud_region = config.get("cloudRegion")
    if cloud_region is None:
        cloud_region = "us"
    # Step 1: Create a stack
    cloud = grafana.Provider("cloud", cloud_access_policy_token=cloud_access_policy_token)
    sm_stack_cloud_stack = grafana.CloudStack("smStackCloudStack",
        slug=stack_slug,
        region_slug=cloud_region,
        opts=pulumi.ResourceOptions(provider=grafana["cloud"]))
    # Step 2: Install Synthetic Monitoring on the stack
    sm_metrics_publish_cloud_access_policy = grafana.CloudAccessPolicy("smMetricsPublishCloudAccessPolicy",
        region=cloud_region,
        scopes=[
            "metrics:write",
            "stacks:read",
        ],
        realms=[grafana.CloudAccessPolicyRealmArgs(
            type="stack",
            identifier=sm_stack_cloud_stack.id,
        )],
        opts=pulumi.ResourceOptions(provider=grafana["cloud"]))
    sm_metrics_publish_cloud_access_policy_token = grafana.CloudAccessPolicyToken("smMetricsPublishCloudAccessPolicyToken",
        region=cloud_region,
        access_policy_id=sm_metrics_publish_cloud_access_policy.policy_id,
        opts=pulumi.ResourceOptions(provider=grafana["cloud"]))
    sm_stack_synthetic_monitoring_installation = grafana.SyntheticMonitoringInstallation("smStackSyntheticMonitoringInstallation",
        stack_id=sm_stack_cloud_stack.id,
        metrics_publisher_key=sm_metrics_publish_cloud_access_policy_token.token,
        opts=pulumi.ResourceOptions(provider=grafana["cloud"]))
    # Step 3: Interact with Synthetic Monitoring
    sm = grafana.Provider("sm",
        sm_access_token=sm_stack_synthetic_monitoring_installation.sm_access_token,
        sm_url=sm_stack_synthetic_monitoring_installation.stack_sm_api_url)
    main = grafana.get_synthetic_monitoring_probes()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		cloudAccessPolicyToken := cfg.RequireObject("cloudAccessPolicyToken")
    		stackSlug := cfg.RequireObject("stackSlug")
    		cloudRegion := "us"
    		if param := cfg.Get("cloudRegion"); param != "" {
    			cloudRegion = param
    		}
    		// Step 1: Create a stack
    		_, err := grafana.NewProvider(ctx, "cloud", &grafana.ProviderArgs{
    			CloudAccessPolicyToken: pulumi.Any(cloudAccessPolicyToken),
    		})
    		if err != nil {
    			return err
    		}
    		smStackCloudStack, err := grafana.NewCloudStack(ctx, "smStackCloudStack", &grafana.CloudStackArgs{
    			Slug:       pulumi.Any(stackSlug),
    			RegionSlug: pulumi.String(cloudRegion),
    		}, pulumi.Provider(grafana.Cloud))
    		if err != nil {
    			return err
    		}
    		// Step 2: Install Synthetic Monitoring on the stack
    		smMetricsPublishCloudAccessPolicy, err := grafana.NewCloudAccessPolicy(ctx, "smMetricsPublishCloudAccessPolicy", &grafana.CloudAccessPolicyArgs{
    			Region: pulumi.String(cloudRegion),
    			Scopes: pulumi.StringArray{
    				pulumi.String("metrics:write"),
    				pulumi.String("stacks:read"),
    			},
    			Realms: grafana.CloudAccessPolicyRealmArray{
    				&grafana.CloudAccessPolicyRealmArgs{
    					Type:       pulumi.String("stack"),
    					Identifier: smStackCloudStack.ID(),
    				},
    			},
    		}, pulumi.Provider(grafana.Cloud))
    		if err != nil {
    			return err
    		}
    		smMetricsPublishCloudAccessPolicyToken, err := grafana.NewCloudAccessPolicyToken(ctx, "smMetricsPublishCloudAccessPolicyToken", &grafana.CloudAccessPolicyTokenArgs{
    			Region:         pulumi.String(cloudRegion),
    			AccessPolicyId: smMetricsPublishCloudAccessPolicy.PolicyId,
    		}, pulumi.Provider(grafana.Cloud))
    		if err != nil {
    			return err
    		}
    		smStackSyntheticMonitoringInstallation, err := grafana.NewSyntheticMonitoringInstallation(ctx, "smStackSyntheticMonitoringInstallation", &grafana.SyntheticMonitoringInstallationArgs{
    			StackId:             smStackCloudStack.ID(),
    			MetricsPublisherKey: smMetricsPublishCloudAccessPolicyToken.Token,
    		}, pulumi.Provider(grafana.Cloud))
    		if err != nil {
    			return err
    		}
    		// Step 3: Interact with Synthetic Monitoring
    		_, err = grafana.NewProvider(ctx, "sm", &grafana.ProviderArgs{
    			SmAccessToken: smStackSyntheticMonitoringInstallation.SmAccessToken,
    			SmUrl:         smStackSyntheticMonitoringInstallation.StackSmApiUrl,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = grafana.GetSyntheticMonitoringProbes(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Grafana = Pulumi.Grafana;
    using Grafana = Pulumiverse.Grafana;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var cloudAccessPolicyToken = config.RequireObject<dynamic>("cloudAccessPolicyToken");
        var stackSlug = config.RequireObject<dynamic>("stackSlug");
        var cloudRegion = config.Get("cloudRegion") ?? "us";
        // Step 1: Create a stack
        var cloud = new Grafana.Provider("cloud", new()
        {
            CloudAccessPolicyToken = cloudAccessPolicyToken,
        });
    
        var smStackCloudStack = new Grafana.CloudStack("smStackCloudStack", new()
        {
            Slug = stackSlug,
            RegionSlug = cloudRegion,
        }, new CustomResourceOptions
        {
            Provider = grafana.Cloud,
        });
    
        // Step 2: Install Synthetic Monitoring on the stack
        var smMetricsPublishCloudAccessPolicy = new Grafana.CloudAccessPolicy("smMetricsPublishCloudAccessPolicy", new()
        {
            Region = cloudRegion,
            Scopes = new[]
            {
                "metrics:write",
                "stacks:read",
            },
            Realms = new[]
            {
                new Grafana.Inputs.CloudAccessPolicyRealmArgs
                {
                    Type = "stack",
                    Identifier = smStackCloudStack.Id,
                },
            },
        }, new CustomResourceOptions
        {
            Provider = grafana.Cloud,
        });
    
        var smMetricsPublishCloudAccessPolicyToken = new Grafana.CloudAccessPolicyToken("smMetricsPublishCloudAccessPolicyToken", new()
        {
            Region = cloudRegion,
            AccessPolicyId = smMetricsPublishCloudAccessPolicy.PolicyId,
        }, new CustomResourceOptions
        {
            Provider = grafana.Cloud,
        });
    
        var smStackSyntheticMonitoringInstallation = new Grafana.SyntheticMonitoringInstallation("smStackSyntheticMonitoringInstallation", new()
        {
            StackId = smStackCloudStack.Id,
            MetricsPublisherKey = smMetricsPublishCloudAccessPolicyToken.Token,
        }, new CustomResourceOptions
        {
            Provider = grafana.Cloud,
        });
    
        // Step 3: Interact with Synthetic Monitoring
        var sm = new Grafana.Provider("sm", new()
        {
            SmAccessToken = smStackSyntheticMonitoringInstallation.SmAccessToken,
            SmUrl = smStackSyntheticMonitoringInstallation.StackSmApiUrl,
        });
    
        var main = Grafana.GetSyntheticMonitoringProbes.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.grafana.Provider;
    import com.pulumi.grafana.ProviderArgs;
    import com.pulumi.grafana.CloudStack;
    import com.pulumi.grafana.CloudStackArgs;
    import com.pulumi.grafana.CloudAccessPolicy;
    import com.pulumi.grafana.CloudAccessPolicyArgs;
    import com.pulumi.grafana.inputs.CloudAccessPolicyRealmArgs;
    import com.pulumi.grafana.CloudAccessPolicyToken;
    import com.pulumi.grafana.CloudAccessPolicyTokenArgs;
    import com.pulumi.grafana.SyntheticMonitoringInstallation;
    import com.pulumi.grafana.SyntheticMonitoringInstallationArgs;
    import com.pulumi.grafana.GrafanaFunctions;
    import com.pulumi.grafana.inputs.GetSyntheticMonitoringProbesArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 config = ctx.config();
            final var cloudAccessPolicyToken = config.get("cloudAccessPolicyToken");
            final var stackSlug = config.get("stackSlug");
            final var cloudRegion = config.get("cloudRegion").orElse("us");
            // Step 1: Create a stack
            var cloud = new Provider("cloud", ProviderArgs.builder()        
                .cloudAccessPolicyToken(cloudAccessPolicyToken)
                .build());
    
            var smStackCloudStack = new CloudStack("smStackCloudStack", CloudStackArgs.builder()        
                .slug(stackSlug)
                .regionSlug(cloudRegion)
                .build(), CustomResourceOptions.builder()
                    .provider(grafana.cloud())
                    .build());
    
            // Step 2: Install Synthetic Monitoring on the stack
            var smMetricsPublishCloudAccessPolicy = new CloudAccessPolicy("smMetricsPublishCloudAccessPolicy", CloudAccessPolicyArgs.builder()        
                .region(cloudRegion)
                .scopes(            
                    "metrics:write",
                    "stacks:read")
                .realms(CloudAccessPolicyRealmArgs.builder()
                    .type("stack")
                    .identifier(smStackCloudStack.id())
                    .build())
                .build(), CustomResourceOptions.builder()
                    .provider(grafana.cloud())
                    .build());
    
            var smMetricsPublishCloudAccessPolicyToken = new CloudAccessPolicyToken("smMetricsPublishCloudAccessPolicyToken", CloudAccessPolicyTokenArgs.builder()        
                .region(cloudRegion)
                .accessPolicyId(smMetricsPublishCloudAccessPolicy.policyId())
                .build(), CustomResourceOptions.builder()
                    .provider(grafana.cloud())
                    .build());
    
            var smStackSyntheticMonitoringInstallation = new SyntheticMonitoringInstallation("smStackSyntheticMonitoringInstallation", SyntheticMonitoringInstallationArgs.builder()        
                .stackId(smStackCloudStack.id())
                .metricsPublisherKey(smMetricsPublishCloudAccessPolicyToken.token())
                .build(), CustomResourceOptions.builder()
                    .provider(grafana.cloud())
                    .build());
    
            // Step 3: Interact with Synthetic Monitoring
            var sm = new Provider("sm", ProviderArgs.builder()        
                .smAccessToken(smStackSyntheticMonitoringInstallation.smAccessToken())
                .smUrl(smStackSyntheticMonitoringInstallation.stackSmApiUrl())
                .build());
    
            final var main = GrafanaFunctions.getSyntheticMonitoringProbes();
    
        }
    }
    
    configuration:
      cloudAccessPolicyToken:
        type: dynamic
      stackSlug:
        type: dynamic
      cloudRegion:
        type: string
        default: us
    resources:
      # Step 1: Create a stack
      cloud:
        type: pulumi:providers:grafana
        properties:
          cloudAccessPolicyToken: ${cloudAccessPolicyToken}
      smStackCloudStack:
        type: grafana:CloudStack
        properties:
          slug: ${stackSlug}
          regionSlug: ${cloudRegion}
        options:
          provider: ${grafana.cloud}
      # Step 2: Install Synthetic Monitoring on the stack
      smMetricsPublishCloudAccessPolicy:
        type: grafana:CloudAccessPolicy
        properties:
          region: ${cloudRegion}
          scopes:
            - metrics:write
            - stacks:read
          realms:
            - type: stack
              identifier: ${smStackCloudStack.id}
        options:
          provider: ${grafana.cloud}
      smMetricsPublishCloudAccessPolicyToken:
        type: grafana:CloudAccessPolicyToken
        properties:
          region: ${cloudRegion}
          accessPolicyId: ${smMetricsPublishCloudAccessPolicy.policyId}
        options:
          provider: ${grafana.cloud}
      smStackSyntheticMonitoringInstallation:
        type: grafana:SyntheticMonitoringInstallation
        properties:
          stackId: ${smStackCloudStack.id}
          metricsPublisherKey: ${smMetricsPublishCloudAccessPolicyToken.token}
        options:
          provider: ${grafana.cloud}
      # Step 3: Interact with Synthetic Monitoring
      sm:
        type: pulumi:providers:grafana
        properties:
          smAccessToken: ${smStackSyntheticMonitoringInstallation.smAccessToken}
          smUrl: ${smStackSyntheticMonitoringInstallation.stackSmApiUrl}
    variables:
      main:
        fn::invoke:
          Function: grafana:getSyntheticMonitoringProbes
          Arguments: {}
    

    Create SyntheticMonitoringInstallation Resource

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

    Constructor syntax

    new SyntheticMonitoringInstallation(name: string, args: SyntheticMonitoringInstallationArgs, opts?: CustomResourceOptions);
    @overload
    def SyntheticMonitoringInstallation(resource_name: str,
                                        args: SyntheticMonitoringInstallationArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def SyntheticMonitoringInstallation(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        metrics_publisher_key: Optional[str] = None,
                                        stack_id: Optional[str] = None,
                                        stack_sm_api_url: Optional[str] = None)
    func NewSyntheticMonitoringInstallation(ctx *Context, name string, args SyntheticMonitoringInstallationArgs, opts ...ResourceOption) (*SyntheticMonitoringInstallation, error)
    public SyntheticMonitoringInstallation(string name, SyntheticMonitoringInstallationArgs args, CustomResourceOptions? opts = null)
    public SyntheticMonitoringInstallation(String name, SyntheticMonitoringInstallationArgs args)
    public SyntheticMonitoringInstallation(String name, SyntheticMonitoringInstallationArgs args, CustomResourceOptions options)
    
    type: grafana:SyntheticMonitoringInstallation
    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 SyntheticMonitoringInstallationArgs
    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 SyntheticMonitoringInstallationArgs
    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 SyntheticMonitoringInstallationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyntheticMonitoringInstallationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyntheticMonitoringInstallationArgs
    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 syntheticMonitoringInstallationResource = new Grafana.SyntheticMonitoringInstallation("syntheticMonitoringInstallationResource", new()
    {
        MetricsPublisherKey = "string",
        StackId = "string",
        StackSmApiUrl = "string",
    });
    
    example, err := grafana.NewSyntheticMonitoringInstallation(ctx, "syntheticMonitoringInstallationResource", &grafana.SyntheticMonitoringInstallationArgs{
    	MetricsPublisherKey: pulumi.String("string"),
    	StackId:             pulumi.String("string"),
    	StackSmApiUrl:       pulumi.String("string"),
    })
    
    var syntheticMonitoringInstallationResource = new SyntheticMonitoringInstallation("syntheticMonitoringInstallationResource", SyntheticMonitoringInstallationArgs.builder()
        .metricsPublisherKey("string")
        .stackId("string")
        .stackSmApiUrl("string")
        .build());
    
    synthetic_monitoring_installation_resource = grafana.SyntheticMonitoringInstallation("syntheticMonitoringInstallationResource",
        metrics_publisher_key="string",
        stack_id="string",
        stack_sm_api_url="string")
    
    const syntheticMonitoringInstallationResource = new grafana.SyntheticMonitoringInstallation("syntheticMonitoringInstallationResource", {
        metricsPublisherKey: "string",
        stackId: "string",
        stackSmApiUrl: "string",
    });
    
    type: grafana:SyntheticMonitoringInstallation
    properties:
        metricsPublisherKey: string
        stackId: string
        stackSmApiUrl: string
    

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

    MetricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    StackId string
    The ID or slug of the stack to install SM on.
    StackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    MetricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    StackId string
    The ID or slug of the stack to install SM on.
    StackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey String
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    stackId String
    The ID or slug of the stack to install SM on.
    stackSmApiUrl String
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    stackId string
    The ID or slug of the stack to install SM on.
    stackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metrics_publisher_key str
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    stack_id str
    The ID or slug of the stack to install SM on.
    stack_sm_api_url str
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey String
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    stackId String
    The ID or slug of the stack to install SM on.
    stackSmApiUrl String
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SmAccessToken string
    Generated token to access the SM API.
    Id string
    The provider-assigned unique ID for this managed resource.
    SmAccessToken string
    Generated token to access the SM API.
    id String
    The provider-assigned unique ID for this managed resource.
    smAccessToken String
    Generated token to access the SM API.
    id string
    The provider-assigned unique ID for this managed resource.
    smAccessToken string
    Generated token to access the SM API.
    id str
    The provider-assigned unique ID for this managed resource.
    sm_access_token str
    Generated token to access the SM API.
    id String
    The provider-assigned unique ID for this managed resource.
    smAccessToken String
    Generated token to access the SM API.

    Look up Existing SyntheticMonitoringInstallation Resource

    Get an existing SyntheticMonitoringInstallation 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?: SyntheticMonitoringInstallationState, opts?: CustomResourceOptions): SyntheticMonitoringInstallation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            metrics_publisher_key: Optional[str] = None,
            sm_access_token: Optional[str] = None,
            stack_id: Optional[str] = None,
            stack_sm_api_url: Optional[str] = None) -> SyntheticMonitoringInstallation
    func GetSyntheticMonitoringInstallation(ctx *Context, name string, id IDInput, state *SyntheticMonitoringInstallationState, opts ...ResourceOption) (*SyntheticMonitoringInstallation, error)
    public static SyntheticMonitoringInstallation Get(string name, Input<string> id, SyntheticMonitoringInstallationState? state, CustomResourceOptions? opts = null)
    public static SyntheticMonitoringInstallation get(String name, Output<String> id, SyntheticMonitoringInstallationState 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:
    MetricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    SmAccessToken string
    Generated token to access the SM API.
    StackId string
    The ID or slug of the stack to install SM on.
    StackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    MetricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    SmAccessToken string
    Generated token to access the SM API.
    StackId string
    The ID or slug of the stack to install SM on.
    StackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey String
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    smAccessToken String
    Generated token to access the SM API.
    stackId String
    The ID or slug of the stack to install SM on.
    stackSmApiUrl String
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey string
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    smAccessToken string
    Generated token to access the SM API.
    stackId string
    The ID or slug of the stack to install SM on.
    stackSmApiUrl string
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metrics_publisher_key str
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    sm_access_token str
    Generated token to access the SM API.
    stack_id str
    The ID or slug of the stack to install SM on.
    stack_sm_api_url str
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.
    metricsPublisherKey String
    The Grafana Cloud access policy with the following scopes: stacks:read, metrics:write, logs:write, traces:write. This is used to publish metrics and logs to Grafana Cloud stack.
    smAccessToken String
    Generated token to access the SM API.
    stackId String
    The ID or slug of the stack to install SM on.
    stackSmApiUrl String
    The URL of the SM API to install SM on. This depends on the stack region, find the list of API URLs here: https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/set-up/set-up-private-probes/#probe-api-server-url. A static mapping exists in the provider but it may not contain all the regions. If it does contain the stack's region, this field is computed automatically and readable.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse