SignalFx
DataLink
Manage SignalFx Data Links.
Example Usage
using Pulumi;
using SignalFx = Pulumi.SignalFx;
class MyStack : Stack
{
public MyStack()
{
// A global link to SignalFx dashboard.
var myDataLink = new SignalFx.DataLink("myDataLink", new SignalFx.DataLinkArgs
{
PropertyName = "pname",
PropertyValue = "pvalue",
TargetSignalfxDashboards =
{
new SignalFx.Inputs.DataLinkTargetSignalfxDashboardArgs
{
IsDefault = true,
Name = "sfx_dash",
DashboardGroupId = signalfx_dashboard_group.Mydashboardgroup0.Id,
DashboardId = signalfx_dashboard.Mydashboard0.Id,
},
},
});
// A dashboard-specific link to an external URL
var myDataLinkDash = new SignalFx.DataLink("myDataLinkDash", new SignalFx.DataLinkArgs
{
ContextDashboardId = signalfx_dashboard.Mydashboard0.Id,
PropertyName = "pname2",
PropertyValue = "pvalue",
TargetExternalUrls =
{
new SignalFx.Inputs.DataLinkTargetExternalUrlArgs
{
Name = "ex_url",
TimeFormat = "ISO8601",
Url = "https://www.example.com",
PropertyKeyMapping =
{
{ "foo", "bar" },
},
},
},
});
}
}
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v5/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDataLink(ctx, "myDataLink", &signalfx.DataLinkArgs{
PropertyName: pulumi.String("pname"),
PropertyValue: pulumi.String("pvalue"),
TargetSignalfxDashboards: DataLinkTargetSignalfxDashboardArray{
&DataLinkTargetSignalfxDashboardArgs{
IsDefault: pulumi.Bool(true),
Name: pulumi.String("sfx_dash"),
DashboardGroupId: pulumi.Any(signalfx_dashboard_group.Mydashboardgroup0.Id),
DashboardId: pulumi.Any(signalfx_dashboard.Mydashboard0.Id),
},
},
})
if err != nil {
return err
}
_, err = signalfx.NewDataLink(ctx, "myDataLinkDash", &signalfx.DataLinkArgs{
ContextDashboardId: pulumi.Any(signalfx_dashboard.Mydashboard0.Id),
PropertyName: pulumi.String("pname2"),
PropertyValue: pulumi.String("pvalue"),
TargetExternalUrls: DataLinkTargetExternalUrlArray{
&DataLinkTargetExternalUrlArgs{
Name: pulumi.String("ex_url"),
TimeFormat: pulumi.String("ISO8601"),
Url: pulumi.String("https://www.example.com"),
PropertyKeyMapping: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_signalfx as signalfx
# A global link to SignalFx dashboard.
my_data_link = signalfx.DataLink("myDataLink",
property_name="pname",
property_value="pvalue",
target_signalfx_dashboards=[signalfx.DataLinkTargetSignalfxDashboardArgs(
is_default=True,
name="sfx_dash",
dashboard_group_id=signalfx_dashboard_group["mydashboardgroup0"]["id"],
dashboard_id=signalfx_dashboard["mydashboard0"]["id"],
)])
# A dashboard-specific link to an external URL
my_data_link_dash = signalfx.DataLink("myDataLinkDash",
context_dashboard_id=signalfx_dashboard["mydashboard0"]["id"],
property_name="pname2",
property_value="pvalue",
target_external_urls=[signalfx.DataLinkTargetExternalUrlArgs(
name="ex_url",
time_format="ISO8601",
url="https://www.example.com",
property_key_mapping={
"foo": "bar",
},
)])
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
// A global link to SignalFx dashboard.
const myDataLink = new signalfx.DataLink("myDataLink", {
propertyName: "pname",
propertyValue: "pvalue",
targetSignalfxDashboards: [{
isDefault: true,
name: "sfx_dash",
dashboardGroupId: signalfx_dashboard_group.mydashboardgroup0.id,
dashboardId: signalfx_dashboard.mydashboard0.id,
}],
});
// A dashboard-specific link to an external URL
const myDataLinkDash = new signalfx.DataLink("myDataLinkDash", {
contextDashboardId: signalfx_dashboard.mydashboard0.id,
propertyName: "pname2",
propertyValue: "pvalue",
targetExternalUrls: [{
name: "ex_url",
timeFormat: "ISO8601",
url: "https://www.example.com",
propertyKeyMapping: {
foo: "bar",
},
}],
});
Coming soon!
Create a DataLink Resource
new DataLink(name: string, args?: DataLinkArgs, opts?: CustomResourceOptions);
@overload
def DataLink(resource_name: str,
opts: Optional[ResourceOptions] = None,
context_dashboard_id: Optional[str] = None,
property_name: Optional[str] = None,
property_value: Optional[str] = None,
target_external_urls: Optional[Sequence[DataLinkTargetExternalUrlArgs]] = None,
target_signalfx_dashboards: Optional[Sequence[DataLinkTargetSignalfxDashboardArgs]] = None,
target_splunks: Optional[Sequence[DataLinkTargetSplunkArgs]] = None)
@overload
def DataLink(resource_name: str,
args: Optional[DataLinkArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewDataLink(ctx *Context, name string, args *DataLinkArgs, opts ...ResourceOption) (*DataLink, error)
public DataLink(string name, DataLinkArgs? args = null, CustomResourceOptions? opts = null)
public DataLink(String name, DataLinkArgs args)
public DataLink(String name, DataLinkArgs args, CustomResourceOptions options)
type: signalfx:DataLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataLinkArgs
- 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 DataLinkArgs
- 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 DataLinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataLinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataLinkArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DataLink 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 DataLink resource accepts the following input properties:
- Context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- Property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- Property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- Target
External List<Pulumi.Urls Signal Fx. Inputs. Data Link Target External Url Args> Link to an external URL
- Target
Signalfx List<Pulumi.Dashboards Signal Fx. Inputs. Data Link Target Signalfx Dashboard Args> Link to a SignalFx dashboard
- Target
Splunks List<Pulumi.Signal Fx. Inputs. Data Link Target Splunk Args> Link to an external URL
- Context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- Property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- Property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- Target
External []DataUrls Link Target External Url Args Link to an external URL
- Target
Signalfx []DataDashboards Link Target Signalfx Dashboard Args Link to a SignalFx dashboard
- Target
Splunks []DataLink Target Splunk Args Link to an external URL
- context
Dashboard StringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name String Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value String Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External ListLinkUrls Target External Url Args> Link to an external URL
- target
Signalfx ListLinkDashboards Target Signalfx Dashboard Args> Link to a SignalFx dashboard
- target
Splunks ListLinkTarget Splunk Args> Link to an external URL
- context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External DataUrls Link Target External Url Args[] Link to an external URL
- target
Signalfx DataDashboards Link Target Signalfx Dashboard Args[] Link to a SignalFx dashboard
- target
Splunks DataLink Target Splunk Args[] Link to an external URL
- context_
dashboard_ strid If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property_
name str Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property_
value str Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target_
external_ Sequence[Dataurls Link Target External Url Args] Link to an external URL
- target_
signalfx_ Sequence[Datadashboards Link Target Signalfx Dashboard Args] Link to a SignalFx dashboard
- target_
splunks Sequence[DataLink Target Splunk Args] Link to an external URL
- context
Dashboard StringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name String Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value String Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External ListUrls Link to an external URL
- target
Signalfx ListDashboards Link to a SignalFx dashboard
- target
Splunks List Link to an external URL
Outputs
All input properties are implicitly available as output properties. Additionally, the DataLink 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 an Existing DataLink Resource
Get an existing DataLink 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?: DataLinkState, opts?: CustomResourceOptions): DataLink
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
context_dashboard_id: Optional[str] = None,
property_name: Optional[str] = None,
property_value: Optional[str] = None,
target_external_urls: Optional[Sequence[DataLinkTargetExternalUrlArgs]] = None,
target_signalfx_dashboards: Optional[Sequence[DataLinkTargetSignalfxDashboardArgs]] = None,
target_splunks: Optional[Sequence[DataLinkTargetSplunkArgs]] = None) -> DataLink
func GetDataLink(ctx *Context, name string, id IDInput, state *DataLinkState, opts ...ResourceOption) (*DataLink, error)
public static DataLink Get(string name, Input<string> id, DataLinkState? state, CustomResourceOptions? opts = null)
public static DataLink get(String name, Output<String> id, DataLinkState 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.
- Context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- Property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- Property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- Target
External List<Pulumi.Urls Signal Fx. Inputs. Data Link Target External Url Args> Link to an external URL
- Target
Signalfx List<Pulumi.Dashboards Signal Fx. Inputs. Data Link Target Signalfx Dashboard Args> Link to a SignalFx dashboard
- Target
Splunks List<Pulumi.Signal Fx. Inputs. Data Link Target Splunk Args> Link to an external URL
- Context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- Property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- Property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- Target
External []DataUrls Link Target External Url Args Link to an external URL
- Target
Signalfx []DataDashboards Link Target Signalfx Dashboard Args Link to a SignalFx dashboard
- Target
Splunks []DataLink Target Splunk Args Link to an external URL
- context
Dashboard StringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name String Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value String Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External ListLinkUrls Target External Url Args> Link to an external URL
- target
Signalfx ListLinkDashboards Target Signalfx Dashboard Args> Link to a SignalFx dashboard
- target
Splunks ListLinkTarget Splunk Args> Link to an external URL
- context
Dashboard stringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name string Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value string Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External DataUrls Link Target External Url Args[] Link to an external URL
- target
Signalfx DataDashboards Link Target Signalfx Dashboard Args[] Link to a SignalFx dashboard
- target
Splunks DataLink Target Splunk Args[] Link to an external URL
- context_
dashboard_ strid If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property_
name str Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property_
value str Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target_
external_ Sequence[Dataurls Link Target External Url Args] Link to an external URL
- target_
signalfx_ Sequence[Datadashboards Link Target Signalfx Dashboard Args] Link to a SignalFx dashboard
- target_
splunks Sequence[DataLink Target Splunk Args] Link to an external URL
- context
Dashboard StringId If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
- property
Name String Name (key) of the metadata that's the trigger of a data link. If you specify
property_value
, you must specifyproperty_name
.- property
Value String Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
property_name
.- target
External ListUrls Link to an external URL
- target
Signalfx ListDashboards Link to a SignalFx dashboard
- target
Splunks List Link to an external URL
Supporting Types
DataLinkTargetExternalUrl
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Url string
URL string for a Splunk instance or external system data link target. See the supported template variables.
- Minimum
Time stringWindow The minimum time window for a search sent to an external site. Defaults to
6000
- Property
Key Dictionary<string, string>Mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- Time
Format string Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Url string
URL string for a Splunk instance or external system data link target. See the supported template variables.
- Minimum
Time stringWindow The minimum time window for a search sent to an external site. Defaults to
6000
- Property
Key map[string]stringMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- Time
Format string Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- url String
URL string for a Splunk instance or external system data link target. See the supported template variables.
- minimum
Time StringWindow The minimum time window for a search sent to an external site. Defaults to
6000
- property
Key MapMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- time
Format String Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
- name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- url string
URL string for a Splunk instance or external system data link target. See the supported template variables.
- minimum
Time stringWindow The minimum time window for a search sent to an external site. Defaults to
6000
- property
Key {[key: string]: string}Mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- time
Format string Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
- name str
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- url str
URL string for a Splunk instance or external system data link target. See the supported template variables.
- minimum_
time_ strwindow The minimum time window for a search sent to an external site. Defaults to
6000
- property_
key_ Mapping[str, str]mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- time_
format str Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- url String
URL string for a Splunk instance or external system data link target. See the supported template variables.
- minimum
Time StringWindow The minimum time window for a search sent to an external site. Defaults to
6000
- property
Key MapMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- time
Format String Designates the format of
minimum_time_window
in the same data link target object. Must be one of"ISO8601"
,"EpochSeconds"
or"Epoch"
(which is milliseconds). Defaults to"ISO8601"
.
DataLinkTargetSignalfxDashboard
- Dashboard
Group stringId SignalFx-assigned ID of the dashboard link target's dashboard group
- Dashboard
Id string SignalFx-assigned ID of the dashboard link target
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Is
Default bool Flag that designates a target as the default for a data link object.
true
by default
- Dashboard
Group stringId SignalFx-assigned ID of the dashboard link target's dashboard group
- Dashboard
Id string SignalFx-assigned ID of the dashboard link target
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Is
Default bool Flag that designates a target as the default for a data link object.
true
by default
- dashboard
Group StringId SignalFx-assigned ID of the dashboard link target's dashboard group
- dashboard
Id String SignalFx-assigned ID of the dashboard link target
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- is
Default Boolean Flag that designates a target as the default for a data link object.
true
by default
- dashboard
Group stringId SignalFx-assigned ID of the dashboard link target's dashboard group
- dashboard
Id string SignalFx-assigned ID of the dashboard link target
- name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- is
Default boolean Flag that designates a target as the default for a data link object.
true
by default
- dashboard_
group_ strid SignalFx-assigned ID of the dashboard link target's dashboard group
- dashboard_
id str SignalFx-assigned ID of the dashboard link target
- name str
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- is_
default bool Flag that designates a target as the default for a data link object.
true
by default
- dashboard
Group StringId SignalFx-assigned ID of the dashboard link target's dashboard group
- dashboard
Id String SignalFx-assigned ID of the dashboard link target
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- is
Default Boolean Flag that designates a target as the default for a data link object.
true
by default
DataLinkTargetSplunk
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Property
Key Dictionary<string, string>Mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- Name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- Property
Key map[string]stringMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- property
Key MapMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- name string
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- property
Key {[key: string]: string}Mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- name str
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- property_
key_ Mapping[str, str]mapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
- name String
User-assigned target name. Use this value to differentiate between the link targets for a data link object.
- property
Key MapMapping Describes the relationship between SignalFx metadata keys and external system properties when the key names are different.
Package Details
- Repository
- https://github.com/pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
signalfx
Terraform Provider.