1. Packages
  2. Wavefront Provider
  3. API Docs
  4. ExternalLink
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi

wavefront.ExternalLink

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi

    Provides a Wavefront External Link Resource. This allows external links to be created, updated, and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as wavefront from "@pulumi/wavefront";
    
    const basic = new wavefront.ExternalLink("basic", {
        name: "External Link",
        description: "An external link description",
        template: "https://example.com/source={{{source}}}&startTime={{startEpochMillis}}",
    });
    
    import pulumi
    import pulumi_wavefront as wavefront
    
    basic = wavefront.ExternalLink("basic",
        name="External Link",
        description="An external link description",
        template="https://example.com/source={{{source}}}&startTime={{startEpochMillis}}")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := wavefront.NewExternalLink(ctx, "basic", &wavefront.ExternalLinkArgs{
    			Name:        pulumi.String("External Link"),
    			Description: pulumi.String("An external link description"),
    			Template:    pulumi.String("https://example.com/source={{{source}}}&startTime={{startEpochMillis}}"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Wavefront = Pulumi.Wavefront;
    
    return await Deployment.RunAsync(() => 
    {
        var basic = new Wavefront.ExternalLink("basic", new()
        {
            Name = "External Link",
            Description = "An external link description",
            Template = "https://example.com/source={{{source}}}&startTime={{startEpochMillis}}",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.wavefront.ExternalLink;
    import com.pulumi.wavefront.ExternalLinkArgs;
    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 basic = new ExternalLink("basic", ExternalLinkArgs.builder()
                .name("External Link")
                .description("An external link description")
                .template("https://example.com/source={{{source}}}&startTime={{startEpochMillis}}")
                .build());
    
        }
    }
    
    resources:
      basic:
        type: wavefront:ExternalLink
        properties:
          name: External Link
          description: An external link description
          template: https://example.com/source={{{source}}}&startTime={{startEpochMillis}}
    

    Create ExternalLink Resource

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

    Constructor syntax

    new ExternalLink(name: string, args: ExternalLinkArgs, opts?: CustomResourceOptions);
    @overload
    def ExternalLink(resource_name: str,
                     args: ExternalLinkArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ExternalLink(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     template: Optional[str] = None,
                     is_log_integration: Optional[bool] = None,
                     metric_filter_regex: Optional[str] = None,
                     name: Optional[str] = None,
                     point_tag_filter_regexes: Optional[Mapping[str, str]] = None,
                     source_filter_regex: Optional[str] = None)
    func NewExternalLink(ctx *Context, name string, args ExternalLinkArgs, opts ...ResourceOption) (*ExternalLink, error)
    public ExternalLink(string name, ExternalLinkArgs args, CustomResourceOptions? opts = null)
    public ExternalLink(String name, ExternalLinkArgs args)
    public ExternalLink(String name, ExternalLinkArgs args, CustomResourceOptions options)
    
    type: wavefront:ExternalLink
    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 ExternalLinkArgs
    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 ExternalLinkArgs
    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 ExternalLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExternalLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExternalLinkArgs
    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 externalLinkResource = new Wavefront.ExternalLink("externalLinkResource", new()
    {
        Description = "string",
        Template = "string",
        IsLogIntegration = false,
        MetricFilterRegex = "string",
        Name = "string",
        PointTagFilterRegexes = 
        {
            { "string", "string" },
        },
        SourceFilterRegex = "string",
    });
    
    example, err := wavefront.NewExternalLink(ctx, "externalLinkResource", &wavefront.ExternalLinkArgs{
    	Description:       pulumi.String("string"),
    	Template:          pulumi.String("string"),
    	IsLogIntegration:  pulumi.Bool(false),
    	MetricFilterRegex: pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	PointTagFilterRegexes: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	SourceFilterRegex: pulumi.String("string"),
    })
    
    var externalLinkResource = new ExternalLink("externalLinkResource", ExternalLinkArgs.builder()
        .description("string")
        .template("string")
        .isLogIntegration(false)
        .metricFilterRegex("string")
        .name("string")
        .pointTagFilterRegexes(Map.of("string", "string"))
        .sourceFilterRegex("string")
        .build());
    
    external_link_resource = wavefront.ExternalLink("externalLinkResource",
        description="string",
        template="string",
        is_log_integration=False,
        metric_filter_regex="string",
        name="string",
        point_tag_filter_regexes={
            "string": "string",
        },
        source_filter_regex="string")
    
    const externalLinkResource = new wavefront.ExternalLink("externalLinkResource", {
        description: "string",
        template: "string",
        isLogIntegration: false,
        metricFilterRegex: "string",
        name: "string",
        pointTagFilterRegexes: {
            string: "string",
        },
        sourceFilterRegex: "string",
    });
    
    type: wavefront:ExternalLink
    properties:
        description: string
        isLogIntegration: false
        metricFilterRegex: string
        name: string
        pointTagFilterRegexes:
            string: string
        sourceFilterRegex: string
        template: string
    

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

    Description string
    Human-readable description for this link.
    Template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    IsLogIntegration bool
    Whether this is a "Log Integration" subType of external link.
    MetricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    Name string
    The name of the external link.
    PointTagFilterRegexes Dictionary<string, string>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    SourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    Description string
    Human-readable description for this link.
    Template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    IsLogIntegration bool
    Whether this is a "Log Integration" subType of external link.
    MetricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    Name string
    The name of the external link.
    PointTagFilterRegexes map[string]string
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    SourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    description String
    Human-readable description for this link.
    template String
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    isLogIntegration Boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name String
    The name of the external link.
    pointTagFilterRegexes Map<String,String>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    description string
    Human-readable description for this link.
    template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    isLogIntegration boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name string
    The name of the external link.
    pointTagFilterRegexes {[key: string]: string}
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    description str
    Human-readable description for this link.
    template str
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    is_log_integration bool
    Whether this is a "Log Integration" subType of external link.
    metric_filter_regex str
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name str
    The name of the external link.
    point_tag_filter_regexes Mapping[str, str]
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    source_filter_regex str
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    description String
    Human-readable description for this link.
    template String
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    isLogIntegration Boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name String
    The name of the external link.
    pointTagFilterRegexes Map<String>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ExternalLink Resource

    Get an existing ExternalLink 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?: ExternalLinkState, opts?: CustomResourceOptions): ExternalLink
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            is_log_integration: Optional[bool] = None,
            metric_filter_regex: Optional[str] = None,
            name: Optional[str] = None,
            point_tag_filter_regexes: Optional[Mapping[str, str]] = None,
            source_filter_regex: Optional[str] = None,
            template: Optional[str] = None) -> ExternalLink
    func GetExternalLink(ctx *Context, name string, id IDInput, state *ExternalLinkState, opts ...ResourceOption) (*ExternalLink, error)
    public static ExternalLink Get(string name, Input<string> id, ExternalLinkState? state, CustomResourceOptions? opts = null)
    public static ExternalLink get(String name, Output<String> id, ExternalLinkState 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:
    Description string
    Human-readable description for this link.
    IsLogIntegration bool
    Whether this is a "Log Integration" subType of external link.
    MetricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    Name string
    The name of the external link.
    PointTagFilterRegexes Dictionary<string, string>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    SourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    Template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    Description string
    Human-readable description for this link.
    IsLogIntegration bool
    Whether this is a "Log Integration" subType of external link.
    MetricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    Name string
    The name of the external link.
    PointTagFilterRegexes map[string]string
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    SourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    Template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    description String
    Human-readable description for this link.
    isLogIntegration Boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name String
    The name of the external link.
    pointTagFilterRegexes Map<String,String>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    template String
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    description string
    Human-readable description for this link.
    isLogIntegration boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name string
    The name of the external link.
    pointTagFilterRegexes {[key: string]: string}
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex string
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    template string
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    description str
    Human-readable description for this link.
    is_log_integration bool
    Whether this is a "Log Integration" subType of external link.
    metric_filter_regex str
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name str
    The name of the external link.
    point_tag_filter_regexes Mapping[str, str]
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    source_filter_regex str
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    template str
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.
    description String
    Human-readable description for this link.
    isLogIntegration Boolean
    Whether this is a "Log Integration" subType of external link.
    metricFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the metric name of the highlighted series must match this regular expression in order for the link to be displayed.
    name String
    The name of the external link.
    pointTagFilterRegexes Map<String>
    Controls whether a link is displayed in the context menu of a highlighted series. This is a map from string to regular expression. The highlighted series must contain point tags whose keys are present in the keys of this map and whose values match the regular expressions associated with those keys in order for the link to be displayed.
    sourceFilterRegex String
    Controls whether a link is displayed in the context menu of a highlighted series. If present, the source name of the highlighted series must match this regular expression in order for the link to be displayed.
    template String
    The mustache template for this link. The template must expand to a full URL, including scheme, origin, etc.

    Import

    Maintenance windows can be imported by using the id, e.g.:

    $ pulumi import wavefront:index/externalLink:ExternalLink basic fVj6fz6zYC4aBkID
    

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

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi