@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
168 lines (167 loc) • 6.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Manage Splunk Observability Cloud [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* // A global link to Splunk Observability Cloud dashboard.
* const myDataLink = new signalfx.DataLink("my_data_link", {
* propertyName: "pname",
* propertyValue: "pvalue",
* targetSignalfxDashboards: [{
* isDefault: true,
* name: "sfx_dash",
* dashboardGroupId: mydashboardgroup0.id,
* dashboardId: mydashboard0.id,
* }],
* });
* // A dashboard-specific link to an external URL
* const myDataLinkDash = new signalfx.DataLink("my_data_link_dash", {
* contextDashboardId: mydashboard0.id,
* propertyName: "pname2",
* propertyValue: "pvalue",
* targetExternalUrls: [{
* name: "ex_url",
* timeFormat: "ISO8601",
* url: "https://www.example.com",
* propertyKeyMapping: {
* foo: "bar",
* },
* }],
* });
* // A link to an AppDynamics Service
* const myDataLinkAppd = new signalfx.DataLink("my_data_link_appd", {
* propertyName: "pname3",
* propertyValue: "pvalue",
* targetAppdUrls: [{
* name: "appd_url",
* url: "https://www.example.saas.appdynamics.com/#/application=1234&component=5678",
* }],
* });
* ```
*/
export declare class DataLink extends pulumi.CustomResource {
/**
* Get an existing DataLink resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DataLinkState, opts?: pulumi.CustomResourceOptions): DataLink;
/**
* Returns true if the given object is an instance of DataLink. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is DataLink;
/**
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
*/
readonly contextDashboardId: pulumi.Output<string | undefined>;
/**
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
*/
readonly propertyName: pulumi.Output<string | undefined>;
/**
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
*/
readonly propertyValue: pulumi.Output<string | undefined>;
/**
* Link to an AppDynamics URL
*/
readonly targetAppdUrls: pulumi.Output<outputs.DataLinkTargetAppdUrl[] | undefined>;
/**
* Link to an external URL
*/
readonly targetExternalUrls: pulumi.Output<outputs.DataLinkTargetExternalUrl[] | undefined>;
/**
* Link to a Splunk Observability Cloud dashboard
*/
readonly targetSignalfxDashboards: pulumi.Output<outputs.DataLinkTargetSignalfxDashboard[] | undefined>;
/**
* Link to an external URL
*/
readonly targetSplunks: pulumi.Output<outputs.DataLinkTargetSplunk[] | undefined>;
/**
* Create a DataLink resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: DataLinkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DataLink resources.
*/
export interface DataLinkState {
/**
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
*/
contextDashboardId?: pulumi.Input<string>;
/**
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
*/
propertyName?: pulumi.Input<string>;
/**
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
*/
propertyValue?: pulumi.Input<string>;
/**
* Link to an AppDynamics URL
*/
targetAppdUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetAppdUrl>[]>;
/**
* Link to an external URL
*/
targetExternalUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetExternalUrl>[]>;
/**
* Link to a Splunk Observability Cloud dashboard
*/
targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
/**
* Link to an external URL
*/
targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
}
/**
* The set of arguments for constructing a DataLink resource.
*/
export interface DataLinkArgs {
/**
* If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
*/
contextDashboardId?: pulumi.Input<string>;
/**
* Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
*/
propertyName?: pulumi.Input<string>;
/**
* Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
*/
propertyValue?: pulumi.Input<string>;
/**
* Link to an AppDynamics URL
*/
targetAppdUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetAppdUrl>[]>;
/**
* Link to an external URL
*/
targetExternalUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetExternalUrl>[]>;
/**
* Link to a Splunk Observability Cloud dashboard
*/
targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
/**
* Link to an external URL
*/
targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
}