prismacloud.AlertRule
Explore with Pulumi AI
Manage an alert rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as prismacloud from "@pulumi/prismacloud";
const example = new prismacloud.AlertRule("example", {description: "Made by Pulumi"});
import pulumi
import pulumi_prismacloud as prismacloud
example = prismacloud.AlertRule("example", description="Made by Pulumi")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/prismacloud/prismacloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := prismacloud.NewAlertRule(ctx, "example", &prismacloud.AlertRuleArgs{
Description: pulumi.String("Made by Pulumi"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Prismacloud = Pulumi.Prismacloud;
return await Deployment.RunAsync(() =>
{
var example = new Prismacloud.AlertRule("example", new()
{
Description = "Made by Pulumi",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prismacloud.AlertRule;
import com.pulumi.prismacloud.AlertRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AlertRule("example", AlertRuleArgs.builder()
.description("Made by Pulumi")
.build());
}
}
resources:
example:
type: prismacloud:AlertRule
properties:
description: Made by Pulumi
Alert Rule With Policy Filter)
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.prismacloud.AlertRule;
import com.pulumi.prismacloud.AlertRuleArgs;
import com.pulumi.prismacloud.inputs.AlertRuleTargetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AlertRule("example", AlertRuleArgs.builder()
.description("Made by Pulumi")
.enabled(true)
.target(AlertRuleTargetArgs.builder()
.accountGroups("accountGroupId")
.alertRulePolicyFilters(AlertRuleTargetAlertRulePolicyFilterArgs.builder()
.cloudType("cloudType")
.policyComplianceStandard("complianceStandardName")
.policyLabel("policyLabel")
.policySeverity("severity")
.build())
.build())
.build());
}
}
resources:
example:
type: prismacloud:AlertRule
properties:
description: Made by Pulumi
enabled: true
target:
accountGroups:
- accountGroupId
alertRulePolicyFilters:
- cloudType:
- cloudType
policyComplianceStandard:
- complianceStandardName
policyLabel:
- policyLabel
policySeverity:
- severity
Create AlertRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AlertRule(name: string, args: AlertRuleArgs, opts?: CustomResourceOptions);
@overload
def AlertRule(resource_name: str,
args: AlertRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AlertRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
target: Optional[AlertRuleTargetArgs] = None,
notification_configs: Optional[Sequence[AlertRuleNotificationConfigArgs]] = None,
notify_on_open: Optional[bool] = None,
deleted: Optional[bool] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
excluded_policies: Optional[Sequence[str]] = None,
delay_notification_ms: Optional[float] = None,
name: Optional[str] = None,
notify_on_dismissed: Optional[bool] = None,
alert_rule_id: Optional[str] = None,
notify_on_resolved: Optional[bool] = None,
notify_on_snoozed: Optional[bool] = None,
policies: Optional[Sequence[str]] = None,
policy_labels: Optional[Sequence[str]] = None,
scan_all: Optional[bool] = None,
allow_auto_remediate: Optional[bool] = None)
func NewAlertRule(ctx *Context, name string, args AlertRuleArgs, opts ...ResourceOption) (*AlertRule, error)
public AlertRule(string name, AlertRuleArgs args, CustomResourceOptions? opts = null)
public AlertRule(String name, AlertRuleArgs args)
public AlertRule(String name, AlertRuleArgs args, CustomResourceOptions options)
type: prismacloud:AlertRule
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 AlertRuleArgs
- 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 AlertRuleArgs
- 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 AlertRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AlertRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AlertRuleArgs
- 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 alertRuleResource = new Prismacloud.AlertRule("alertRuleResource", new()
{
Target = new Prismacloud.Inputs.AlertRuleTargetArgs
{
AccountGroups = new[]
{
"string",
},
AlertRulePolicyFilters = new[]
{
new Prismacloud.Inputs.AlertRuleTargetAlertRulePolicyFilterArgs
{
CloudTypes = new[]
{
"string",
},
PolicyComplianceStandards = new[]
{
"string",
},
PolicyLabels = new[]
{
"string",
},
PolicySeverities = new[]
{
"string",
},
},
},
ExcludedAccounts = new[]
{
"string",
},
Regions = new[]
{
"string",
},
ResourceLists = new[]
{
new Prismacloud.Inputs.AlertRuleTargetResourceListArgs
{
ComputeAccessGroupIds = new[]
{
"string",
},
},
},
Tags = new[]
{
new Prismacloud.Inputs.AlertRuleTargetTagArgs
{
Key = "string",
Values = new[]
{
"string",
},
},
},
},
NotificationConfigs = new[]
{
new Prismacloud.Inputs.AlertRuleNotificationConfigArgs
{
ConfigId = "string",
ConfigType = "string",
DayOfMonth = 0,
DaysOfWeeks = new[]
{
new Prismacloud.Inputs.AlertRuleNotificationConfigDaysOfWeekArgs
{
Day = "string",
Offset = 0,
},
},
DetailedReport = false,
Enabled = false,
Frequency = "string",
FrequencyFromRRule = "string",
HourOfDay = 0,
IncludeRemediation = false,
LastSentTs = 0,
LastUpdated = 0,
RRuleSchedule = "string",
Recipients = new[]
{
"string",
},
TemplateId = "string",
TimezoneId = "string",
WithCompression = false,
},
},
NotifyOnOpen = false,
Deleted = false,
Description = "string",
Enabled = false,
ExcludedPolicies = new[]
{
"string",
},
DelayNotificationMs = 0,
Name = "string",
NotifyOnDismissed = false,
AlertRuleId = "string",
NotifyOnResolved = false,
NotifyOnSnoozed = false,
Policies = new[]
{
"string",
},
PolicyLabels = new[]
{
"string",
},
ScanAll = false,
AllowAutoRemediate = false,
});
example, err := prismacloud.NewAlertRule(ctx, "alertRuleResource", &prismacloud.AlertRuleArgs{
Target: &prismacloud.AlertRuleTargetArgs{
AccountGroups: pulumi.StringArray{
pulumi.String("string"),
},
AlertRulePolicyFilters: prismacloud.AlertRuleTargetAlertRulePolicyFilterArray{
&prismacloud.AlertRuleTargetAlertRulePolicyFilterArgs{
CloudTypes: pulumi.StringArray{
pulumi.String("string"),
},
PolicyComplianceStandards: pulumi.StringArray{
pulumi.String("string"),
},
PolicyLabels: pulumi.StringArray{
pulumi.String("string"),
},
PolicySeverities: pulumi.StringArray{
pulumi.String("string"),
},
},
},
ExcludedAccounts: pulumi.StringArray{
pulumi.String("string"),
},
Regions: pulumi.StringArray{
pulumi.String("string"),
},
ResourceLists: prismacloud.AlertRuleTargetResourceListArray{
&prismacloud.AlertRuleTargetResourceListArgs{
ComputeAccessGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Tags: prismacloud.AlertRuleTargetTagArray{
&prismacloud.AlertRuleTargetTagArgs{
Key: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
NotificationConfigs: prismacloud.AlertRuleNotificationConfigArray{
&prismacloud.AlertRuleNotificationConfigArgs{
ConfigId: pulumi.String("string"),
ConfigType: pulumi.String("string"),
DayOfMonth: pulumi.Float64(0),
DaysOfWeeks: prismacloud.AlertRuleNotificationConfigDaysOfWeekArray{
&prismacloud.AlertRuleNotificationConfigDaysOfWeekArgs{
Day: pulumi.String("string"),
Offset: pulumi.Float64(0),
},
},
DetailedReport: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Frequency: pulumi.String("string"),
FrequencyFromRRule: pulumi.String("string"),
HourOfDay: pulumi.Float64(0),
IncludeRemediation: pulumi.Bool(false),
LastSentTs: pulumi.Float64(0),
LastUpdated: pulumi.Float64(0),
RRuleSchedule: pulumi.String("string"),
Recipients: pulumi.StringArray{
pulumi.String("string"),
},
TemplateId: pulumi.String("string"),
TimezoneId: pulumi.String("string"),
WithCompression: pulumi.Bool(false),
},
},
NotifyOnOpen: pulumi.Bool(false),
Deleted: pulumi.Bool(false),
Description: pulumi.String("string"),
Enabled: pulumi.Bool(false),
ExcludedPolicies: pulumi.StringArray{
pulumi.String("string"),
},
DelayNotificationMs: pulumi.Float64(0),
Name: pulumi.String("string"),
NotifyOnDismissed: pulumi.Bool(false),
AlertRuleId: pulumi.String("string"),
NotifyOnResolved: pulumi.Bool(false),
NotifyOnSnoozed: pulumi.Bool(false),
Policies: pulumi.StringArray{
pulumi.String("string"),
},
PolicyLabels: pulumi.StringArray{
pulumi.String("string"),
},
ScanAll: pulumi.Bool(false),
AllowAutoRemediate: pulumi.Bool(false),
})
var alertRuleResource = new AlertRule("alertRuleResource", AlertRuleArgs.builder()
.target(AlertRuleTargetArgs.builder()
.accountGroups("string")
.alertRulePolicyFilters(AlertRuleTargetAlertRulePolicyFilterArgs.builder()
.cloudTypes("string")
.policyComplianceStandards("string")
.policyLabels("string")
.policySeverities("string")
.build())
.excludedAccounts("string")
.regions("string")
.resourceLists(AlertRuleTargetResourceListArgs.builder()
.computeAccessGroupIds("string")
.build())
.tags(AlertRuleTargetTagArgs.builder()
.key("string")
.values("string")
.build())
.build())
.notificationConfigs(AlertRuleNotificationConfigArgs.builder()
.configId("string")
.configType("string")
.dayOfMonth(0)
.daysOfWeeks(AlertRuleNotificationConfigDaysOfWeekArgs.builder()
.day("string")
.offset(0)
.build())
.detailedReport(false)
.enabled(false)
.frequency("string")
.frequencyFromRRule("string")
.hourOfDay(0)
.includeRemediation(false)
.lastSentTs(0)
.lastUpdated(0)
.rRuleSchedule("string")
.recipients("string")
.templateId("string")
.timezoneId("string")
.withCompression(false)
.build())
.notifyOnOpen(false)
.deleted(false)
.description("string")
.enabled(false)
.excludedPolicies("string")
.delayNotificationMs(0)
.name("string")
.notifyOnDismissed(false)
.alertRuleId("string")
.notifyOnResolved(false)
.notifyOnSnoozed(false)
.policies("string")
.policyLabels("string")
.scanAll(false)
.allowAutoRemediate(false)
.build());
alert_rule_resource = prismacloud.AlertRule("alertRuleResource",
target={
"account_groups": ["string"],
"alert_rule_policy_filters": [{
"cloud_types": ["string"],
"policy_compliance_standards": ["string"],
"policy_labels": ["string"],
"policy_severities": ["string"],
}],
"excluded_accounts": ["string"],
"regions": ["string"],
"resource_lists": [{
"compute_access_group_ids": ["string"],
}],
"tags": [{
"key": "string",
"values": ["string"],
}],
},
notification_configs=[{
"config_id": "string",
"config_type": "string",
"day_of_month": 0,
"days_of_weeks": [{
"day": "string",
"offset": 0,
}],
"detailed_report": False,
"enabled": False,
"frequency": "string",
"frequency_from_r_rule": "string",
"hour_of_day": 0,
"include_remediation": False,
"last_sent_ts": 0,
"last_updated": 0,
"r_rule_schedule": "string",
"recipients": ["string"],
"template_id": "string",
"timezone_id": "string",
"with_compression": False,
}],
notify_on_open=False,
deleted=False,
description="string",
enabled=False,
excluded_policies=["string"],
delay_notification_ms=0,
name="string",
notify_on_dismissed=False,
alert_rule_id="string",
notify_on_resolved=False,
notify_on_snoozed=False,
policies=["string"],
policy_labels=["string"],
scan_all=False,
allow_auto_remediate=False)
const alertRuleResource = new prismacloud.AlertRule("alertRuleResource", {
target: {
accountGroups: ["string"],
alertRulePolicyFilters: [{
cloudTypes: ["string"],
policyComplianceStandards: ["string"],
policyLabels: ["string"],
policySeverities: ["string"],
}],
excludedAccounts: ["string"],
regions: ["string"],
resourceLists: [{
computeAccessGroupIds: ["string"],
}],
tags: [{
key: "string",
values: ["string"],
}],
},
notificationConfigs: [{
configId: "string",
configType: "string",
dayOfMonth: 0,
daysOfWeeks: [{
day: "string",
offset: 0,
}],
detailedReport: false,
enabled: false,
frequency: "string",
frequencyFromRRule: "string",
hourOfDay: 0,
includeRemediation: false,
lastSentTs: 0,
lastUpdated: 0,
rRuleSchedule: "string",
recipients: ["string"],
templateId: "string",
timezoneId: "string",
withCompression: false,
}],
notifyOnOpen: false,
deleted: false,
description: "string",
enabled: false,
excludedPolicies: ["string"],
delayNotificationMs: 0,
name: "string",
notifyOnDismissed: false,
alertRuleId: "string",
notifyOnResolved: false,
notifyOnSnoozed: false,
policies: ["string"],
policyLabels: ["string"],
scanAll: false,
allowAutoRemediate: false,
});
type: prismacloud:AlertRule
properties:
alertRuleId: string
allowAutoRemediate: false
delayNotificationMs: 0
deleted: false
description: string
enabled: false
excludedPolicies:
- string
name: string
notificationConfigs:
- configId: string
configType: string
dayOfMonth: 0
daysOfWeeks:
- day: string
offset: 0
detailedReport: false
enabled: false
frequency: string
frequencyFromRRule: string
hourOfDay: 0
includeRemediation: false
lastSentTs: 0
lastUpdated: 0
rRuleSchedule: string
recipients:
- string
templateId: string
timezoneId: string
withCompression: false
notifyOnDismissed: false
notifyOnOpen: false
notifyOnResolved: false
notifyOnSnoozed: false
policies:
- string
policyLabels:
- string
scanAll: false
target:
accountGroups:
- string
alertRulePolicyFilters:
- cloudTypes:
- string
policyComplianceStandards:
- string
policyLabels:
- string
policySeverities:
- string
excludedAccounts:
- string
regions:
- string
resourceLists:
- computeAccessGroupIds:
- string
tags:
- key: string
values:
- string
AlertRule 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 AlertRule resource accepts the following input properties:
- Target
Alert
Rule Target - Model for the target filter, as defined below
- Alert
Rule stringId - Allow
Auto boolRemediate - Allow auto-remediation
- Delay
Notification doubleMs - Delay notifications by the specified miliseconds
- Deleted bool
- (bool) Deleted
- Description string
- Description
- Enabled bool
- Enabled (default:
true
) - Excluded
Policies List<string> - List of policies to exclude from scan
- Name string
- Rule/Scan name
- Notification
Configs List<AlertRule Notification Config> - List of data for notifications to third-party tools, as defined below
- Notify
On boolDismissed - Include dismissed alerts in notification
- Notify
On boolOpen - Include open alerts in notification (default:
true
) - Notify
On boolResolved - Include resolved alerts in notification
- Notify
On boolSnoozed - Include snoozed alerts in notification
- Policies List<string>
- List of specific policies to scan
- Policy
Labels List<string> - List of policy labels
- Scan
All bool - Scan all policies
- Target
Alert
Rule Target Args - Model for the target filter, as defined below
- Alert
Rule stringId - Allow
Auto boolRemediate - Allow auto-remediation
- Delay
Notification float64Ms - Delay notifications by the specified miliseconds
- Deleted bool
- (bool) Deleted
- Description string
- Description
- Enabled bool
- Enabled (default:
true
) - Excluded
Policies []string - List of policies to exclude from scan
- Name string
- Rule/Scan name
- Notification
Configs []AlertRule Notification Config Args - List of data for notifications to third-party tools, as defined below
- Notify
On boolDismissed - Include dismissed alerts in notification
- Notify
On boolOpen - Include open alerts in notification (default:
true
) - Notify
On boolResolved - Include resolved alerts in notification
- Notify
On boolSnoozed - Include snoozed alerts in notification
- Policies []string
- List of specific policies to scan
- Policy
Labels []string - List of policy labels
- Scan
All bool - Scan all policies
- target
Alert
Rule Target - Model for the target filter, as defined below
- alert
Rule StringId - allow
Auto BooleanRemediate - Allow auto-remediation
- delay
Notification DoubleMs - Delay notifications by the specified miliseconds
- deleted Boolean
- (bool) Deleted
- description String
- Description
- enabled Boolean
- Enabled (default:
true
) - excluded
Policies List<String> - List of policies to exclude from scan
- name String
- Rule/Scan name
- notification
Configs List<AlertRule Notification Config> - List of data for notifications to third-party tools, as defined below
- notify
On BooleanDismissed - Include dismissed alerts in notification
- notify
On BooleanOpen - Include open alerts in notification (default:
true
) - notify
On BooleanResolved - Include resolved alerts in notification
- notify
On BooleanSnoozed - Include snoozed alerts in notification
- policies List<String>
- List of specific policies to scan
- policy
Labels List<String> - List of policy labels
- scan
All Boolean - Scan all policies
- target
Alert
Rule Target - Model for the target filter, as defined below
- alert
Rule stringId - allow
Auto booleanRemediate - Allow auto-remediation
- delay
Notification numberMs - Delay notifications by the specified miliseconds
- deleted boolean
- (bool) Deleted
- description string
- Description
- enabled boolean
- Enabled (default:
true
) - excluded
Policies string[] - List of policies to exclude from scan
- name string
- Rule/Scan name
- notification
Configs AlertRule Notification Config[] - List of data for notifications to third-party tools, as defined below
- notify
On booleanDismissed - Include dismissed alerts in notification
- notify
On booleanOpen - Include open alerts in notification (default:
true
) - notify
On booleanResolved - Include resolved alerts in notification
- notify
On booleanSnoozed - Include snoozed alerts in notification
- policies string[]
- List of specific policies to scan
- policy
Labels string[] - List of policy labels
- scan
All boolean - Scan all policies
- target
Alert
Rule Target Args - Model for the target filter, as defined below
- alert_
rule_ strid - allow_
auto_ boolremediate - Allow auto-remediation
- delay_
notification_ floatms - Delay notifications by the specified miliseconds
- deleted bool
- (bool) Deleted
- description str
- Description
- enabled bool
- Enabled (default:
true
) - excluded_
policies Sequence[str] - List of policies to exclude from scan
- name str
- Rule/Scan name
- notification_
configs Sequence[AlertRule Notification Config Args] - List of data for notifications to third-party tools, as defined below
- notify_
on_ booldismissed - Include dismissed alerts in notification
- notify_
on_ boolopen - Include open alerts in notification (default:
true
) - notify_
on_ boolresolved - Include resolved alerts in notification
- notify_
on_ boolsnoozed - Include snoozed alerts in notification
- policies Sequence[str]
- List of specific policies to scan
- policy_
labels Sequence[str] - List of policy labels
- scan_
all bool - Scan all policies
- target Property Map
- Model for the target filter, as defined below
- alert
Rule StringId - allow
Auto BooleanRemediate - Allow auto-remediation
- delay
Notification NumberMs - Delay notifications by the specified miliseconds
- deleted Boolean
- (bool) Deleted
- description String
- Description
- enabled Boolean
- Enabled (default:
true
) - excluded
Policies List<String> - List of policies to exclude from scan
- name String
- Rule/Scan name
- notification
Configs List<Property Map> - List of data for notifications to third-party tools, as defined below
- notify
On BooleanDismissed - Include dismissed alerts in notification
- notify
On BooleanOpen - Include open alerts in notification (default:
true
) - notify
On BooleanResolved - Include resolved alerts in notification
- notify
On BooleanSnoozed - Include snoozed alerts in notification
- policies List<String>
- List of specific policies to scan
- policy
Labels List<String> - List of policy labels
- scan
All Boolean - Scan all policies
Outputs
All input properties are implicitly available as output properties. Additionally, the AlertRule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringBy - Last modified by
- Last
Modified doubleOn - (int) Last modified on
- Notification
Channels List<string> - List of notification channels
- Open
Alerts doubleCount - (int) Open alerts count
- Owner string
- Owner
- Policy
Scan stringConfig Id - Policy scan config ID
- Read
Only bool - (bool) Read only
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringBy - Last modified by
- Last
Modified float64On - (int) Last modified on
- Notification
Channels []string - List of notification channels
- Open
Alerts float64Count - (int) Open alerts count
- Owner string
- Owner
- Policy
Scan stringConfig Id - Policy scan config ID
- Read
Only bool - (bool) Read only
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringBy - Last modified by
- last
Modified DoubleOn - (int) Last modified on
- notification
Channels List<String> - List of notification channels
- open
Alerts DoubleCount - (int) Open alerts count
- owner String
- Owner
- policy
Scan StringConfig Id - Policy scan config ID
- read
Only Boolean - (bool) Read only
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringBy - Last modified by
- last
Modified numberOn - (int) Last modified on
- notification
Channels string[] - List of notification channels
- open
Alerts numberCount - (int) Open alerts count
- owner string
- Owner
- policy
Scan stringConfig Id - Policy scan config ID
- read
Only boolean - (bool) Read only
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strby - Last modified by
- last_
modified_ floaton - (int) Last modified on
- notification_
channels Sequence[str] - List of notification channels
- open_
alerts_ floatcount - (int) Open alerts count
- owner str
- Owner
- policy_
scan_ strconfig_ id - Policy scan config ID
- read_
only bool - (bool) Read only
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringBy - Last modified by
- last
Modified NumberOn - (int) Last modified on
- notification
Channels List<String> - List of notification channels
- open
Alerts NumberCount - (int) Open alerts count
- owner String
- Owner
- policy
Scan StringConfig Id - Policy scan config ID
- read
Only Boolean - (bool) Read only
Look up Existing AlertRule Resource
Get an existing AlertRule 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?: AlertRuleState, opts?: CustomResourceOptions): AlertRule
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alert_rule_id: Optional[str] = None,
allow_auto_remediate: Optional[bool] = None,
delay_notification_ms: Optional[float] = None,
deleted: Optional[bool] = None,
description: Optional[str] = None,
enabled: Optional[bool] = None,
excluded_policies: Optional[Sequence[str]] = None,
last_modified_by: Optional[str] = None,
last_modified_on: Optional[float] = None,
name: Optional[str] = None,
notification_channels: Optional[Sequence[str]] = None,
notification_configs: Optional[Sequence[AlertRuleNotificationConfigArgs]] = None,
notify_on_dismissed: Optional[bool] = None,
notify_on_open: Optional[bool] = None,
notify_on_resolved: Optional[bool] = None,
notify_on_snoozed: Optional[bool] = None,
open_alerts_count: Optional[float] = None,
owner: Optional[str] = None,
policies: Optional[Sequence[str]] = None,
policy_labels: Optional[Sequence[str]] = None,
policy_scan_config_id: Optional[str] = None,
read_only: Optional[bool] = None,
scan_all: Optional[bool] = None,
target: Optional[AlertRuleTargetArgs] = None) -> AlertRule
func GetAlertRule(ctx *Context, name string, id IDInput, state *AlertRuleState, opts ...ResourceOption) (*AlertRule, error)
public static AlertRule Get(string name, Input<string> id, AlertRuleState? state, CustomResourceOptions? opts = null)
public static AlertRule get(String name, Output<String> id, AlertRuleState state, CustomResourceOptions options)
resources: _: type: prismacloud:AlertRule get: id: ${id}
- 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.
- Alert
Rule stringId - Allow
Auto boolRemediate - Allow auto-remediation
- Delay
Notification doubleMs - Delay notifications by the specified miliseconds
- Deleted bool
- (bool) Deleted
- Description string
- Description
- Enabled bool
- Enabled (default:
true
) - Excluded
Policies List<string> - List of policies to exclude from scan
- Last
Modified stringBy - Last modified by
- Last
Modified doubleOn - (int) Last modified on
- Name string
- Rule/Scan name
- Notification
Channels List<string> - List of notification channels
- Notification
Configs List<AlertRule Notification Config> - List of data for notifications to third-party tools, as defined below
- Notify
On boolDismissed - Include dismissed alerts in notification
- Notify
On boolOpen - Include open alerts in notification (default:
true
) - Notify
On boolResolved - Include resolved alerts in notification
- Notify
On boolSnoozed - Include snoozed alerts in notification
- Open
Alerts doubleCount - (int) Open alerts count
- Owner string
- Owner
- Policies List<string>
- List of specific policies to scan
- Policy
Labels List<string> - List of policy labels
- Policy
Scan stringConfig Id - Policy scan config ID
- Read
Only bool - (bool) Read only
- Scan
All bool - Scan all policies
- Target
Alert
Rule Target - Model for the target filter, as defined below
- Alert
Rule stringId - Allow
Auto boolRemediate - Allow auto-remediation
- Delay
Notification float64Ms - Delay notifications by the specified miliseconds
- Deleted bool
- (bool) Deleted
- Description string
- Description
- Enabled bool
- Enabled (default:
true
) - Excluded
Policies []string - List of policies to exclude from scan
- Last
Modified stringBy - Last modified by
- Last
Modified float64On - (int) Last modified on
- Name string
- Rule/Scan name
- Notification
Channels []string - List of notification channels
- Notification
Configs []AlertRule Notification Config Args - List of data for notifications to third-party tools, as defined below
- Notify
On boolDismissed - Include dismissed alerts in notification
- Notify
On boolOpen - Include open alerts in notification (default:
true
) - Notify
On boolResolved - Include resolved alerts in notification
- Notify
On boolSnoozed - Include snoozed alerts in notification
- Open
Alerts float64Count - (int) Open alerts count
- Owner string
- Owner
- Policies []string
- List of specific policies to scan
- Policy
Labels []string - List of policy labels
- Policy
Scan stringConfig Id - Policy scan config ID
- Read
Only bool - (bool) Read only
- Scan
All bool - Scan all policies
- Target
Alert
Rule Target Args - Model for the target filter, as defined below
- alert
Rule StringId - allow
Auto BooleanRemediate - Allow auto-remediation
- delay
Notification DoubleMs - Delay notifications by the specified miliseconds
- deleted Boolean
- (bool) Deleted
- description String
- Description
- enabled Boolean
- Enabled (default:
true
) - excluded
Policies List<String> - List of policies to exclude from scan
- last
Modified StringBy - Last modified by
- last
Modified DoubleOn - (int) Last modified on
- name String
- Rule/Scan name
- notification
Channels List<String> - List of notification channels
- notification
Configs List<AlertRule Notification Config> - List of data for notifications to third-party tools, as defined below
- notify
On BooleanDismissed - Include dismissed alerts in notification
- notify
On BooleanOpen - Include open alerts in notification (default:
true
) - notify
On BooleanResolved - Include resolved alerts in notification
- notify
On BooleanSnoozed - Include snoozed alerts in notification
- open
Alerts DoubleCount - (int) Open alerts count
- owner String
- Owner
- policies List<String>
- List of specific policies to scan
- policy
Labels List<String> - List of policy labels
- policy
Scan StringConfig Id - Policy scan config ID
- read
Only Boolean - (bool) Read only
- scan
All Boolean - Scan all policies
- target
Alert
Rule Target - Model for the target filter, as defined below
- alert
Rule stringId - allow
Auto booleanRemediate - Allow auto-remediation
- delay
Notification numberMs - Delay notifications by the specified miliseconds
- deleted boolean
- (bool) Deleted
- description string
- Description
- enabled boolean
- Enabled (default:
true
) - excluded
Policies string[] - List of policies to exclude from scan
- last
Modified stringBy - Last modified by
- last
Modified numberOn - (int) Last modified on
- name string
- Rule/Scan name
- notification
Channels string[] - List of notification channels
- notification
Configs AlertRule Notification Config[] - List of data for notifications to third-party tools, as defined below
- notify
On booleanDismissed - Include dismissed alerts in notification
- notify
On booleanOpen - Include open alerts in notification (default:
true
) - notify
On booleanResolved - Include resolved alerts in notification
- notify
On booleanSnoozed - Include snoozed alerts in notification
- open
Alerts numberCount - (int) Open alerts count
- owner string
- Owner
- policies string[]
- List of specific policies to scan
- policy
Labels string[] - List of policy labels
- policy
Scan stringConfig Id - Policy scan config ID
- read
Only boolean - (bool) Read only
- scan
All boolean - Scan all policies
- target
Alert
Rule Target - Model for the target filter, as defined below
- alert_
rule_ strid - allow_
auto_ boolremediate - Allow auto-remediation
- delay_
notification_ floatms - Delay notifications by the specified miliseconds
- deleted bool
- (bool) Deleted
- description str
- Description
- enabled bool
- Enabled (default:
true
) - excluded_
policies Sequence[str] - List of policies to exclude from scan
- last_
modified_ strby - Last modified by
- last_
modified_ floaton - (int) Last modified on
- name str
- Rule/Scan name
- notification_
channels Sequence[str] - List of notification channels
- notification_
configs Sequence[AlertRule Notification Config Args] - List of data for notifications to third-party tools, as defined below
- notify_
on_ booldismissed - Include dismissed alerts in notification
- notify_
on_ boolopen - Include open alerts in notification (default:
true
) - notify_
on_ boolresolved - Include resolved alerts in notification
- notify_
on_ boolsnoozed - Include snoozed alerts in notification
- open_
alerts_ floatcount - (int) Open alerts count
- owner str
- Owner
- policies Sequence[str]
- List of specific policies to scan
- policy_
labels Sequence[str] - List of policy labels
- policy_
scan_ strconfig_ id - Policy scan config ID
- read_
only bool - (bool) Read only
- scan_
all bool - Scan all policies
- target
Alert
Rule Target Args - Model for the target filter, as defined below
- alert
Rule StringId - allow
Auto BooleanRemediate - Allow auto-remediation
- delay
Notification NumberMs - Delay notifications by the specified miliseconds
- deleted Boolean
- (bool) Deleted
- description String
- Description
- enabled Boolean
- Enabled (default:
true
) - excluded
Policies List<String> - List of policies to exclude from scan
- last
Modified StringBy - Last modified by
- last
Modified NumberOn - (int) Last modified on
- name String
- Rule/Scan name
- notification
Channels List<String> - List of notification channels
- notification
Configs List<Property Map> - List of data for notifications to third-party tools, as defined below
- notify
On BooleanDismissed - Include dismissed alerts in notification
- notify
On BooleanOpen - Include open alerts in notification (default:
true
) - notify
On BooleanResolved - Include resolved alerts in notification
- notify
On BooleanSnoozed - Include snoozed alerts in notification
- open
Alerts NumberCount - (int) Open alerts count
- owner String
- Owner
- policies List<String>
- List of specific policies to scan
- policy
Labels List<String> - List of policy labels
- policy
Scan StringConfig Id - Policy scan config ID
- read
Only Boolean - (bool) Read only
- scan
All Boolean - Scan all policies
- target Property Map
- Model for the target filter, as defined below
Supporting Types
AlertRuleNotificationConfig, AlertRuleNotificationConfigArgs
- Config
Id string - Alert rule notification config ID
- Config
Type string - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- Day
Of doubleMonth - (int) Day of month
- Days
Of List<AlertWeeks Rule Notification Config Days Of Week> - List of days of week, as defined below
- Detailed
Report bool - Provide CSV detailed report
- Enabled bool
- Scan enabled
- Frequency string
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - Frequency
From stringRRule - Frequency from R rule
- Hour
Of doubleDay - (int) Hour of day
- Include
Remediation bool - Include remediation in detailed report
- Last
Sent doubleTs - (int) Time of last notification in miliseconds
- Last
Updated double - (int) Last updated
- RRule
Schedule string - R rule schedule
- Recipients List<string>
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- Template
Id string - Template ID
- Timezone
Id string - Timezone ID
- With
Compression bool - Compress detailed report
- Config
Id string - Alert rule notification config ID
- Config
Type string - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- Day
Of float64Month - (int) Day of month
- Days
Of []AlertWeeks Rule Notification Config Days Of Week - List of days of week, as defined below
- Detailed
Report bool - Provide CSV detailed report
- Enabled bool
- Scan enabled
- Frequency string
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - Frequency
From stringRRule - Frequency from R rule
- Hour
Of float64Day - (int) Hour of day
- Include
Remediation bool - Include remediation in detailed report
- Last
Sent float64Ts - (int) Time of last notification in miliseconds
- Last
Updated float64 - (int) Last updated
- RRule
Schedule string - R rule schedule
- Recipients []string
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- Template
Id string - Template ID
- Timezone
Id string - Timezone ID
- With
Compression bool - Compress detailed report
- config
Id String - Alert rule notification config ID
- config
Type String - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- day
Of DoubleMonth - (int) Day of month
- days
Of List<AlertWeeks Rule Notification Config Days Of Week> - List of days of week, as defined below
- detailed
Report Boolean - Provide CSV detailed report
- enabled Boolean
- Scan enabled
- frequency String
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - frequency
From StringRRule - Frequency from R rule
- hour
Of DoubleDay - (int) Hour of day
- include
Remediation Boolean - Include remediation in detailed report
- last
Sent DoubleTs - (int) Time of last notification in miliseconds
- last
Updated Double - (int) Last updated
- r
Rule StringSchedule - R rule schedule
- recipients List<String>
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- template
Id String - Template ID
- timezone
Id String - Timezone ID
- with
Compression Boolean - Compress detailed report
- config
Id string - Alert rule notification config ID
- config
Type string - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- day
Of numberMonth - (int) Day of month
- days
Of AlertWeeks Rule Notification Config Days Of Week[] - List of days of week, as defined below
- detailed
Report boolean - Provide CSV detailed report
- enabled boolean
- Scan enabled
- frequency string
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - frequency
From stringRRule - Frequency from R rule
- hour
Of numberDay - (int) Hour of day
- include
Remediation boolean - Include remediation in detailed report
- last
Sent numberTs - (int) Time of last notification in miliseconds
- last
Updated number - (int) Last updated
- r
Rule stringSchedule - R rule schedule
- recipients string[]
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- template
Id string - Template ID
- timezone
Id string - Timezone ID
- with
Compression boolean - Compress detailed report
- config_
id str - Alert rule notification config ID
- config_
type str - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- day_
of_ floatmonth - (int) Day of month
- days_
of_ Sequence[Alertweeks Rule Notification Config Days Of Week] - List of days of week, as defined below
- detailed_
report bool - Provide CSV detailed report
- enabled bool
- Scan enabled
- frequency str
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - frequency_
from_ strr_ rule - Frequency from R rule
- hour_
of_ floatday - (int) Hour of day
- include_
remediation bool - Include remediation in detailed report
- last_
sent_ floatts - (int) Time of last notification in miliseconds
- last_
updated float - (int) Last updated
- r_
rule_ strschedule - R rule schedule
- recipients Sequence[str]
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- template_
id str - Template ID
- timezone_
id str - Timezone ID
- with_
compression bool - Compress detailed report
- config
Id String - Alert rule notification config ID
- config
Type String - Config type. Valid values are
email
,slack
,splunk
,amazon_sqs
,microsoft_teams
,jira
,webhook
,aws_security_hub
,google_cscc
,service_now
,pager_duty
,aws_s3
,snowflake
ordemisto
- day
Of NumberMonth - (int) Day of month
- days
Of List<Property Map>Weeks - List of days of week, as defined below
- detailed
Report Boolean - Provide CSV detailed report
- enabled Boolean
- Scan enabled
- frequency String
- Frequency. Valid values are
as_it_happens
,daily
,weekly
, ormonthly
. - frequency
From StringRRule - Frequency from R rule
- hour
Of NumberDay - (int) Hour of day
- include
Remediation Boolean - Include remediation in detailed report
- last
Sent NumberTs - (int) Time of last notification in miliseconds
- last
Updated Number - (int) Last updated
- r
Rule StringSchedule - R rule schedule
- recipients List<String>
- List of unique email addresses to notify (For email notifications), List of integration ids (For integrations without notification templates), or List of notification template ids (For integrations with notification templates)
- template
Id String - Template ID
- timezone
Id String - Timezone ID
- with
Compression Boolean - Compress detailed report
AlertRuleNotificationConfigDaysOfWeek, AlertRuleNotificationConfigDaysOfWeekArgs
AlertRuleTarget, AlertRuleTargetArgs
- Account
Groups List<string> - List of account groups
- Alert
Rule List<AlertPolicy Filters Rule Target Alert Rule Policy Filter> - Model for Alert Rule Policy Filter, as defined below
- Excluded
Accounts List<string> - List of excluded accounts
- Regions List<string>
- List of regions
- Resource
Lists List<AlertRule Target Resource List> - Model for holding the resource list for compute access groups below
- List<Alert
Rule Target Tag> - List of tag models, as defined below
- Account
Groups []string - List of account groups
- Alert
Rule []AlertPolicy Filters Rule Target Alert Rule Policy Filter - Model for Alert Rule Policy Filter, as defined below
- Excluded
Accounts []string - List of excluded accounts
- Regions []string
- List of regions
- Resource
Lists []AlertRule Target Resource List - Model for holding the resource list for compute access groups below
- []Alert
Rule Target Tag - List of tag models, as defined below
- account
Groups List<String> - List of account groups
- alert
Rule List<AlertPolicy Filters Rule Target Alert Rule Policy Filter> - Model for Alert Rule Policy Filter, as defined below
- excluded
Accounts List<String> - List of excluded accounts
- regions List<String>
- List of regions
- resource
Lists List<AlertRule Target Resource List> - Model for holding the resource list for compute access groups below
- List<Alert
Rule Target Tag> - List of tag models, as defined below
- account
Groups string[] - List of account groups
- alert
Rule AlertPolicy Filters Rule Target Alert Rule Policy Filter[] - Model for Alert Rule Policy Filter, as defined below
- excluded
Accounts string[] - List of excluded accounts
- regions string[]
- List of regions
- resource
Lists AlertRule Target Resource List[] - Model for holding the resource list for compute access groups below
- Alert
Rule Target Tag[] - List of tag models, as defined below
- account_
groups Sequence[str] - List of account groups
- alert_
rule_ Sequence[Alertpolicy_ filters Rule Target Alert Rule Policy Filter] - Model for Alert Rule Policy Filter, as defined below
- excluded_
accounts Sequence[str] - List of excluded accounts
- regions Sequence[str]
- List of regions
- resource_
lists Sequence[AlertRule Target Resource List] - Model for holding the resource list for compute access groups below
- Sequence[Alert
Rule Target Tag] - List of tag models, as defined below
- account
Groups List<String> - List of account groups
- alert
Rule List<Property Map>Policy Filters - Model for Alert Rule Policy Filter, as defined below
- excluded
Accounts List<String> - List of excluded accounts
- regions List<String>
- List of regions
- resource
Lists List<Property Map> - Model for holding the resource list for compute access groups below
- List<Property Map>
- List of tag models, as defined below
AlertRuleTargetAlertRulePolicyFilter, AlertRuleTargetAlertRulePolicyFilterArgs
- Cloud
Types List<string> - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - Policy
Compliance List<string>Standards - Compliance Standard name.
- Policy
Labels List<string> - Policy Label.
- Policy
Severities List<string> - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
- Cloud
Types []string - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - Policy
Compliance []stringStandards - Compliance Standard name.
- Policy
Labels []string - Policy Label.
- Policy
Severities []string - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
- cloud
Types List<String> - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - policy
Compliance List<String>Standards - Compliance Standard name.
- policy
Labels List<String> - Policy Label.
- policy
Severities List<String> - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
- cloud
Types string[] - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - policy
Compliance string[]Standards - Compliance Standard name.
- policy
Labels string[] - Policy Label.
- policy
Severities string[] - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
- cloud_
types Sequence[str] - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - policy_
compliance_ Sequence[str]standards - Compliance Standard name.
- policy_
labels Sequence[str] - Policy Label.
- policy_
severities Sequence[str] - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
- cloud
Types List<String> - Cloud Type. Valid values are
aws
,alibaba_cloud
,azure
,gcp
,ibm
,oci
. - policy
Compliance List<String>Standards - Compliance Standard name.
- policy
Labels List<String> - Policy Label.
- policy
Severities List<String> - Policy Severity. Valid values are
LOW
,MEDIUM
,HIGH
,CRITICAL
,INFORMATIONAL
.
AlertRuleTargetResourceList, AlertRuleTargetResourceListArgs
- Compute
Access List<string>Group Ids - List of compute access group ids
- Compute
Access []stringGroup Ids - List of compute access group ids
- compute
Access List<String>Group Ids - List of compute access group ids
- compute
Access string[]Group Ids - List of compute access group ids
- compute_
access_ Sequence[str]group_ ids - List of compute access group ids
- compute
Access List<String>Group Ids - List of compute access group ids
AlertRuleTargetTag, AlertRuleTargetTagArgs
Import
Resources can be imported using the policy scan config ID:
$ pulumi import prismacloud:index/alertRule:AlertRule example 11111111-2222-3333-4444-555555555555
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- prismacloud paloaltonetworks/terraform-provider-prismacloud
- License
- Notes
- This Pulumi package is based on the
prismacloud
Terraform Provider.