@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
105 lines (104 loc) • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Fabric V4 API compatible data source that allows user to fetch Equinix Fabric Stream Alert Rules with pagination
*
* Additional Documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
* * API: https://developer.equinix.com/catalog/fabricv4#tag/Stream-Alert-Rules
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const dataStreamAlertRules = equinix.fabric.getStreamAlertRules({
* streamId: "<uuid_of_stream>",
* pagination: {
* limit: 5,
* offset: 1,
* },
* });
* export const streamAlertRulesType = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].type;
* export const streamAlertRulesId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].uuid;
* export const streamAlertRulesState = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].state;
* export const streamAlertRulesStreamId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].stream_id;
* ```
*/
export declare function getStreamAlertRules(args: GetStreamAlertRulesArgs, opts?: pulumi.InvokeOptions): Promise<GetStreamAlertRulesResult>;
/**
* A collection of arguments for invoking getStreamAlertRules.
*/
export interface GetStreamAlertRulesArgs {
/**
* Pagination details for the returned stream alert rules list
*/
pagination: inputs.fabric.GetStreamAlertRulesPagination;
/**
* The uuid of the stream that is the target of the stream alert rule
*/
streamId: string;
}
/**
* A collection of values returned by getStreamAlertRules.
*/
export interface GetStreamAlertRulesResult {
/**
* Returned list of stream objects
*/
readonly datas: outputs.fabric.GetStreamAlertRulesData[];
/**
* The unique identifier of the resource
*/
readonly id: string;
/**
* Pagination details for the returned stream alert rules list
*/
readonly pagination: outputs.fabric.GetStreamAlertRulesPagination;
/**
* The uuid of the stream that is the target of the stream alert rule
*/
readonly streamId: string;
}
/**
* Fabric V4 API compatible data source that allows user to fetch Equinix Fabric Stream Alert Rules with pagination
*
* Additional Documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
* * API: https://developer.equinix.com/catalog/fabricv4#tag/Stream-Alert-Rules
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const dataStreamAlertRules = equinix.fabric.getStreamAlertRules({
* streamId: "<uuid_of_stream>",
* pagination: {
* limit: 5,
* offset: 1,
* },
* });
* export const streamAlertRulesType = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].type;
* export const streamAlertRulesId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].uuid;
* export const streamAlertRulesState = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].state;
* export const streamAlertRulesStreamId = data.equinix_fabric_stream_alert_rules.alert_rules.data[0].stream_id;
* ```
*/
export declare function getStreamAlertRulesOutput(args: GetStreamAlertRulesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStreamAlertRulesResult>;
/**
* A collection of arguments for invoking getStreamAlertRules.
*/
export interface GetStreamAlertRulesOutputArgs {
/**
* Pagination details for the returned stream alert rules list
*/
pagination: pulumi.Input<inputs.fabric.GetStreamAlertRulesPaginationArgs>;
/**
* The uuid of the stream that is the target of the stream alert rule
*/
streamId: pulumi.Input<string>;
}