1. Packages
  2. Grafana Cloud
  3. API Docs
  4. SyntheticMonitoringInstallation
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse

grafana.SyntheticMonitoringInstallation

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse

    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.

    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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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/monitor-public-endpoints/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.4.2 published on Monday, Apr 15, 2024 by pulumiverse