@pulumi/signalfx 7.0.0 → 7.0.2

package/dataLink.d.ts

@@ -2,15 +2,15 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "./types/input";
 import * as outputs from "./types/output";
 /**
- * Manage SignalFx [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
+ * Manage Splunk Observability Cloud [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
  *
- * ## Example Usage
+ * ## Example
  *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as signalfx from "@pulumi/signalfx";
  *
- * // A global link to SignalFx dashboard.
+ * // A global link to Splunk Observability Cloud dashboard.
  * const myDataLink = new signalfx.DataLink("myDataLink", {
  *     propertyName: "pname",
  *     propertyValue: "pvalue",
@@ -36,6 +36,34 @@ import * as outputs from "./types/output";
  *     }],
  * });
  * ```
+ *
+ * ## Arguments
+ *
+ * The following arguments are supported in the resource block:
+ *
+ * * `propertyName` - (Optional) Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
+ * * `propertyValue` - (Optional) Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
+ * * `contextDashboardId` - (Optional) If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
+ * * `targetExternalUrl` - (Optional) Link to an external URL
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `url`- (Required) URL string for a Splunk instance or external system data link target. [See the supported template variables](https://dev.splunk.com/observability/docs/administration/datalinks/).
+ *   * `timeFormat` - (Optional) [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimumTimeWindow` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
+ *   * `minimumTimeWindow` - (Optional) The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
+ *   * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
+ * * `targetSignalfxDashboard` - (Optional) Link to a Splunk Observability Cloud dashboard
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `isDefault` - (Optional) Flag that designates a target as the default for a data link object. `true` by default
+ *   * `dashboardId` - (Required) SignalFx-assigned ID of the dashboard link target
+ *   * `dashboardGroupId` - (Required) SignalFx-assigned ID of the dashboard link target's dashboard group
+ * * `targetSplunk` - (Optional) Link to an external URL
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
+ *
+ * ## Attributes
+ *
+ * In a addition to all arguments above, the following attributes are exported:
+ *
+ * * `id` - The ID of the link.
  */
 export declare class DataLink extends pulumi.CustomResource {
     /**
@@ -54,15 +82,17 @@ export declare class DataLink extends pulumi.CustomResource {
      */
     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.
+     * The dashobard ID to which this data link will be applied
      */
     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`.
+     * Name (key) of the metadata that's the trigger of a data link. If you specify `property_value`, you must specify
+     * `property_name`.
      */
     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`.
+     * Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
+     * `property_name`.
      */
     readonly propertyValue: pulumi.Output<string | undefined>;
     /**
@@ -70,11 +100,11 @@ export declare class DataLink extends pulumi.CustomResource {
      */
     readonly targetExternalUrls: pulumi.Output<outputs.DataLinkTargetExternalUrl[] | undefined>;
     /**
-     * Link to a SignalFx dashboard
+     * Link to a Splunk Observability Cloud dashboard
      */
     readonly targetSignalfxDashboards: pulumi.Output<outputs.DataLinkTargetSignalfxDashboard[] | undefined>;
     /**
-     * Link to an external URL
+     * Link to a Splunk instance
      */
     readonly targetSplunks: pulumi.Output<outputs.DataLinkTargetSplunk[] | undefined>;
     /**
@@ -91,15 +121,17 @@ export declare class DataLink extends pulumi.CustomResource {
  */
 export interface DataLinkState {
     /**
-     * If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
+     * The dashobard ID to which this data link will be applied
      */
     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`.
+     * Name (key) of the metadata that's the trigger of a data link. If you specify `property_value`, you must specify
+     * `property_name`.
      */
     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`.
+     * Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
+     * `property_name`.
      */
     propertyValue?: pulumi.Input<string>;
     /**
@@ -107,11 +139,11 @@ export interface DataLinkState {
      */
     targetExternalUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetExternalUrl>[]>;
     /**
-     * Link to a SignalFx dashboard
+     * Link to a Splunk Observability Cloud dashboard
      */
     targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
     /**
-     * Link to an external URL
+     * Link to a Splunk instance
      */
     targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
 }
@@ -120,15 +152,17 @@ export interface DataLinkState {
  */
 export interface DataLinkArgs {
     /**
-     * If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
+     * The dashobard ID to which this data link will be applied
      */
     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`.
+     * Name (key) of the metadata that's the trigger of a data link. If you specify `property_value`, you must specify
+     * `property_name`.
      */
     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`.
+     * Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify
+     * `property_name`.
      */
     propertyValue?: pulumi.Input<string>;
     /**
@@ -136,11 +170,11 @@ export interface DataLinkArgs {
      */
     targetExternalUrls?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetExternalUrl>[]>;
     /**
-     * Link to a SignalFx dashboard
+     * Link to a Splunk Observability Cloud dashboard
      */
     targetSignalfxDashboards?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSignalfxDashboard>[]>;
     /**
-     * Link to an external URL
+     * Link to a Splunk instance
      */
     targetSplunks?: pulumi.Input<pulumi.Input<inputs.DataLinkTargetSplunk>[]>;
 }

package/dataLink.js

@@ -6,15 +6,15 @@ exports.DataLink = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("./utilities");
 /**
- * Manage SignalFx [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
+ * Manage Splunk Observability Cloud [Data Links](https://docs.signalfx.com/en/latest/managing/data-links.html).
  *
- * ## Example Usage
+ * ## Example
  *
  * ```typescript
  * import * as pulumi from "@pulumi/pulumi";
  * import * as signalfx from "@pulumi/signalfx";
  *
- * // A global link to SignalFx dashboard.
+ * // A global link to Splunk Observability Cloud dashboard.
  * const myDataLink = new signalfx.DataLink("myDataLink", {
  *     propertyName: "pname",
  *     propertyValue: "pvalue",
@@ -40,6 +40,34 @@ const utilities = require("./utilities");
  *     }],
  * });
  * ```
+ *
+ * ## Arguments
+ *
+ * The following arguments are supported in the resource block:
+ *
+ * * `propertyName` - (Optional) Name (key) of the metadata that's the trigger of a data link. If you specify `propertyValue`, you must specify `propertyName`.
+ * * `propertyValue` - (Optional) Value of the metadata that's the trigger of a data link. If you specify this property, you must also specify `propertyName`.
+ * * `contextDashboardId` - (Optional) If provided, scopes this data link to the supplied dashboard id. If omitted then the link will be global.
+ * * `targetExternalUrl` - (Optional) Link to an external URL
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `url`- (Required) URL string for a Splunk instance or external system data link target. [See the supported template variables](https://dev.splunk.com/observability/docs/administration/datalinks/).
+ *   * `timeFormat` - (Optional) [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimumTimeWindow` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
+ *   * `minimumTimeWindow` - (Optional) The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
+ *   * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
+ * * `targetSignalfxDashboard` - (Optional) Link to a Splunk Observability Cloud dashboard
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `isDefault` - (Optional) Flag that designates a target as the default for a data link object. `true` by default
+ *   * `dashboardId` - (Required) SignalFx-assigned ID of the dashboard link target
+ *   * `dashboardGroupId` - (Required) SignalFx-assigned ID of the dashboard link target's dashboard group
+ * * `targetSplunk` - (Optional) Link to an external URL
+ *   * `name` (Required) User-assigned target name. Use this value to differentiate between the link targets for a data link object.
+ *   * `propertyKeyMapping` - Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
+ *
+ * ## Attributes
+ *
+ * In a addition to all arguments above, the following attributes are exported:
+ *
+ * * `id` - The ID of the link.
  */
 class DataLink extends pulumi.CustomResource {
     /**

package/dataLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataLink.js","sourceRoot":"","sources":["../dataLink.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAa,QAAS,SAAQ,MAAM,CAAC,cAAc;IAC/C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAqB,EAAE,IAAmC;QACnH,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC/D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,YAAY,CAAC;IACzD,CAAC;IAmCD,YAAY,IAAY,EAAE,WAA0C,EAAE,IAAmC;QACrG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAwC,CAAC;YACvD,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,0BAA0B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7E;aAAM;YACH,MAAM,IAAI,GAAG,WAAuC,CAAC;YACrD,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9F,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AAnFL,4BAoFC;AAtEG,gBAAgB;AACO,qBAAY,GAAG,kCAAkC,CAAC"}
+{"version":3,"file":"dataLink.js","sourceRoot":"","sources":["../dataLink.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAa,QAAS,SAAQ,MAAM,CAAC,cAAc;IAC/C;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAqB,EAAE,IAAmC;QACnH,OAAO,IAAI,QAAQ,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC/D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,QAAQ,CAAC,YAAY,CAAC;IACzD,CAAC;IAqCD,YAAY,IAAY,EAAE,WAA0C,EAAE,IAAmC;QACrG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAwC,CAAC;YACvD,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,cAAc,CAAC,0BAA0B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAChG,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC7E;aAAM;YACH,MAAM,IAAI,GAAG,WAAuC,CAAC;YACrD,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC;YAClF,cAAc,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9F,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;SAC3E;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AArFL,4BAsFC;AAxEG,gBAAgB;AACO,qBAAY,GAAG,kCAAkC,CAAC"}