Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Alert
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

splight.Alert

Explore with Pulumi AI

splight logo
splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    Create Alert Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Alert(name: string, args: AlertArgs, opts?: CustomResourceOptions);
    @overload
def Alert(resource_name: str,
          args: AlertArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Alert(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          operator: Optional[str] = None,
          alert_items: Optional[Sequence[AlertAlertItemArgs]] = None,
          type: Optional[str] = None,
          time_window: Optional[int] = None,
          thresholds: Optional[Sequence[AlertThresholdArgs]] = None,
          aggregation: Optional[str] = None,
          target_variable: Optional[str] = None,
          severity: Optional[str] = None,
          description: Optional[str] = None,
          cron_minutes: Optional[int] = None,
          name: Optional[str] = None,
          rate_unit: Optional[str] = None,
          rate_value: Optional[int] = None,
          related_assets: Optional[Sequence[AlertRelatedAssetArgs]] = None,
          cron_year: Optional[int] = None,
          tags: Optional[Sequence[AlertTagArgs]] = None,
          cron_month: Optional[int] = None,
          cron_hours: Optional[int] = None,
          cron_dow: Optional[int] = None,
          cron_dom: Optional[int] = None)
    func NewAlert(ctx *Context, name string, args AlertArgs, opts ...ResourceOption) (*Alert, error)
    public Alert(string name, AlertArgs args, CustomResourceOptions? opts = null)
    public Alert(String name, AlertArgs args)
public Alert(String name, AlertArgs args, CustomResourceOptions options)

    type: splight:Alert
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 AlertArgs
    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 AlertArgs
    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 AlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var alertResource = new Splight.Alert("alertResource", new()
{
    Operator = "string",
    AlertItems = new[]
    {
        new Splight.Inputs.AlertAlertItemArgs
        {
            Expression = "string",
            ExpressionPlain = "string",
            QueryFilterAsset = new Splight.Inputs.AlertAlertItemQueryFilterAssetArgs
            {
                Id = "string",
                Name = "string",
            },
            QueryFilterAttribute = new Splight.Inputs.AlertAlertItemQueryFilterAttributeArgs
            {
                Id = "string",
                Name = "string",
            },
            QueryGroupFunction = "string",
            QueryGroupUnit = "string",
            QueryPlain = "string",
            RefId = "string",
            Type = "string",
            Id = "string",
        },
    },
    Type = "string",
    TimeWindow = 0,
    Thresholds = new[]
    {
        new Splight.Inputs.AlertThresholdArgs
        {
            Status = "string",
            Value = 0,
            StatusText = "string",
        },
    },
    Aggregation = "string",
    TargetVariable = "string",
    Severity = "string",
    Description = "string",
    CronMinutes = 0,
    Name = "string",
    RateUnit = "string",
    RateValue = 0,
    RelatedAssets = new[]
    {
        new Splight.Inputs.AlertRelatedAssetArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    CronYear = 0,
    Tags = new[]
    {
        new Splight.Inputs.AlertTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
    CronMonth = 0,
    CronHours = 0,
    CronDow = 0,
    CronDom = 0,
});

    example, err := splight.NewAlert(ctx, "alertResource", &splight.AlertArgs{
	Operator: pulumi.String("string"),
	AlertItems: splight.AlertAlertItemArray{
		&splight.AlertAlertItemArgs{
			Expression:      pulumi.String("string"),
			ExpressionPlain: pulumi.String("string"),
			QueryFilterAsset: &splight.AlertAlertItemQueryFilterAssetArgs{
				Id:   pulumi.String("string"),
				Name: pulumi.String("string"),
			},
			QueryFilterAttribute: &splight.AlertAlertItemQueryFilterAttributeArgs{
				Id:   pulumi.String("string"),
				Name: pulumi.String("string"),
			},
			QueryGroupFunction: pulumi.String("string"),
			QueryGroupUnit:     pulumi.String("string"),
			QueryPlain:         pulumi.String("string"),
			RefId:              pulumi.String("string"),
			Type:               pulumi.String("string"),
			Id:                 pulumi.String("string"),
		},
	},
	Type:       pulumi.String("string"),
	TimeWindow: pulumi.Int(0),
	Thresholds: splight.AlertThresholdArray{
		&splight.AlertThresholdArgs{
			Status:     pulumi.String("string"),
			Value:      pulumi.Float64(0),
			StatusText: pulumi.String("string"),
		},
	},
	Aggregation:    pulumi.String("string"),
	TargetVariable: pulumi.String("string"),
	Severity:       pulumi.String("string"),
	Description:    pulumi.String("string"),
	CronMinutes:    pulumi.Int(0),
	Name:           pulumi.String("string"),
	RateUnit:       pulumi.String("string"),
	RateValue:      pulumi.Int(0),
	RelatedAssets: splight.AlertRelatedAssetArray{
		&splight.AlertRelatedAssetArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	CronYear: pulumi.Int(0),
	Tags: splight.AlertTagArray{
		&splight.AlertTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
	CronMonth: pulumi.Int(0),
	CronHours: pulumi.Int(0),
	CronDow:   pulumi.Int(0),
	CronDom:   pulumi.Int(0),
})

    var alertResource = new Alert("alertResource", AlertArgs.builder()
    .operator("string")
    .alertItems(AlertAlertItemArgs.builder()
        .expression("string")
        .expressionPlain("string")
        .queryFilterAsset(AlertAlertItemQueryFilterAssetArgs.builder()
            .id("string")
            .name("string")
            .build())
        .queryFilterAttribute(AlertAlertItemQueryFilterAttributeArgs.builder()
            .id("string")
            .name("string")
            .build())
        .queryGroupFunction("string")
        .queryGroupUnit("string")
        .queryPlain("string")
        .refId("string")
        .type("string")
        .id("string")
        .build())
    .type("string")
    .timeWindow(0)
    .thresholds(AlertThresholdArgs.builder()
        .status("string")
        .value(0)
        .statusText("string")
        .build())
    .aggregation("string")
    .targetVariable("string")
    .severity("string")
    .description("string")
    .cronMinutes(0)
    .name("string")
    .rateUnit("string")
    .rateValue(0)
    .relatedAssets(AlertRelatedAssetArgs.builder()
        .id("string")
        .name("string")
        .build())
    .cronYear(0)
    .tags(AlertTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .cronMonth(0)
    .cronHours(0)
    .cronDow(0)
    .cronDom(0)
    .build());

    alert_resource = splight.Alert("alertResource",
    operator="string",
    alert_items=[{
        "expression": "string",
        "expression_plain": "string",
        "query_filter_asset": {
            "id": "string",
            "name": "string",
        },
        "query_filter_attribute": {
            "id": "string",
            "name": "string",
        },
        "query_group_function": "string",
        "query_group_unit": "string",
        "query_plain": "string",
        "ref_id": "string",
        "type": "string",
        "id": "string",
    }],
    type="string",
    time_window=0,
    thresholds=[{
        "status": "string",
        "value": 0,
        "status_text": "string",
    }],
    aggregation="string",
    target_variable="string",
    severity="string",
    description="string",
    cron_minutes=0,
    name="string",
    rate_unit="string",
    rate_value=0,
    related_assets=[{
        "id": "string",
        "name": "string",
    }],
    cron_year=0,
    tags=[{
        "id": "string",
        "name": "string",
    }],
    cron_month=0,
    cron_hours=0,
    cron_dow=0,
    cron_dom=0)

    const alertResource = new splight.Alert("alertResource", {
    operator: "string",
    alertItems: [{
        expression: "string",
        expressionPlain: "string",
        queryFilterAsset: {
            id: "string",
            name: "string",
        },
        queryFilterAttribute: {
            id: "string",
            name: "string",
        },
        queryGroupFunction: "string",
        queryGroupUnit: "string",
        queryPlain: "string",
        refId: "string",
        type: "string",
        id: "string",
    }],
    type: "string",
    timeWindow: 0,
    thresholds: [{
        status: "string",
        value: 0,
        statusText: "string",
    }],
    aggregation: "string",
    targetVariable: "string",
    severity: "string",
    description: "string",
    cronMinutes: 0,
    name: "string",
    rateUnit: "string",
    rateValue: 0,
    relatedAssets: [{
        id: "string",
        name: "string",
    }],
    cronYear: 0,
    tags: [{
        id: "string",
        name: "string",
    }],
    cronMonth: 0,
    cronHours: 0,
    cronDow: 0,
    cronDom: 0,
});

    type: splight:Alert
properties:
    aggregation: string
    alertItems:
        - expression: string
          expressionPlain: string
          id: string
          queryFilterAsset:
            id: string
            name: string
          queryFilterAttribute:
            id: string
            name: string
          queryGroupFunction: string
          queryGroupUnit: string
          queryPlain: string
          refId: string
          type: string
    cronDom: 0
    cronDow: 0
    cronHours: 0
    cronMinutes: 0
    cronMonth: 0
    cronYear: 0
    description: string
    name: string
    operator: string
    rateUnit: string
    rateValue: 0
    relatedAssets:
        - id: string
          name: string
    severity: string
    tags:
        - id: string
          name: string
    targetVariable: string
    thresholds:
        - status: string
          statusText: string
          value: 0
    timeWindow: 0
    type: string

    Alert Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Alert resource accepts the following input properties:

    Aggregation string
    aggregation to be applied to reads before comparisson
    AlertItems List<Splight.Splight.Inputs.AlertAlertItem>
    traces to be used to compute the results
    Description string
    The description of the resource
    Operator string
    operator to be used to compare the read value with the threshold value
    Severity string
    [sev1,...,sev8] severity for the alert
    TargetVariable string
    variable to be used to compare with thresholds
    Thresholds List<Splight.Splight.Inputs.AlertThreshold>
    TimeWindow int
    window to fetch data from. Data out of that window will not be considered for evaluation
    Type string
    [cron|rate] type for the cron
    CronDom int
    schedule value for cron
    CronDow int
    schedule value for cron
    CronHours int
    schedule value for cron
    CronMinutes int
    schedule value for cron
    CronMonth int
    schedule value for cron
    CronYear int
    schedule value for cron
    Name string
    The name of the resource
    RateUnit string
    [day|hour|minute] schedule unit
    RateValue int
    schedule value
    RelatedAssets List<Splight.Splight.Inputs.AlertRelatedAsset>
    related assets of the resource
    Tags List<Splight.Splight.Inputs.AlertTag>
    tags of the resource
    Aggregation string
    aggregation to be applied to reads before comparisson
    AlertItems []AlertAlertItemArgs
    traces to be used to compute the results
    Description string
    The description of the resource
    Operator string
    operator to be used to compare the read value with the threshold value
    Severity string
    [sev1,...,sev8] severity for the alert
    TargetVariable string
    variable to be used to compare with thresholds
    Thresholds []AlertThresholdArgs
    TimeWindow int
    window to fetch data from. Data out of that window will not be considered for evaluation
    Type string
    [cron|rate] type for the cron
    CronDom int
    schedule value for cron
    CronDow int
    schedule value for cron
    CronHours int
    schedule value for cron
    CronMinutes int
    schedule value for cron
    CronMonth int
    schedule value for cron
    CronYear int
    schedule value for cron
    Name string
    The name of the resource
    RateUnit string
    [day|hour|minute] schedule unit
    RateValue int
    schedule value
    RelatedAssets []AlertRelatedAssetArgs
    related assets of the resource
    Tags []AlertTagArgs
    tags of the resource
    aggregation String
    aggregation to be applied to reads before comparisson
    alertItems List<AlertAlertItem>
    traces to be used to compute the results
    description String
    The description of the resource
    operator String
    operator to be used to compare the read value with the threshold value
    severity String
    [sev1,...,sev8] severity for the alert
    targetVariable String
    variable to be used to compare with thresholds
    thresholds List<AlertThreshold>
    timeWindow Integer
    window to fetch data from. Data out of that window will not be considered for evaluation
    type String
    [cron|rate] type for the cron
    cronDom Integer
    schedule value for cron
    cronDow Integer
    schedule value for cron
    cronHours Integer
    schedule value for cron
    cronMinutes Integer
    schedule value for cron
    cronMonth Integer
    schedule value for cron
    cronYear Integer
    schedule value for cron
    name String
    The name of the resource
    rateUnit String
    [day|hour|minute] schedule unit
    rateValue Integer
    schedule value
    relatedAssets List<AlertRelatedAsset>
    related assets of the resource
    tags List<AlertTag>
    tags of the resource
    aggregation string
    aggregation to be applied to reads before comparisson
    alertItems AlertAlertItem[]
    traces to be used to compute the results
    description string
    The description of the resource
    operator string
    operator to be used to compare the read value with the threshold value
    severity string
    [sev1,...,sev8] severity for the alert
    targetVariable string
    variable to be used to compare with thresholds
    thresholds AlertThreshold[]
    timeWindow number
    window to fetch data from. Data out of that window will not be considered for evaluation
    type string
    [cron|rate] type for the cron
    cronDom number
    schedule value for cron
    cronDow number
    schedule value for cron
    cronHours number
    schedule value for cron
    cronMinutes number
    schedule value for cron
    cronMonth number
    schedule value for cron
    cronYear number
    schedule value for cron
    name string
    The name of the resource
    rateUnit string
    [day|hour|minute] schedule unit
    rateValue number
    schedule value
    relatedAssets AlertRelatedAsset[]
    related assets of the resource
    tags AlertTag[]
    tags of the resource
    aggregation str
    aggregation to be applied to reads before comparisson
    alert_items Sequence[AlertAlertItemArgs]
    traces to be used to compute the results
    description str
    The description of the resource
    operator str
    operator to be used to compare the read value with the threshold value
    severity str
    [sev1,...,sev8] severity for the alert
    target_variable str
    variable to be used to compare with thresholds
    thresholds Sequence[AlertThresholdArgs]
    time_window int
    window to fetch data from. Data out of that window will not be considered for evaluation
    type str
    [cron|rate] type for the cron
    cron_dom int
    schedule value for cron
    cron_dow int
    schedule value for cron
    cron_hours int
    schedule value for cron
    cron_minutes int
    schedule value for cron
    cron_month int
    schedule value for cron
    cron_year int
    schedule value for cron
    name str
    The name of the resource
    rate_unit str
    [day|hour|minute] schedule unit
    rate_value int
    schedule value
    related_assets Sequence[AlertRelatedAssetArgs]
    related assets of the resource
    tags Sequence[AlertTagArgs]
    tags of the resource
    aggregation String
    aggregation to be applied to reads before comparisson
    alertItems List<Property Map>
    traces to be used to compute the results
    description String
    The description of the resource
    operator String
    operator to be used to compare the read value with the threshold value
    severity String
    [sev1,...,sev8] severity for the alert
    targetVariable String
    variable to be used to compare with thresholds
    thresholds List<Property Map>
    timeWindow Number
    window to fetch data from. Data out of that window will not be considered for evaluation
    type String
    [cron|rate] type for the cron
    cronDom Number
    schedule value for cron
    cronDow Number
    schedule value for cron
    cronHours Number
    schedule value for cron
    cronMinutes Number
    schedule value for cron
    cronMonth Number
    schedule value for cron
    cronYear Number
    schedule value for cron
    name String
    The name of the resource
    rateUnit String
    [day|hour|minute] schedule unit
    rateValue Number
    schedule value
    relatedAssets List<Property Map>
    related assets of the resource
    tags List<Property Map>
    tags of the resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Alert 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 Existing Alert Resource

    Get an existing Alert 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?: AlertState, opts?: CustomResourceOptions): Alert
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregation: Optional[str] = None,
        alert_items: Optional[Sequence[AlertAlertItemArgs]] = None,
        cron_dom: Optional[int] = None,
        cron_dow: Optional[int] = None,
        cron_hours: Optional[int] = None,
        cron_minutes: Optional[int] = None,
        cron_month: Optional[int] = None,
        cron_year: Optional[int] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        operator: Optional[str] = None,
        rate_unit: Optional[str] = None,
        rate_value: Optional[int] = None,
        related_assets: Optional[Sequence[AlertRelatedAssetArgs]] = None,
        severity: Optional[str] = None,
        tags: Optional[Sequence[AlertTagArgs]] = None,
        target_variable: Optional[str] = None,
        thresholds: Optional[Sequence[AlertThresholdArgs]] = None,
        time_window: Optional[int] = None,
        type: Optional[str] = None) -> Alert
    func GetAlert(ctx *Context, name string, id IDInput, state *AlertState, opts ...ResourceOption) (*Alert, error)
    public static Alert Get(string name, Input<string> id, AlertState? state, CustomResourceOptions? opts = null)
    public static Alert get(String name, Output<String> id, AlertState 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.
    The following state arguments are supported:
    Aggregation string
    aggregation to be applied to reads before comparisson
    AlertItems List<Splight.Splight.Inputs.AlertAlertItem>
    traces to be used to compute the results
    CronDom int
    schedule value for cron
    CronDow int
    schedule value for cron
    CronHours int
    schedule value for cron
    CronMinutes int
    schedule value for cron
    CronMonth int
    schedule value for cron
    CronYear int
    schedule value for cron
    Description string
    The description of the resource
    Name string
    The name of the resource
    Operator string
    operator to be used to compare the read value with the threshold value
    RateUnit string
    [day|hour|minute] schedule unit
    RateValue int
    schedule value
    RelatedAssets List<Splight.Splight.Inputs.AlertRelatedAsset>
    related assets of the resource
    Severity string
    [sev1,...,sev8] severity for the alert
    Tags List<Splight.Splight.Inputs.AlertTag>
    tags of the resource
    TargetVariable string
    variable to be used to compare with thresholds
    Thresholds List<Splight.Splight.Inputs.AlertThreshold>
    TimeWindow int
    window to fetch data from. Data out of that window will not be considered for evaluation
    Type string
    [cron|rate] type for the cron
    Aggregation string
    aggregation to be applied to reads before comparisson
    AlertItems []AlertAlertItemArgs
    traces to be used to compute the results
    CronDom int
    schedule value for cron
    CronDow int
    schedule value for cron
    CronHours int
    schedule value for cron
    CronMinutes int
    schedule value for cron
    CronMonth int
    schedule value for cron
    CronYear int
    schedule value for cron
    Description string
    The description of the resource
    Name string
    The name of the resource
    Operator string
    operator to be used to compare the read value with the threshold value
    RateUnit string
    [day|hour|minute] schedule unit
    RateValue int
    schedule value
    RelatedAssets []AlertRelatedAssetArgs
    related assets of the resource
    Severity string
    [sev1,...,sev8] severity for the alert
    Tags []AlertTagArgs
    tags of the resource
    TargetVariable string
    variable to be used to compare with thresholds
    Thresholds []AlertThresholdArgs
    TimeWindow int
    window to fetch data from. Data out of that window will not be considered for evaluation
    Type string
    [cron|rate] type for the cron
    aggregation String
    aggregation to be applied to reads before comparisson
    alertItems List<AlertAlertItem>
    traces to be used to compute the results
    cronDom Integer
    schedule value for cron
    cronDow Integer
    schedule value for cron
    cronHours Integer
    schedule value for cron
    cronMinutes Integer
    schedule value for cron
    cronMonth Integer
    schedule value for cron
    cronYear Integer
    schedule value for cron
    description String
    The description of the resource
    name String
    The name of the resource
    operator String
    operator to be used to compare the read value with the threshold value
    rateUnit String
    [day|hour|minute] schedule unit
    rateValue Integer
    schedule value
    relatedAssets List<AlertRelatedAsset>
    related assets of the resource
    severity String
    [sev1,...,sev8] severity for the alert
    tags List<AlertTag>
    tags of the resource
    targetVariable String
    variable to be used to compare with thresholds
    thresholds List<AlertThreshold>
    timeWindow Integer
    window to fetch data from. Data out of that window will not be considered for evaluation
    type String
    [cron|rate] type for the cron
    aggregation string
    aggregation to be applied to reads before comparisson
    alertItems AlertAlertItem[]
    traces to be used to compute the results
    cronDom number
    schedule value for cron
    cronDow number
    schedule value for cron
    cronHours number
    schedule value for cron
    cronMinutes number
    schedule value for cron
    cronMonth number
    schedule value for cron
    cronYear number
    schedule value for cron
    description string
    The description of the resource
    name string
    The name of the resource
    operator string
    operator to be used to compare the read value with the threshold value
    rateUnit string
    [day|hour|minute] schedule unit
    rateValue number
    schedule value
    relatedAssets AlertRelatedAsset[]
    related assets of the resource
    severity string
    [sev1,...,sev8] severity for the alert
    tags AlertTag[]
    tags of the resource
    targetVariable string
    variable to be used to compare with thresholds
    thresholds AlertThreshold[]
    timeWindow number
    window to fetch data from. Data out of that window will not be considered for evaluation
    type string
    [cron|rate] type for the cron
    aggregation str
    aggregation to be applied to reads before comparisson
    alert_items Sequence[AlertAlertItemArgs]
    traces to be used to compute the results
    cron_dom int
    schedule value for cron
    cron_dow int
    schedule value for cron
    cron_hours int
    schedule value for cron
    cron_minutes int
    schedule value for cron
    cron_month int
    schedule value for cron
    cron_year int
    schedule value for cron
    description str
    The description of the resource
    name str
    The name of the resource
    operator str
    operator to be used to compare the read value with the threshold value
    rate_unit str
    [day|hour|minute] schedule unit
    rate_value int
    schedule value
    related_assets Sequence[AlertRelatedAssetArgs]
    related assets of the resource
    severity str
    [sev1,...,sev8] severity for the alert
    tags Sequence[AlertTagArgs]
    tags of the resource
    target_variable str
    variable to be used to compare with thresholds
    thresholds Sequence[AlertThresholdArgs]
    time_window int
    window to fetch data from. Data out of that window will not be considered for evaluation
    type str
    [cron|rate] type for the cron
    aggregation String
    aggregation to be applied to reads before comparisson
    alertItems List<Property Map>
    traces to be used to compute the results
    cronDom Number
    schedule value for cron
    cronDow Number
    schedule value for cron
    cronHours Number
    schedule value for cron
    cronMinutes Number
    schedule value for cron
    cronMonth Number
    schedule value for cron
    cronYear Number
    schedule value for cron
    description String
    The description of the resource
    name String
    The name of the resource
    operator String
    operator to be used to compare the read value with the threshold value
    rateUnit String
    [day|hour|minute] schedule unit
    rateValue Number
    schedule value
    relatedAssets List<Property Map>
    related assets of the resource
    severity String
    [sev1,...,sev8] severity for the alert
    tags List<Property Map>
    tags of the resource
    targetVariable String
    variable to be used to compare with thresholds
    thresholds List<Property Map>
    timeWindow Number
    window to fetch data from. Data out of that window will not be considered for evaluation
    type String
    [cron|rate] type for the cron

    Supporting Types

    AlertAlertItem, AlertAlertItemArgs

    Expression string
    how the expression is shown (i.e 'A * 2')
    ExpressionPlain string
    actual mongo query containing the expression
    QueryFilterAsset Splight.Splight.Inputs.AlertAlertItemQueryFilterAsset
    Asset filter
    QueryFilterAttribute Splight.Splight.Inputs.AlertAlertItemQueryFilterAttribute
    Attribute filter
    QueryGroupFunction string
    function used to aggregate data
    QueryGroupUnit string
    time window to apply the aggregation
    QueryPlain string
    actual mongo query
    RefId string
    identifier of the variable (i.e 'A')
    Type string
    either QUERY or EXPRESSION
    Id string
    Id of the function item
    Expression string
    how the expression is shown (i.e 'A * 2')
    ExpressionPlain string
    actual mongo query containing the expression
    QueryFilterAsset AlertAlertItemQueryFilterAsset
    Asset filter
    QueryFilterAttribute AlertAlertItemQueryFilterAttribute
    Attribute filter
    QueryGroupFunction string
    function used to aggregate data
    QueryGroupUnit string
    time window to apply the aggregation
    QueryPlain string
    actual mongo query
    RefId string
    identifier of the variable (i.e 'A')
    Type string
    either QUERY or EXPRESSION
    Id string
    Id of the function item
    expression String
    how the expression is shown (i.e 'A * 2')
    expressionPlain String
    actual mongo query containing the expression
    queryFilterAsset AlertAlertItemQueryFilterAsset
    Asset filter
    queryFilterAttribute AlertAlertItemQueryFilterAttribute
    Attribute filter
    queryGroupFunction String
    function used to aggregate data
    queryGroupUnit String
    time window to apply the aggregation
    queryPlain String
    actual mongo query
    refId String
    identifier of the variable (i.e 'A')
    type String
    either QUERY or EXPRESSION
    id String
    Id of the function item
    expression string
    how the expression is shown (i.e 'A * 2')
    expressionPlain string
    actual mongo query containing the expression
    queryFilterAsset AlertAlertItemQueryFilterAsset
    Asset filter
    queryFilterAttribute AlertAlertItemQueryFilterAttribute
    Attribute filter
    queryGroupFunction string
    function used to aggregate data
    queryGroupUnit string
    time window to apply the aggregation
    queryPlain string
    actual mongo query
    refId string
    identifier of the variable (i.e 'A')
    type string
    either QUERY or EXPRESSION
    id string
    Id of the function item
    expression str
    how the expression is shown (i.e 'A * 2')
    expression_plain str
    actual mongo query containing the expression
    query_filter_asset AlertAlertItemQueryFilterAsset
    Asset filter
    query_filter_attribute AlertAlertItemQueryFilterAttribute
    Attribute filter
    query_group_function str
    function used to aggregate data
    query_group_unit str
    time window to apply the aggregation
    query_plain str
    actual mongo query
    ref_id str
    identifier of the variable (i.e 'A')
    type str
    either QUERY or EXPRESSION
    id str
    Id of the function item
    expression String
    how the expression is shown (i.e 'A * 2')
    expressionPlain String
    actual mongo query containing the expression
    queryFilterAsset Property Map
    Asset filter
    queryFilterAttribute Property Map
    Attribute filter
    queryGroupFunction String
    function used to aggregate data
    queryGroupUnit String
    time window to apply the aggregation
    queryPlain String
    actual mongo query
    refId String
    identifier of the variable (i.e 'A')
    type String
    either QUERY or EXPRESSION
    id String
    Id of the function item

    AlertAlertItemQueryFilterAsset, AlertAlertItemQueryFilterAssetArgs

    Id string
    Id of the resource
    Name string
    name of the resource
    Id string
    Id of the resource
    Name string
    name of the resource
    id String
    Id of the resource
    name String
    name of the resource
    id string
    Id of the resource
    name string
    name of the resource
    id str
    Id of the resource
    name str
    name of the resource
    id String
    Id of the resource
    name String
    name of the resource

    AlertAlertItemQueryFilterAttribute, AlertAlertItemQueryFilterAttributeArgs

    Id string
    Id of the resource
    Name string
    name of the resource
    Id string
    Id of the resource
    Name string
    name of the resource
    id String
    Id of the resource
    name String
    name of the resource
    id string
    Id of the resource
    name string
    name of the resource
    id str
    Id of the resource
    name str
    name of the resource
    id String
    Id of the resource
    name String
    name of the resource

    AlertRelatedAsset, AlertRelatedAssetArgs

    Id string
    asset id
    Name string
    asset name
    Id string
    asset id
    Name string
    asset name
    id String
    asset id
    name String
    asset name
    id string
    asset id
    name string
    asset name
    id str
    asset id
    name str
    asset name
    id String
    asset id
    name String
    asset name

    AlertTag, AlertTagArgs

    Id string
    tag id
    Name string
    tag name
    Id string
    tag id
    Name string
    tag name
    id String
    tag id
    name String
    tag name
    id string
    tag id
    name string
    tag name
    id str
    tag id
    name str
    tag name
    id String
    tag id
    name String
    tag name

    AlertThreshold, AlertThresholdArgs

    Status string
    [alert|warning|no_alert] status value for the threshold
    Value double
    value to be considered to compare
    StatusText string
    optional custom value to be displayed in the platform.
    Status string
    [alert|warning|no_alert] status value for the threshold
    Value float64
    value to be considered to compare
    StatusText string
    optional custom value to be displayed in the platform.
    status String
    [alert|warning|no_alert] status value for the threshold
    value Double
    value to be considered to compare
    statusText String
    optional custom value to be displayed in the platform.
    status string
    [alert|warning|no_alert] status value for the threshold
    value number
    value to be considered to compare
    statusText string
    optional custom value to be displayed in the platform.
    status str
    [alert|warning|no_alert] status value for the threshold
    value float
    value to be considered to compare
    status_text str
    optional custom value to be displayed in the platform.
    status String
    [alert|warning|no_alert] status value for the threshold
    value Number
    value to be considered to compare
    statusText String
    optional custom value to be displayed in the platform.

    Import

    $ pulumi import splight:index/alert:Alert [options] splight_alert.<name> <alert_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    splight splightplatform/pulumi-splight
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the splight Terraform Provider.
    splight logo
    splight v1.2.2 published on Friday, Nov 8, 2024 by splightplatform
    splightplatform/pulumi-splight