Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.splunk.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.splunk.inputs.SavedSearchesAclArgs;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class SavedSearchesState extends com.pulumi.resources.ResourceArgs {
public static final SavedSearchesState Empty = new SavedSearchesState();
/**
* The app/user context that is the namespace for the resource
*
*/
@Import(name="acl")
private @Nullable Output acl;
/**
* @return The app/user context that is the namespace for the resource
*
*/
public Optional> acl() {
return Optional.ofNullable(this.acl);
}
/**
* Enable XSOAR alerting (Should by 1 (Enabled) or 0 (Disabled))
*
*/
@Import(name="actionCreateXsoarIncident")
private @Nullable Output actionCreateXsoarIncident;
/**
* @return Enable XSOAR alerting (Should by 1 (Enabled) or 0 (Disabled))
*
*/
public Optional> actionCreateXsoarIncident() {
return Optional.ofNullable(this.actionCreateXsoarIncident);
}
/**
* XSOAR custom incident fields (should be a comma separated list)
*
*/
@Import(name="actionCreateXsoarIncidentParamCustomFields")
private @Nullable Output actionCreateXsoarIncidentParamCustomFields;
/**
* @return XSOAR custom incident fields (should be a comma separated list)
*
*/
public Optional> actionCreateXsoarIncidentParamCustomFields() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamCustomFields);
}
/**
* XSOAR incident description
*
*/
@Import(name="actionCreateXsoarIncidentParamDetails")
private @Nullable Output actionCreateXsoarIncidentParamDetails;
/**
* @return XSOAR incident description
*
*/
public Optional> actionCreateXsoarIncidentParamDetails() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamDetails);
}
/**
* XSOAR incident name
*
*/
@Import(name="actionCreateXsoarIncidentParamIncidentName")
private @Nullable Output actionCreateXsoarIncidentParamIncidentName;
/**
* @return XSOAR incident name
*
*/
public Optional> actionCreateXsoarIncidentParamIncidentName() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamIncidentName);
}
/**
* XSOAR incident time
*
*/
@Import(name="actionCreateXsoarIncidentParamOccurred")
private @Nullable Output actionCreateXsoarIncidentParamOccurred;
/**
* @return XSOAR incident time
*
*/
public Optional> actionCreateXsoarIncidentParamOccurred() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamOccurred);
}
/**
* Enable XSOAR alerting sending to all servers (Should by 1 (Enabled) or 0 (Disabled)
*
*/
@Import(name="actionCreateXsoarIncidentParamSendAllServers")
private @Nullable Output actionCreateXsoarIncidentParamSendAllServers;
/**
* @return Enable XSOAR alerting sending to all servers (Should by 1 (Enabled) or 0 (Disabled)
*
*/
public Optional> actionCreateXsoarIncidentParamSendAllServers() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamSendAllServers);
}
/**
* XSOAR Server instance URL (Should start with https:// || http://)
*
*/
@Import(name="actionCreateXsoarIncidentParamServerUrl")
private @Nullable Output actionCreateXsoarIncidentParamServerUrl;
/**
* @return XSOAR Server instance URL (Should start with https:// || http://)
*
*/
public Optional> actionCreateXsoarIncidentParamServerUrl() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamServerUrl);
}
/**
* XSOAR Severity (1 - Low, 2 - Medium, 3 - High, 4 - Critical)
*
*/
@Import(name="actionCreateXsoarIncidentParamSeverity")
private @Nullable Output actionCreateXsoarIncidentParamSeverity;
/**
* @return XSOAR Severity (1 - Low, 2 - Medium, 3 - High, 4 - Critical)
*
*/
public Optional> actionCreateXsoarIncidentParamSeverity() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamSeverity);
}
/**
* XSOAR incident type
*
*/
@Import(name="actionCreateXsoarIncidentParamType")
private @Nullable Output actionCreateXsoarIncidentParamType;
/**
* @return XSOAR incident type
*
*/
public Optional> actionCreateXsoarIncidentParamType() {
return Optional.ofNullable(this.actionCreateXsoarIncidentParamType);
}
/**
* The state of the email action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
@Import(name="actionEmail")
private @Nullable Output actionEmail;
/**
* @return The state of the email action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
public Optional> actionEmail() {
return Optional.ofNullable(this.actionEmail);
}
/**
* The password to use when authenticating with the SMTP server. Normally this value is set when editing the email settings, however you can set a clear text password here and it is encrypted on the next platform restart.Defaults to empty string.
*
*/
@Import(name="actionEmailAuthPassword")
private @Nullable Output actionEmailAuthPassword;
/**
* @return The password to use when authenticating with the SMTP server. Normally this value is set when editing the email settings, however you can set a clear text password here and it is encrypted on the next platform restart.Defaults to empty string.
*
*/
public Optional> actionEmailAuthPassword() {
return Optional.ofNullable(this.actionEmailAuthPassword);
}
/**
* The username to use when authenticating with the SMTP server. If this is empty string, no authentication is attempted. Defaults to empty stringNOTE: Your SMTP server might reject unauthenticated emails.
*
*/
@Import(name="actionEmailAuthUsername")
private @Nullable Output actionEmailAuthUsername;
/**
* @return The username to use when authenticating with the SMTP server. If this is empty string, no authentication is attempted. Defaults to empty stringNOTE: Your SMTP server might reject unauthenticated emails.
*
*/
public Optional> actionEmailAuthUsername() {
return Optional.ofNullable(this.actionEmailAuthUsername);
}
/**
* BCC email address to use if action.email is enabled.
*
*/
@Import(name="actionEmailBcc")
private @Nullable Output actionEmailBcc;
/**
* @return BCC email address to use if action.email is enabled.
*
*/
public Optional> actionEmailBcc() {
return Optional.ofNullable(this.actionEmailBcc);
}
/**
* CC email address to use if action.email is enabled.
*
*/
@Import(name="actionEmailCc")
private @Nullable Output actionEmailCc;
/**
* @return CC email address to use if action.email is enabled.
*
*/
public Optional> actionEmailCc() {
return Optional.ofNullable(this.actionEmailCc);
}
/**
* The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
@Import(name="actionEmailCommand")
private @Nullable Output actionEmailCommand;
/**
* @return The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
public Optional> actionEmailCommand() {
return Optional.ofNullable(this.actionEmailCommand);
}
/**
* Valid values: (table | plain | html | raw | csv)Specify the format of text in the email. This value also applies to any attachments.
*
*/
@Import(name="actionEmailFormat")
private @Nullable Output actionEmailFormat;
/**
* @return Valid values: (table | plain | html | raw | csv)Specify the format of text in the email. This value also applies to any attachments.
*
*/
public Optional> actionEmailFormat() {
return Optional.ofNullable(this.actionEmailFormat);
}
/**
* Email address from which the email action originates.Defaults to splunk@$LOCALHOST or whatever value is set in alert_actions.conf.
*
*/
@Import(name="actionEmailFrom")
private @Nullable Output actionEmailFrom;
/**
* @return Email address from which the email action originates.Defaults to splunk@$LOCALHOST or whatever value is set in alert_actions.conf.
*
*/
public Optional> actionEmailFrom() {
return Optional.ofNullable(this.actionEmailFrom);
}
/**
* Sets the hostname used in the web link (url) sent in email actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)
*
*/
@Import(name="actionEmailHostname")
private @Nullable Output actionEmailHostname;
/**
* @return Sets the hostname used in the web link (url) sent in email actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)
*
*/
public Optional> actionEmailHostname() {
return Optional.ofNullable(this.actionEmailHostname);
}
/**
* Specify whether to include a link to the results. Defaults to 0.
*
*/
@Import(name="actionEmailIncludeResultsLink")
private @Nullable Output actionEmailIncludeResultsLink;
/**
* @return Specify whether to include a link to the results. Defaults to 0.
*
*/
public Optional> actionEmailIncludeResultsLink() {
return Optional.ofNullable(this.actionEmailIncludeResultsLink);
}
/**
* Specify whether to include the search that caused an email to be sent. Defaults to 0.
*
*/
@Import(name="actionEmailIncludeSearch")
private @Nullable Output actionEmailIncludeSearch;
/**
* @return Specify whether to include the search that caused an email to be sent. Defaults to 0.
*
*/
public Optional> actionEmailIncludeSearch() {
return Optional.ofNullable(this.actionEmailIncludeSearch);
}
/**
* Specify whether to show the trigger condition that caused the alert to fire. Defaults to 0.
*
*/
@Import(name="actionEmailIncludeTrigger")
private @Nullable Output actionEmailIncludeTrigger;
/**
* @return Specify whether to show the trigger condition that caused the alert to fire. Defaults to 0.
*
*/
public Optional> actionEmailIncludeTrigger() {
return Optional.ofNullable(this.actionEmailIncludeTrigger);
}
/**
* Specify whether to show the time that the alert was fired. Defaults to 0.
*
*/
@Import(name="actionEmailIncludeTriggerTime")
private @Nullable Output actionEmailIncludeTriggerTime;
/**
* @return Specify whether to show the time that the alert was fired. Defaults to 0.
*
*/
public Optional> actionEmailIncludeTriggerTime() {
return Optional.ofNullable(this.actionEmailIncludeTriggerTime);
}
/**
* Specify whether to show the title and a link to enable the user to edit the saved search. Defaults to 0.
*
*/
@Import(name="actionEmailIncludeViewLink")
private @Nullable Output actionEmailIncludeViewLink;
/**
* @return Specify whether to show the title and a link to enable the user to edit the saved search. Defaults to 0.
*
*/
public Optional> actionEmailIncludeViewLink() {
return Optional.ofNullable(this.actionEmailIncludeViewLink);
}
/**
* Indicates whether the search results are contained in the body of the email.Results can be either inline or attached to an email.
*
*/
@Import(name="actionEmailInline")
private @Nullable Output actionEmailInline;
/**
* @return Indicates whether the search results are contained in the body of the email.Results can be either inline or attached to an email.
*
*/
public Optional> actionEmailInline() {
return Optional.ofNullable(this.actionEmailInline);
}
/**
* Set the address of the MTA server to be used to send the emails.Defaults to <LOCALHOST> or whatever is set in alert_actions.conf.
*
*/
@Import(name="actionEmailMailserver")
private @Nullable Output actionEmailMailserver;
/**
* @return Set the address of the MTA server to be used to send the emails.Defaults to <LOCALHOST> or whatever is set in alert_actions.conf.
*
*/
public Optional> actionEmailMailserver() {
return Optional.ofNullable(this.actionEmailMailserver);
}
/**
* Sets the global maximum number of search results to send when email.action is enabled. Defaults to 100.
*
*/
@Import(name="actionEmailMaxResults")
private @Nullable Output actionEmailMaxResults;
/**
* @return Sets the global maximum number of search results to send when email.action is enabled. Defaults to 100.
*
*/
public Optional> actionEmailMaxResults() {
return Optional.ofNullable(this.actionEmailMaxResults);
}
/**
* Valid values are Integer[m|s|h|d].Specifies the maximum amount of time the execution of an email action takes before the action is aborted. Defaults to 5m.
*
*/
@Import(name="actionEmailMaxTime")
private @Nullable Output actionEmailMaxTime;
/**
* @return Valid values are Integer[m|s|h|d].Specifies the maximum amount of time the execution of an email action takes before the action is aborted. Defaults to 5m.
*
*/
public Optional> actionEmailMaxTime() {
return Optional.ofNullable(this.actionEmailMaxTime);
}
/**
* Customize the message sent in the emailed alert. Defaults to: The alert condition for '$name$' was triggered.
*
*/
@Import(name="actionEmailMessageAlert")
private @Nullable Output actionEmailMessageAlert;
/**
* @return Customize the message sent in the emailed alert. Defaults to: The alert condition for '$name$' was triggered.
*
*/
public Optional> actionEmailMessageAlert() {
return Optional.ofNullable(this.actionEmailMessageAlert);
}
/**
* Customize the message sent in the emailed report. Defaults to: The scheduled report '$name$' has run
*
*/
@Import(name="actionEmailMessageReport")
private @Nullable Output actionEmailMessageReport;
/**
* @return Customize the message sent in the emailed report. Defaults to: The scheduled report '$name$' has run
*
*/
public Optional> actionEmailMessageReport() {
return Optional.ofNullable(this.actionEmailMessageReport);
}
/**
* The name of the view to deliver if sendpdf is enabled
*
*/
@Import(name="actionEmailPdfview")
private @Nullable Output actionEmailPdfview;
/**
* @return The name of the view to deliver if sendpdf is enabled
*
*/
public Optional> actionEmailPdfview() {
return Optional.ofNullable(this.actionEmailPdfview);
}
/**
* Search string to preprocess results before emailing them. Defaults to empty string (no preprocessing).Usually the preprocessing consists of filtering out unwanted internal fields.
*
*/
@Import(name="actionEmailPreprocessResults")
private @Nullable Output actionEmailPreprocessResults;
/**
* @return Search string to preprocess results before emailing them. Defaults to empty string (no preprocessing).Usually the preprocessing consists of filtering out unwanted internal fields.
*
*/
public Optional> actionEmailPreprocessResults() {
return Optional.ofNullable(this.actionEmailPreprocessResults);
}
/**
* Space-separated list. Specifies the set (and load order) of CID fonts for handling Simplified Chinese(gb), Traditional Chinese(cns), Japanese(jp), and Korean(kor) in Integrated PDF Rendering.If multiple fonts provide a glyph for a given character code, the glyph from the first font specified in the list is used.To skip loading any CID fonts, specify the empty string.Defaults to 'gb cns jp kor'
*
*/
@Import(name="actionEmailReportCidFontList")
private @Nullable Output actionEmailReportCidFontList;
/**
* @return Space-separated list. Specifies the set (and load order) of CID fonts for handling Simplified Chinese(gb), Traditional Chinese(cns), Japanese(jp), and Korean(kor) in Integrated PDF Rendering.If multiple fonts provide a glyph for a given character code, the glyph from the first font specified in the list is used.To skip loading any CID fonts, specify the empty string.Defaults to 'gb cns jp kor'
*
*/
public Optional> actionEmailReportCidFontList() {
return Optional.ofNullable(this.actionEmailReportCidFontList);
}
/**
* Indicates whether to include the Splunk logo with the report.
*
*/
@Import(name="actionEmailReportIncludeSplunkLogo")
private @Nullable Output actionEmailReportIncludeSplunkLogo;
/**
* @return Indicates whether to include the Splunk logo with the report.
*
*/
public Optional> actionEmailReportIncludeSplunkLogo() {
return Optional.ofNullable(this.actionEmailReportIncludeSplunkLogo);
}
/**
* Valid values: (portrait | landscape)Specifies the paper orientation: portrait or landscape. Defaults to portrait.
*
*/
@Import(name="actionEmailReportPaperOrientation")
private @Nullable Output actionEmailReportPaperOrientation;
/**
* @return Valid values: (portrait | landscape)Specifies the paper orientation: portrait or landscape. Defaults to portrait.
*
*/
public Optional> actionEmailReportPaperOrientation() {
return Optional.ofNullable(this.actionEmailReportPaperOrientation);
}
/**
* Valid values: (letter | legal | ledger | a2 | a3 | a4 | a5)Specifies the paper size for PDFs. Defaults to letter.
*
*/
@Import(name="actionEmailReportPaperSize")
private @Nullable Output actionEmailReportPaperSize;
/**
* @return Valid values: (letter | legal | ledger | a2 | a3 | a4 | a5)Specifies the paper size for PDFs. Defaults to letter.
*
*/
public Optional> actionEmailReportPaperSize() {
return Optional.ofNullable(this.actionEmailReportPaperSize);
}
/**
* No Supported
*
*/
@Import(name="actionEmailReportServerEnabled")
private @Nullable Output actionEmailReportServerEnabled;
/**
* @return No Supported
*
*/
public Optional> actionEmailReportServerEnabled() {
return Optional.ofNullable(this.actionEmailReportServerEnabled);
}
/**
* Not supported.For a default locally installed report server, the URL is http://localhost:8091/
*
*/
@Import(name="actionEmailReportServerUrl")
private @Nullable Output actionEmailReportServerUrl;
/**
* @return Not supported.For a default locally installed report server, the URL is http://localhost:8091/
*
*/
public Optional> actionEmailReportServerUrl() {
return Optional.ofNullable(this.actionEmailReportServerUrl);
}
/**
* Specify whether to send results as a CSV file. Defaults to 0.
*
*/
@Import(name="actionEmailSendCsv")
private @Nullable Output actionEmailSendCsv;
/**
* @return Specify whether to send results as a CSV file. Defaults to 0.
*
*/
public Optional> actionEmailSendCsv() {
return Optional.ofNullable(this.actionEmailSendCsv);
}
/**
* Indicates whether to create and send the results as a PDF. Defaults to false.
*
*/
@Import(name="actionEmailSendPdf")
private @Nullable Output actionEmailSendPdf;
/**
* @return Indicates whether to create and send the results as a PDF. Defaults to false.
*
*/
public Optional> actionEmailSendPdf() {
return Optional.ofNullable(this.actionEmailSendPdf);
}
/**
* Indicates whether to attach the search results in the email.Results can be either attached or inline. See action.email.inline.
*
*/
@Import(name="actionEmailSendResults")
private @Nullable Output actionEmailSendResults;
/**
* @return Indicates whether to attach the search results in the email.Results can be either attached or inline. See action.email.inline.
*
*/
public Optional> actionEmailSendResults() {
return Optional.ofNullable(this.actionEmailSendResults);
}
/**
* Specifies an alternate email subject.Defaults to SplunkAlert-<savedsearchname>.
*
*/
@Import(name="actionEmailSubject")
private @Nullable Output actionEmailSubject;
/**
* @return Specifies an alternate email subject.Defaults to SplunkAlert-<savedsearchname>.
*
*/
public Optional> actionEmailSubject() {
return Optional.ofNullable(this.actionEmailSubject);
}
/**
* A comma or semicolon separated list of recipient email addresses. Required if this search is scheduled and the email alert action is enabled.
*
*/
@Import(name="actionEmailTo")
private @Nullable Output actionEmailTo;
/**
* @return A comma or semicolon separated list of recipient email addresses. Required if this search is scheduled and the email alert action is enabled.
*
*/
public Optional> actionEmailTo() {
return Optional.ofNullable(this.actionEmailTo);
}
/**
* Indicates whether the execution of this action signifies a trackable alert.
*
*/
@Import(name="actionEmailTrackAlert")
private @Nullable Output actionEmailTrackAlert;
/**
* @return Indicates whether the execution of this action signifies a trackable alert.
*
*/
public Optional> actionEmailTrackAlert() {
return Optional.ofNullable(this.actionEmailTrackAlert);
}
/**
* Valid values are Integer[p].Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows <Integer>, int is the number of scheduled periods. Defaults to 86400 (24 hours).If no actions are triggered, the artifacts have their ttl determined by dispatch.ttl in savedsearches.conf.
*
*/
@Import(name="actionEmailTtl")
private @Nullable Output actionEmailTtl;
/**
* @return Valid values are Integer[p].Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows <Integer>, int is the number of scheduled periods. Defaults to 86400 (24 hours).If no actions are triggered, the artifacts have their ttl determined by dispatch.ttl in savedsearches.conf.
*
*/
public Optional> actionEmailTtl() {
return Optional.ofNullable(this.actionEmailTtl);
}
/**
* Indicates whether to use SSL when communicating with the SMTP server. Defaults to false.
*
*/
@Import(name="actionEmailUseSsl")
private @Nullable Output actionEmailUseSsl;
/**
* @return Indicates whether to use SSL when communicating with the SMTP server. Defaults to false.
*
*/
public Optional> actionEmailUseSsl() {
return Optional.ofNullable(this.actionEmailUseSsl);
}
/**
* Indicates whether to use TLS (transport layer security) when communicating with the SMTP server (starttls).Defaults to false.
*
*/
@Import(name="actionEmailUseTls")
private @Nullable Output actionEmailUseTls;
/**
* @return Indicates whether to use TLS (transport layer security) when communicating with the SMTP server (starttls).Defaults to false.
*
*/
public Optional> actionEmailUseTls() {
return Optional.ofNullable(this.actionEmailUseTls);
}
/**
* Indicates whether columns should be sorted from least wide to most wide, left to right.Only valid if format=text.
*
*/
@Import(name="actionEmailWidthSortColumns")
private @Nullable Output actionEmailWidthSortColumns;
/**
* @return Indicates whether columns should be sorted from least wide to most wide, left to right.Only valid if format=text.
*
*/
public Optional> actionEmailWidthSortColumns() {
return Optional.ofNullable(this.actionEmailWidthSortColumns);
}
/**
* Jira Service Desk account name
*
*/
@Import(name="actionJiraServiceDeskParamAccount")
private @Nullable Output actionJiraServiceDeskParamAccount;
/**
* @return Jira Service Desk account name
*
*/
public Optional> actionJiraServiceDeskParamAccount() {
return Optional.ofNullable(this.actionJiraServiceDeskParamAccount);
}
/**
* Jira issue description
*
*/
@Import(name="actionJiraServiceDeskParamJiraDescription")
private @Nullable Output actionJiraServiceDeskParamJiraDescription;
/**
* @return Jira issue description
*
*/
public Optional> actionJiraServiceDeskParamJiraDescription() {
return Optional.ofNullable(this.actionJiraServiceDeskParamJiraDescription);
}
/**
* Jira issue type name
*
*/
@Import(name="actionJiraServiceDeskParamJiraIssueType")
private @Nullable Output actionJiraServiceDeskParamJiraIssueType;
/**
* @return Jira issue type name
*
*/
public Optional> actionJiraServiceDeskParamJiraIssueType() {
return Optional.ofNullable(this.actionJiraServiceDeskParamJiraIssueType);
}
/**
* Jira priority of issue
*
*/
@Import(name="actionJiraServiceDeskParamJiraPriority")
private @Nullable Output actionJiraServiceDeskParamJiraPriority;
/**
* @return Jira priority of issue
*
*/
public Optional> actionJiraServiceDeskParamJiraPriority() {
return Optional.ofNullable(this.actionJiraServiceDeskParamJiraPriority);
}
/**
* Jira Project name
*
*/
@Import(name="actionJiraServiceDeskParamJiraProject")
private @Nullable Output actionJiraServiceDeskParamJiraProject;
/**
* @return Jira Project name
*
*/
public Optional> actionJiraServiceDeskParamJiraProject() {
return Optional.ofNullable(this.actionJiraServiceDeskParamJiraProject);
}
/**
* Jira issue title/summary
*
*/
@Import(name="actionJiraServiceDeskParamJiraSummary")
private @Nullable Output actionJiraServiceDeskParamJiraSummary;
/**
* @return Jira issue title/summary
*
*/
public Optional> actionJiraServiceDeskParamJiraSummary() {
return Optional.ofNullable(this.actionJiraServiceDeskParamJiraSummary);
}
/**
* The PagerDuty custom details information.
*
*/
@Import(name="actionPagerdutyCustomDetails")
private @Nullable Output actionPagerdutyCustomDetails;
/**
* @return The PagerDuty custom details information.
*
*/
public Optional> actionPagerdutyCustomDetails() {
return Optional.ofNullable(this.actionPagerdutyCustomDetails);
}
/**
* The PagerDuty integration Key.
*
*/
@Import(name="actionPagerdutyIntegrationKey")
private @Nullable Output actionPagerdutyIntegrationKey;
/**
* @return The PagerDuty integration Key.
*
*/
public Optional> actionPagerdutyIntegrationKey() {
return Optional.ofNullable(this.actionPagerdutyIntegrationKey);
}
/**
* The PagerDuty integration Key override.
*
*/
@Import(name="actionPagerdutyIntegrationKeyOverride")
private @Nullable Output actionPagerdutyIntegrationKeyOverride;
/**
* @return The PagerDuty integration Key override.
*
*/
public Optional> actionPagerdutyIntegrationKeyOverride() {
return Optional.ofNullable(this.actionPagerdutyIntegrationKeyOverride);
}
/**
* The pagerduty integration URL. This integration uses Splunk's native webhooks to send events to PagerDuty.
*
*/
@Import(name="actionPagerdutyIntegrationUrl")
private @Nullable Output actionPagerdutyIntegrationUrl;
/**
* @return The pagerduty integration URL. This integration uses Splunk's native webhooks to send events to PagerDuty.
*
*/
public Optional> actionPagerdutyIntegrationUrl() {
return Optional.ofNullable(this.actionPagerdutyIntegrationUrl);
}
/**
* The pagerduty integration URL override. This integration uses Splunk's native webhooks to send events to PagerDuty.
*
*/
@Import(name="actionPagerdutyIntegrationUrlOverride")
private @Nullable Output actionPagerdutyIntegrationUrlOverride;
/**
* @return The pagerduty integration URL override. This integration uses Splunk's native webhooks to send events to PagerDuty.
*
*/
public Optional> actionPagerdutyIntegrationUrlOverride() {
return Optional.ofNullable(this.actionPagerdutyIntegrationUrlOverride);
}
/**
* The state of the populate lookup action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
@Import(name="actionPopulateLookup")
private @Nullable Output actionPopulateLookup;
/**
* @return The state of the populate lookup action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
public Optional> actionPopulateLookup() {
return Optional.ofNullable(this.actionPopulateLookup);
}
/**
* The search command (or pipeline) which is responsible for executing the action.
*
*/
@Import(name="actionPopulateLookupCommand")
private @Nullable Output actionPopulateLookupCommand;
/**
* @return The search command (or pipeline) which is responsible for executing the action.
*
*/
public Optional> actionPopulateLookupCommand() {
return Optional.ofNullable(this.actionPopulateLookupCommand);
}
/**
* Lookup name of path of the lookup to populate
*
*/
@Import(name="actionPopulateLookupDest")
private @Nullable Output actionPopulateLookupDest;
/**
* @return Lookup name of path of the lookup to populate
*
*/
public Optional> actionPopulateLookupDest() {
return Optional.ofNullable(this.actionPopulateLookupDest);
}
/**
* Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms: hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
@Import(name="actionPopulateLookupHostname")
private @Nullable Output actionPopulateLookupHostname;
/**
* @return Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms: hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
public Optional> actionPopulateLookupHostname() {
return Optional.ofNullable(this.actionPopulateLookupHostname);
}
/**
* Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
@Import(name="actionPopulateLookupMaxResults")
private @Nullable Output actionPopulateLookupMaxResults;
/**
* @return Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
public Optional> actionPopulateLookupMaxResults() {
return Optional.ofNullable(this.actionPopulateLookupMaxResults);
}
/**
* Valid values are: Integer[m|s|h|d]Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 5m.
*
*/
@Import(name="actionPopulateLookupMaxTime")
private @Nullable Output actionPopulateLookupMaxTime;
/**
* @return Valid values are: Integer[m|s|h|d]Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 5m.
*
*/
public Optional> actionPopulateLookupMaxTime() {
return Optional.ofNullable(this.actionPopulateLookupMaxTime);
}
/**
* Indicates whether the execution of this action signifies a trackable alert.
*
*/
@Import(name="actionPopulateLookupTrackAlert")
private @Nullable Output actionPopulateLookupTrackAlert;
/**
* @return Indicates whether the execution of this action signifies a trackable alert.
*
*/
public Optional> actionPopulateLookupTrackAlert() {
return Optional.ofNullable(this.actionPopulateLookupTrackAlert);
}
/**
* Valid values are Integer[p]Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, then this specifies the number of scheduled periods. Defaults to 10p.
*
*/
@Import(name="actionPopulateLookupTtl")
private @Nullable Output actionPopulateLookupTtl;
/**
* @return Valid values are Integer[p]Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, then this specifies the number of scheduled periods. Defaults to 10p.
*
*/
public Optional> actionPopulateLookupTtl() {
return Optional.ofNullable(this.actionPopulateLookupTtl);
}
/**
* The state of the rss action. Read-only attribute. Value ignored on POST.Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
@Import(name="actionRss")
private @Nullable Output actionRss;
/**
* @return The state of the rss action. Read-only attribute. Value ignored on POST.Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
public Optional> actionRss() {
return Optional.ofNullable(this.actionRss);
}
/**
* The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
@Import(name="actionRssCommand")
private @Nullable Output actionRssCommand;
/**
* @return The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
public Optional> actionRssCommand() {
return Optional.ofNullable(this.actionRssCommand);
}
/**
* Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
@Import(name="actionRssHostname")
private @Nullable Output actionRssHostname;
/**
* @return Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
public Optional> actionRssHostname() {
return Optional.ofNullable(this.actionRssHostname);
}
/**
* Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
@Import(name="actionRssMaxResults")
private @Nullable Output actionRssMaxResults;
/**
* @return Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
public Optional> actionRssMaxResults() {
return Optional.ofNullable(this.actionRssMaxResults);
}
/**
* Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
@Import(name="actionRssMaxTime")
private @Nullable Output actionRssMaxTime;
/**
* @return Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
public Optional> actionRssMaxTime() {
return Optional.ofNullable(this.actionRssMaxTime);
}
/**
* Indicates whether the execution of this action signifies a trackable alert.
*
*/
@Import(name="actionRssTrackAlert")
private @Nullable Output actionRssTrackAlert;
/**
* @return Indicates whether the execution of this action signifies a trackable alert.
*
*/
public Optional> actionRssTrackAlert() {
return Optional.ofNullable(this.actionRssTrackAlert);
}
/**
* Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
@Import(name="actionRssTtl")
private @Nullable Output actionRssTtl;
/**
* @return Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
public Optional> actionRssTtl() {
return Optional.ofNullable(this.actionRssTtl);
}
/**
* The state of the script action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
@Import(name="actionScript")
private @Nullable Output actionScript;
/**
* @return The state of the script action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
public Optional> actionScript() {
return Optional.ofNullable(this.actionScript);
}
/**
* The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
@Import(name="actionScriptCommand")
private @Nullable Output actionScriptCommand;
/**
* @return The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
public Optional> actionScriptCommand() {
return Optional.ofNullable(this.actionScriptCommand);
}
/**
* File name of the script to call. Required if script action is enabled
*
*/
@Import(name="actionScriptFilename")
private @Nullable Output actionScriptFilename;
/**
* @return File name of the script to call. Required if script action is enabled
*
*/
public Optional> actionScriptFilename() {
return Optional.ofNullable(this.actionScriptFilename);
}
/**
* Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
@Import(name="actionScriptHostname")
private @Nullable Output actionScriptHostname;
/**
* @return Sets the hostname used in the web link (url) sent in alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)\n\nprotocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
public Optional> actionScriptHostname() {
return Optional.ofNullable(this.actionScriptHostname);
}
/**
* Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
@Import(name="actionScriptMaxResults")
private @Nullable Output actionScriptMaxResults;
/**
* @return Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
public Optional> actionScriptMaxResults() {
return Optional.ofNullable(this.actionScriptMaxResults);
}
/**
* Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
@Import(name="actionScriptMaxTime")
private @Nullable Output actionScriptMaxTime;
/**
* @return Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
public Optional> actionScriptMaxTime() {
return Optional.ofNullable(this.actionScriptMaxTime);
}
/**
* Indicates whether the execution of this action signifies a trackable alert.
*
*/
@Import(name="actionScriptTrackAlert")
private @Nullable Output actionScriptTrackAlert;
/**
* @return Indicates whether the execution of this action signifies a trackable alert.
*
*/
public Optional> actionScriptTrackAlert() {
return Optional.ofNullable(this.actionScriptTrackAlert);
}
/**
* Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
@Import(name="actionScriptTtl")
private @Nullable Output actionScriptTtl;
/**
* @return Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
public Optional> actionScriptTtl() {
return Optional.ofNullable(this.actionScriptTtl);
}
/**
* Include a message attachment. Valid values are message, none, or alert_link
*
*/
@Import(name="actionSlackParamAttachment")
private @Nullable Output actionSlackParamAttachment;
/**
* @return Include a message attachment. Valid values are message, none, or alert_link
*
*/
public Optional> actionSlackParamAttachment() {
return Optional.ofNullable(this.actionSlackParamAttachment);
}
/**
* Slack channel to send the message to (Should start with # or @)
*
*/
@Import(name="actionSlackParamChannel")
private @Nullable Output actionSlackParamChannel;
/**
* @return Slack channel to send the message to (Should start with # or @)
*
*/
public Optional> actionSlackParamChannel() {
return Optional.ofNullable(this.actionSlackParamChannel);
}
/**
* Show one or more fields from the search results below your Slack message. Comma-separated list of field names. Allows wildcards. eg. index,source*
*
*/
@Import(name="actionSlackParamFields")
private @Nullable Output actionSlackParamFields;
/**
* @return Show one or more fields from the search results below your Slack message. Comma-separated list of field names. Allows wildcards. eg. index,source*
*
*/
public Optional> actionSlackParamFields() {
return Optional.ofNullable(this.actionSlackParamFields);
}
/**
* Enter the chat message to send to the Slack channel. The message can include tokens that insert text based on the results of the search.
*
*/
@Import(name="actionSlackParamMessage")
private @Nullable Output actionSlackParamMessage;
/**
* @return Enter the chat message to send to the Slack channel. The message can include tokens that insert text based on the results of the search.
*
*/
public Optional> actionSlackParamMessage() {
return Optional.ofNullable(this.actionSlackParamMessage);
}
/**
* You can override the Slack webhook URL here if you need to send the alert message to a different Slack team
*
*/
@Import(name="actionSlackParamWebhookUrlOverride")
private @Nullable Output actionSlackParamWebhookUrlOverride;
/**
* @return You can override the Slack webhook URL here if you need to send the alert message to a different Slack team
*
*/
public Optional> actionSlackParamWebhookUrlOverride() {
return Optional.ofNullable(this.actionSlackParamWebhookUrlOverride);
}
/**
* Account(s) for which the event is/ are to be created across ServiceNow instance(s).
*
*/
@Import(name="actionSnowEventParamAccount")
private @Nullable Output actionSnowEventParamAccount;
/**
* @return Account(s) for which the event is/ are to be created across ServiceNow instance(s).
*
*/
public Optional> actionSnowEventParamAccount() {
return Optional.ofNullable(this.actionSnowEventParamAccount);
}
/**
* You can pass additional information that might be of use to the user. This field can also be used to supply the URL of
* your Splunk search head. When you use the snow_event.py alert-triggered script, the Splunk platform uses the URL to
* create a deep link that allows a ServiceNow user to navigate back to this Splunk platform search. You can find the
* resulting full URL for navigation from ServiceNow to the Splunk platform search by clicking Splunk Drilldown in the
* event page in ServiceNow. See an example below. Note that if you create events using the commands snowevent or
* snoweventstream, you must supply the URL in this field.You can pass the URL of Splunk as url=<value>. You can also pass
* other fields and their values by || separated key-value format. For example, url=<value>||k1=v1||k2=v2||....
*
*/
@Import(name="actionSnowEventParamAdditionalInfo")
private @Nullable Output actionSnowEventParamAdditionalInfo;
/**
* @return You can pass additional information that might be of use to the user. This field can also be used to supply the URL of
* your Splunk search head. When you use the snow_event.py alert-triggered script, the Splunk platform uses the URL to
* create a deep link that allows a ServiceNow user to navigate back to this Splunk platform search. You can find the
* resulting full URL for navigation from ServiceNow to the Splunk platform search by clicking Splunk Drilldown in the
* event page in ServiceNow. See an example below. Note that if you create events using the commands snowevent or
* snoweventstream, you must supply the URL in this field.You can pass the URL of Splunk as url=<value>. You can also pass
* other fields and their values by || separated key-value format. For example, url=<value>||k1=v1||k2=v2||....
*
*/
public Optional> actionSnowEventParamAdditionalInfo() {
return Optional.ofNullable(this.actionSnowEventParamAdditionalInfo);
}
/**
* String that represents a configuration item in your network. You can pass value as || separated key-value format. For
* example, k1=v1||k2=v2.
*
*/
@Import(name="actionSnowEventParamCiIdentifier")
private @Nullable Output actionSnowEventParamCiIdentifier;
/**
* @return String that represents a configuration item in your network. You can pass value as || separated key-value format. For
* example, k1=v1||k2=v2.
*
*/
public Optional> actionSnowEventParamCiIdentifier() {
return Optional.ofNullable(this.actionSnowEventParamCiIdentifier);
}
/**
* The custom fields which are configured at the ServiceNow Instance. You can pass the custom fields and their values in
* the || separated format. For example, custom_field1=value1||custom_field2=value2||...custom_fields used must be present
* in the em_event table of ServiceNow.
*
*/
@Import(name="actionSnowEventParamCustomFields")
private @Nullable Output actionSnowEventParamCustomFields;
/**
* @return The custom fields which are configured at the ServiceNow Instance. You can pass the custom fields and their values in
* the || separated format. For example, custom_field1=value1||custom_field2=value2||...custom_fields used must be present
* in the em_event table of ServiceNow.
*
*/
public Optional> actionSnowEventParamCustomFields() {
return Optional.ofNullable(this.actionSnowEventParamCustomFields);
}
/**
* A brief description of the event.
*
*/
@Import(name="actionSnowEventParamDescription")
private @Nullable Output actionSnowEventParamDescription;
/**
* @return A brief description of the event.
*
*/
public Optional> actionSnowEventParamDescription() {
return Optional.ofNullable(this.actionSnowEventParamDescription);
}
/**
* The node, formatted to follow your organization's ITIL standards and mapping. If the node value matches a CI with the
* same host name, the event is automatically assigned to the matching CI.
*
*/
@Import(name="actionSnowEventParamNode")
private @Nullable Output actionSnowEventParamNode;
/**
* @return The node, formatted to follow your organization's ITIL standards and mapping. If the node value matches a CI with the
* same host name, the event is automatically assigned to the matching CI.
*
*/
public Optional> actionSnowEventParamNode() {
return Optional.ofNullable(this.actionSnowEventParamNode);
}
/**
* The resource, formatted to follow your organization's ITIL standards and mapping. For example, resource='CPU'.
*
*/
@Import(name="actionSnowEventParamResource")
private @Nullable Output actionSnowEventParamResource;
/**
* @return The resource, formatted to follow your organization's ITIL standards and mapping. For example, resource='CPU'.
*
*/
public Optional> actionSnowEventParamResource() {
return Optional.ofNullable(this.actionSnowEventParamResource);
}
/**
* The severity associated with the event. 0 - Clear 1 - Critical 2 - Major 3 - Minor 4 - Warning
*
*/
@Import(name="actionSnowEventParamSeverity")
private @Nullable Output actionSnowEventParamSeverity;
/**
* @return The severity associated with the event. 0 - Clear 1 - Critical 2 - Major 3 - Minor 4 - Warning
*
*/
public Optional> actionSnowEventParamSeverity() {
return Optional.ofNullable(this.actionSnowEventParamSeverity);
}
/**
* The type, formatted to follow your organization's ITIL standards and mapping. For example, type='Virtual Machine'.
*
*/
@Import(name="actionSnowEventParamType")
private @Nullable Output actionSnowEventParamType;
/**
* @return The type, formatted to follow your organization's ITIL standards and mapping. For example, type='Virtual Machine'.
*
*/
public Optional> actionSnowEventParamType() {
return Optional.ofNullable(this.actionSnowEventParamType);
}
/**
* The state of the summary index action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
@Import(name="actionSummaryIndex")
private @Nullable Output actionSummaryIndex;
/**
* @return The state of the summary index action. Read-only attribute. Value ignored on POST. Use actions to specify a list of enabled actions. Defaults to 0.
*
*/
public Optional> actionSummaryIndex() {
return Optional.ofNullable(this.actionSummaryIndex);
}
/**
* The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
@Import(name="actionSummaryIndexCommand")
private @Nullable Output actionSummaryIndexCommand;
/**
* @return The search command (or pipeline) which is responsible for executing the action.Generally the command is a template search pipeline which is realized with values from the saved search. To reference saved search field values wrap them in $, for example to reference the savedsearch name use $name$, to reference the search use $search$.
*
*/
public Optional> actionSummaryIndexCommand() {
return Optional.ofNullable(this.actionSummaryIndexCommand);
}
/**
* Sets the hostname used in the web link (url) sent in summary-index alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)protocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
@Import(name="actionSummaryIndexHostname")
private @Nullable Output actionSummaryIndexHostname;
/**
* @return Sets the hostname used in the web link (url) sent in summary-index alert actions.This value accepts two forms:hostname (for example, splunkserver, splunkserver.example.com)protocol://hostname:port (for example, http://splunkserver:8000, https://splunkserver.example.com:443)
*
*/
public Optional> actionSummaryIndexHostname() {
return Optional.ofNullable(this.actionSummaryIndexHostname);
}
/**
* Determines whether to execute the summary indexing action as part of the scheduled search.NOTE: This option is considered only if the summary index action is enabled and is always executed (in other words, if counttype = always).Defaults to true
*
*/
@Import(name="actionSummaryIndexInline")
private @Nullable Output actionSummaryIndexInline;
/**
* @return Determines whether to execute the summary indexing action as part of the scheduled search.NOTE: This option is considered only if the summary index action is enabled and is always executed (in other words, if counttype = always).Defaults to true
*
*/
public Optional> actionSummaryIndexInline() {
return Optional.ofNullable(this.actionSummaryIndexInline);
}
/**
* Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
@Import(name="actionSummaryIndexMaxResults")
private @Nullable Output actionSummaryIndexMaxResults;
/**
* @return Sets the maximum number of search results sent using alerts. Defaults to 100.
*
*/
public Optional> actionSummaryIndexMaxResults() {
return Optional.ofNullable(this.actionSummaryIndexMaxResults);
}
/**
* Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
@Import(name="actionSummaryIndexMaxTime")
private @Nullable Output actionSummaryIndexMaxTime;
/**
* @return Valid values are Integer[m|s|h|d].Sets the maximum amount of time the execution of an action takes before the action is aborted. Defaults to 1m.
*
*/
public Optional> actionSummaryIndexMaxTime() {
return Optional.ofNullable(this.actionSummaryIndexMaxTime);
}
/**
* Specifies the name of the summary index where the results of the scheduled search are saved.Defaults to summary.
*
*/
@Import(name="actionSummaryIndexName")
private @Nullable Output actionSummaryIndexName;
/**
* @return Specifies the name of the summary index where the results of the scheduled search are saved.Defaults to summary.
*
*/
public Optional> actionSummaryIndexName() {
return Optional.ofNullable(this.actionSummaryIndexName);
}
/**
* Indicates whether the execution of this action signifies a trackable alert.
*
*/
@Import(name="actionSummaryIndexTrackAlert")
private @Nullable Output actionSummaryIndexTrackAlert;
/**
* @return Indicates whether the execution of this action signifies a trackable alert.
*
*/
public Optional> actionSummaryIndexTrackAlert() {
return Optional.ofNullable(this.actionSummaryIndexTrackAlert);
}
/**
* Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
@Import(name="actionSummaryIndexTtl")
private @Nullable Output actionSummaryIndexTtl;
/**
* @return Valid values are: Integer[p] Specifies the minimum time-to-live in seconds of the search artifacts if this action is triggered. If p follows Integer, specifies the number of scheduled periods. Defaults to 86400 (24 hours).
*
*/
public Optional> actionSummaryIndexTtl() {
return Optional.ofNullable(this.actionSummaryIndexTtl);
}
/**
* URL to send the HTTP POST request to. Must be accessible from the Splunk server
*
*/
@Import(name="actionWebhookParamUrl")
private @Nullable Output actionWebhookParamUrl;
/**
* @return URL to send the HTTP POST request to. Must be accessible from the Splunk server
*
*/
public Optional> actionWebhookParamUrl() {
return Optional.ofNullable(this.actionWebhookParamUrl);
}
/**
* A comma-separated list of actions to enable. For example: rss,email
*
*/
@Import(name="actions")
private @Nullable Output actions;
/**
* @return A comma-separated list of actions to enable. For example: rss,email
*
*/
public Optional> actions() {
return Optional.ofNullable(this.actions);
}
/**
* One of the following strings: greater than, less than, equal to, rises by, drops by, rises by perc, drops by percUsed with alert_threshold to trigger alert actions.
*
*/
@Import(name="alertComparator")
private @Nullable Output alertComparator;
/**
* @return One of the following strings: greater than, less than, equal to, rises by, drops by, rises by perc, drops by percUsed with alert_threshold to trigger alert actions.
*
*/
public Optional> alertComparator() {
return Optional.ofNullable(this.alertComparator);
}
/**
* Contains a conditional search that is evaluated against the results of the saved search. Defaults to an empty string.
*
*/
@Import(name="alertCondition")
private @Nullable Output alertCondition;
/**
* @return Contains a conditional search that is evaluated against the results of the saved search. Defaults to an empty string.
*
*/
public Optional> alertCondition() {
return Optional.ofNullable(this.alertCondition);
}
/**
* Specifies whether alert actions are applied to the entire result set or on each individual result.Defaults to 1 (true).
*
*/
@Import(name="alertDigestMode")
private @Nullable Output alertDigestMode;
/**
* @return Specifies whether alert actions are applied to the entire result set or on each individual result.Defaults to 1 (true).
*
*/
public Optional> alertDigestMode() {
return Optional.ofNullable(this.alertDigestMode);
}
/**
* Valid values: [number][time-unit]Sets the period of time to show the alert in the dashboard. Defaults to 24h.Use [number][time-unit] to specify a time. For example: 60 = 60 seconds, 1m = 1 minute, 1h = 60 minutes = 1 hour.
*
*/
@Import(name="alertExpires")
private @Nullable Output alertExpires;
/**
* @return Valid values: [number][time-unit]Sets the period of time to show the alert in the dashboard. Defaults to 24h.Use [number][time-unit] to specify a time. For example: 60 = 60 seconds, 1m = 1 minute, 1h = 60 minutes = 1 hour.
*
*/
public Optional> alertExpires() {
return Optional.ofNullable(this.alertExpires);
}
/**
* Valid values: (1 | 2 | 3 | 4 | 5 | 6) Sets the alert severity level.Valid values are:1 DEBUG 2 INFO 3 WARN 4 ERROR 5 SEVERE 6 FATAL Defaults to 3.
*
*/
@Import(name="alertSeverity")
private @Nullable Output alertSeverity;
/**
* @return Valid values: (1 | 2 | 3 | 4 | 5 | 6) Sets the alert severity level.Valid values are:1 DEBUG 2 INFO 3 WARN 4 ERROR 5 SEVERE 6 FATAL Defaults to 3.
*
*/
public Optional> alertSeverity() {
return Optional.ofNullable(this.alertSeverity);
}
/**
* Indicates whether alert suppression is enabled for this scheduled search.
*
*/
@Import(name="alertSuppress")
private @Nullable Output alertSuppress;
/**
* @return Indicates whether alert suppression is enabled for this scheduled search.
*
*/
public Optional> alertSuppress() {
return Optional.ofNullable(this.alertSuppress);
}
/**
* Comma delimited list of fields to use for suppression when doing per result alerting. Required if suppression is turned on and per result alerting is enabled.
*
*/
@Import(name="alertSuppressFields")
private @Nullable Output alertSuppressFields;
/**
* @return Comma delimited list of fields to use for suppression when doing per result alerting. Required if suppression is turned on and per result alerting is enabled.
*
*/
public Optional> alertSuppressFields() {
return Optional.ofNullable(this.alertSuppressFields);
}
/**
* Valid values: [number][time-unit] Specifies the suppresion period. Only valid if alert.supress is enabled.Use [number][time-unit] to specify a time. For example: 60 = 60 seconds, 1m = 1 minute, 1h = 60 minutes = 1 hour.
*
*/
@Import(name="alertSuppressPeriod")
private @Nullable Output alertSuppressPeriod;
/**
* @return Valid values: [number][time-unit] Specifies the suppresion period. Only valid if alert.supress is enabled.Use [number][time-unit] to specify a time. For example: 60 = 60 seconds, 1m = 1 minute, 1h = 60 minutes = 1 hour.
*
*/
public Optional> alertSuppressPeriod() {
return Optional.ofNullable(this.alertSuppressPeriod);
}
/**
* Valid values are: Integer[%]Specifies the value to compare (see alert_comparator) before triggering the alert actions. If expressed as a percentage, indicates value to use when alert_comparator is set to rises by perc or drops by perc.
*
*/
@Import(name="alertThreshold")
private @Nullable Output alertThreshold;
/**
* @return Valid values are: Integer[%]Specifies the value to compare (see alert_comparator) before triggering the alert actions. If expressed as a percentage, indicates value to use when alert_comparator is set to rises by perc or drops by perc.
*
*/
public Optional> alertThreshold() {
return Optional.ofNullable(this.alertThreshold);
}
/**
* Valid values: (true | false | auto) Specifies whether to track the actions triggered by this scheduled search.auto - determine whether to track or not based on the tracking setting of each action, do not track scheduled searches that always trigger actions. Default value true - force alert tracking.false - disable alert tracking for this search.
*
*/
@Import(name="alertTrack")
private @Nullable Output alertTrack;
/**
* @return Valid values: (true | false | auto) Specifies whether to track the actions triggered by this scheduled search.auto - determine whether to track or not based on the tracking setting of each action, do not track scheduled searches that always trigger actions. Default value true - force alert tracking.false - disable alert tracking for this search.
*
*/
public Optional> alertTrack() {
return Optional.ofNullable(this.alertTrack);
}
/**
* What to base the alert on, overriden by alert_condition if it is specified. Valid values are: always, custom, number of events, number of hosts, number of sources.
*
*/
@Import(name="alertType")
private @Nullable Output alertType;
/**
* @return What to base the alert on, overriden by alert_condition if it is specified. Valid values are: always, custom, number of events, number of hosts, number of sources.
*
*/
public Optional> alertType() {
return Optional.ofNullable(this.alertType);
}
/**
* Allows the search scheduler to distribute scheduled searches randomly and more evenly over their specified search periods.
*
*/
@Import(name="allowSkew")
private @Nullable Output allowSkew;
/**
* @return Allows the search scheduler to distribute scheduled searches randomly and more evenly over their specified search periods.
*
*/
public Optional> allowSkew() {
return Optional.ofNullable(this.allowSkew);
}
/**
* Indicates whether the scheduler should ensure that the data for this search is automatically summarized. Defaults to 0.
*
*/
@Import(name="autoSummarize")
private @Nullable Output autoSummarize;
/**
* @return Indicates whether the scheduler should ensure that the data for this search is automatically summarized. Defaults to 0.
*
*/
public Optional> autoSummarize() {
return Optional.ofNullable(this.autoSummarize);
}
/**
* An auto summarization template for this search. See auto summarization options in savedsearches.conf for more details.
*
*/
@Import(name="autoSummarizeCommand")
private @Nullable Output autoSummarizeCommand;
/**
* @return An auto summarization template for this search. See auto summarization options in savedsearches.conf for more details.
*
*/
public Optional> autoSummarizeCommand() {
return Optional.ofNullable(this.autoSummarizeCommand);
}
/**
* Cron schedule that probes and generates the summaries for this saved search.The default value is *{@literal /}10 * * * * and corresponds to \`every ten hours\`.
*
*/
@Import(name="autoSummarizeCronSchedule")
private @Nullable Output autoSummarizeCronSchedule;
/**
* @return Cron schedule that probes and generates the summaries for this saved search.The default value is *{@literal /}10 * * * * and corresponds to \`every ten hours\`.
*
*/
public Optional> autoSummarizeCronSchedule() {
return Optional.ofNullable(this.autoSummarizeCronSchedule);
}
/**
* A time string that specifies the earliest time for summarizing this search. Can be a relative or absolute time.If this value is an absolute time, use the dispatch.time_format to format the value.
*
*/
@Import(name="autoSummarizeDispatchEarliestTime")
private @Nullable Output autoSummarizeDispatchEarliestTime;
/**
* @return A time string that specifies the earliest time for summarizing this search. Can be a relative or absolute time.If this value is an absolute time, use the dispatch.time_format to format the value.
*
*/
public Optional> autoSummarizeDispatchEarliestTime() {
return Optional.ofNullable(this.autoSummarizeDispatchEarliestTime);
}
/**
* A time string that specifies the latest time for summarizing this saved search. Can be a relative or absolute time.If this value is an absolute time, use the dispatch.time_format to format the value.
*
*/
@Import(name="autoSummarizeDispatchLatestTime")
private @Nullable Output autoSummarizeDispatchLatestTime;
/**
* @return A time string that specifies the latest time for summarizing this saved search. Can be a relative or absolute time.If this value is an absolute time, use the dispatch.time_format to format the value.
*
*/
public Optional> autoSummarizeDispatchLatestTime() {
return Optional.ofNullable(this.autoSummarizeDispatchLatestTime);
}
/**
* Defines the time format that Splunk software uses to specify the earliest and latest time. Defaults to %FT%T.%Q%:z
*
*/
@Import(name="autoSummarizeDispatchTimeFormat")
private @Nullable Output autoSummarizeDispatchTimeFormat;
/**
* @return Defines the time format that Splunk software uses to specify the earliest and latest time. Defaults to %FT%T.%Q%:z
*
*/
public Optional
