signalfx.EventFeedChart
Explore with Pulumi AI
Displays a listing of events as a widget in a dashboard.
Example
resource "signalfx_event_feed_chart" "mynote0" {
name = "Important Dashboard Note"
description = "Lorem ipsum dolor sit amet"
program_text = "A = events(eventType='My Event Type').publish(label='A')"
viz_options {
label = "A"
color = "orange"
}
}
Arguments
The following arguments are supported in the resource block:
name
- (Required) Name of the text note.program_text
- (Required) Signalflow program text for the chart. More infoin the Splunk Observability Cloud docs.description
- (Optional) Description of the text note.time_range
- (Optional) From when to display data. Splunk Observability Cloud time syntax (e.g."-5m"
,"-1h"
). Conflicts withstart_time
andend_time
.start_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.end_time
- (Optional) Seconds since epoch. Used for visualization. Conflicts withtime_range
.
Attributes
In a addition to all arguments above, the following attributes are exported:
id
- The ID of the chart.url
- The URL of the chart.
Create EventFeedChart Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new EventFeedChart(name: string, args: EventFeedChartArgs, opts?: CustomResourceOptions);
@overload
def EventFeedChart(resource_name: str,
args: EventFeedChartArgs,
opts: Optional[ResourceOptions] = None)
@overload
def EventFeedChart(resource_name: str,
opts: Optional[ResourceOptions] = None,
program_text: Optional[str] = None,
description: Optional[str] = None,
end_time: Optional[int] = None,
name: Optional[str] = None,
start_time: Optional[int] = None,
time_range: Optional[int] = None)
func NewEventFeedChart(ctx *Context, name string, args EventFeedChartArgs, opts ...ResourceOption) (*EventFeedChart, error)
public EventFeedChart(string name, EventFeedChartArgs args, CustomResourceOptions? opts = null)
public EventFeedChart(String name, EventFeedChartArgs args)
public EventFeedChart(String name, EventFeedChartArgs args, CustomResourceOptions options)
type: signalfx:EventFeedChart
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 EventFeedChartArgs
- 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 EventFeedChartArgs
- 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 EventFeedChartArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EventFeedChartArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EventFeedChartArgs
- 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 eventFeedChartResource = new SignalFx.EventFeedChart("eventFeedChartResource", new()
{
ProgramText = "string",
Description = "string",
EndTime = 0,
Name = "string",
StartTime = 0,
TimeRange = 0,
});
example, err := signalfx.NewEventFeedChart(ctx, "eventFeedChartResource", &signalfx.EventFeedChartArgs{
ProgramText: pulumi.String("string"),
Description: pulumi.String("string"),
EndTime: pulumi.Int(0),
Name: pulumi.String("string"),
StartTime: pulumi.Int(0),
TimeRange: pulumi.Int(0),
})
var eventFeedChartResource = new EventFeedChart("eventFeedChartResource", EventFeedChartArgs.builder()
.programText("string")
.description("string")
.endTime(0)
.name("string")
.startTime(0)
.timeRange(0)
.build());
event_feed_chart_resource = signalfx.EventFeedChart("eventFeedChartResource",
program_text="string",
description="string",
end_time=0,
name="string",
start_time=0,
time_range=0)
const eventFeedChartResource = new signalfx.EventFeedChart("eventFeedChartResource", {
programText: "string",
description: "string",
endTime: 0,
name: "string",
startTime: 0,
timeRange: 0,
});
type: signalfx:EventFeedChart
properties:
description: string
endTime: 0
name: string
programText: string
startTime: 0
timeRange: 0
EventFeedChart 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 EventFeedChart resource accepts the following input properties:
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- description String
- Description of the chart (Optional)
- end
Time Integer - Seconds since epoch to end the visualization
- name String
- Name of the chart
- start
Time Integer - Seconds since epoch to start the visualization
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- description string
- Description of the chart (Optional)
- end
Time number - Seconds since epoch to end the visualization
- name string
- Name of the chart
- start
Time number - Seconds since epoch to start the visualization
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- description str
- Description of the chart (Optional)
- end_
time int - Seconds since epoch to end the visualization
- name str
- Name of the chart
- start_
time int - Seconds since epoch to start the visualization
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- description String
- Description of the chart (Optional)
- end
Time Number - Seconds since epoch to end the visualization
- name String
- Name of the chart
- start
Time Number - Seconds since epoch to start the visualization
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
Outputs
All input properties are implicitly available as output properties. Additionally, the EventFeedChart resource produces the following output properties:
Look up Existing EventFeedChart Resource
Get an existing EventFeedChart 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?: EventFeedChartState, opts?: CustomResourceOptions): EventFeedChart
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
end_time: Optional[int] = None,
name: Optional[str] = None,
program_text: Optional[str] = None,
start_time: Optional[int] = None,
time_range: Optional[int] = None,
url: Optional[str] = None) -> EventFeedChart
func GetEventFeedChart(ctx *Context, name string, id IDInput, state *EventFeedChartState, opts ...ResourceOption) (*EventFeedChart, error)
public static EventFeedChart Get(string name, Input<string> id, EventFeedChartState? state, CustomResourceOptions? opts = null)
public static EventFeedChart get(String name, Output<String> id, EventFeedChartState 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.
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Url string
- URL of the chart
- Description string
- Description of the chart (Optional)
- End
Time int - Seconds since epoch to end the visualization
- Name string
- Name of the chart
- Program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- Start
Time int - Seconds since epoch to start the visualization
- Time
Range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- Url string
- URL of the chart
- description String
- Description of the chart (Optional)
- end
Time Integer - Seconds since epoch to end the visualization
- name String
- Name of the chart
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time Integer - Seconds since epoch to start the visualization
- time
Range Integer - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url String
- URL of the chart
- description string
- Description of the chart (Optional)
- end
Time number - Seconds since epoch to end the visualization
- name string
- Name of the chart
- program
Text string - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time number - Seconds since epoch to start the visualization
- time
Range number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url string
- URL of the chart
- description str
- Description of the chart (Optional)
- end_
time int - Seconds since epoch to end the visualization
- name str
- Name of the chart
- program_
text str - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start_
time int - Seconds since epoch to start the visualization
- time_
range int - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url str
- URL of the chart
- description String
- Description of the chart (Optional)
- end
Time Number - Seconds since epoch to end the visualization
- name String
- Name of the chart
- program
Text String - Signalflow program text for the chart. More info at "https://developers.signalfx.com/docs/signalflow-overview"
- start
Time Number - Seconds since epoch to start the visualization
- time
Range Number - Seconds to display in the visualization. This is a rolling range from the current time. Example: 3600 =
-1h
- url String
- URL of the chart
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfx
Terraform Provider.