@pulumi/sumologic
Version:
A Pulumi package for creating and managing sumologic cloud resources.
1,635 lines (1,634 loc) • 336 kB
TypeScript
import * as outputs from "../types/output";
export interface AwsInventorySourceAuthentication {
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
region?: string;
/**
* Your AWS role ARN. More details [here](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Grant-Access-to-an-AWS-Product#iam-role).
*/
roleArn?: string;
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be `AWSRoleBasedAuthentication`
*/
type: string;
}
export interface AwsInventorySourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface AwsInventorySourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface AwsInventorySourcePath {
azureTagFilters?: outputs.AwsInventorySourcePathAzureTagFilter[];
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.AwsInventorySourcePathCustomService[];
environment?: string;
eventHubName?: string;
/**
* List of namespaces. By default all namespaces are selected. You can also choose a subset from
* + AWS/EC2
* + AWS/AutoScaling
* + AWS/EBS
* + AWS/ELB
* + AWS/ApplicationELB
* + AWS/NetworkELB
* + AWS/Lambda
* + AWS/RDS
* + AWS/Dynamodb
* + AWS/ECS
* + AWS/Elasticache
* + AWS/Redshift
* + AWS/Kinesis
*/
limitToNamespaces?: string[];
/**
* List of Amazon regions.
*/
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
pathExpression?: string;
region?: string;
snsTopicOrSubscriptionArns: outputs.AwsInventorySourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.AwsInventorySourcePathTagFilter[];
/**
* type of polling source. This has to be `AwsInventoryPath` for AWS Inventory source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface AwsInventorySourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.AwsInventorySourcePathAzureTagFilterTag[];
type: string;
}
export interface AwsInventorySourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface AwsInventorySourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface AwsInventorySourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface AwsInventorySourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface AwsXraySourceAuthentication {
/**
* Your AWS access key if using type `S3BucketAuthentication`
*/
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
region?: string;
/**
* Your AWS role ARN if using type `AWSRoleBasedAuthentication`
*/
roleArn?: string;
/**
* Your AWS secret key if using type `S3BucketAuthentication`
*/
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`
*/
type: string;
}
export interface AwsXraySourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface AwsXraySourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface AwsXraySourcePath {
azureTagFilters?: outputs.AwsXraySourcePathAzureTagFilter[];
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.AwsXraySourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
/**
* List of Amazon regions.
*/
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
pathExpression?: string;
region?: string;
snsTopicOrSubscriptionArns: outputs.AwsXraySourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.AwsXraySourcePathTagFilter[];
/**
* type of polling source. This has to be `AwsXRayPath` for AWS XRay source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface AwsXraySourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.AwsXraySourcePathAzureTagFilterTag[];
type: string;
}
export interface AwsXraySourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface AwsXraySourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface AwsXraySourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface AwsXraySourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface AzureEventHubLogSourceAuthentication {
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
/**
* The region of the event hub. The value can be either `Commercial` for Azure, or `US Gov` for Azure Government. Defaults to `Commercial`.
*/
region?: string;
roleArn?: string;
secretKey?: string;
/**
* Your shared access policy key.
*/
sharedAccessPolicyKey?: string;
/**
* Your shared access policy name.
*/
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be `AzureEventHubAuthentication`.
*/
type: string;
}
export interface AzureEventHubLogSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface AzureEventHubLogSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface AzureEventHubLogSourcePath {
azureTagFilters?: outputs.AzureEventHubLogSourcePathAzureTagFilter[];
bucketName?: string;
/**
* The consumer group of the event hub.
*/
consumerGroup?: string;
customServices?: outputs.AzureEventHubLogSourcePathCustomService[];
environment?: string;
/**
* The name of the event hub.
*/
eventHubName?: string;
limitToNamespaces?: string[];
limitToRegions?: string[];
limitToServices?: string[];
/**
* The namespace of the event hub.
*/
namespace?: string;
pathExpression?: string;
/**
* The region of the event hub. The value can be either `Commercial` for Azure, or `US Gov` for Azure Government. Defaults to `Commercial`.
*/
region?: string;
snsTopicOrSubscriptionArns: outputs.AzureEventHubLogSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.AzureEventHubLogSourcePathTagFilter[];
/**
* Must be `AzureEventHubPath`.
*/
type: string;
useVersionedApi?: boolean;
}
export interface AzureEventHubLogSourcePathAzureTagFilter {
/**
* The namespace of the event hub.
*/
namespace?: string;
tags?: outputs.AzureEventHubLogSourcePathAzureTagFilterTag[];
type: string;
}
export interface AzureEventHubLogSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface AzureEventHubLogSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface AzureEventHubLogSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface AzureEventHubLogSourcePathTagFilter {
/**
* The namespace of the event hub.
*/
namespace?: string;
tags?: string[];
type?: string;
}
export interface AzureMetricsSourceAuthentication {
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
region?: string;
roleArn?: string;
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
type: string;
}
export interface AzureMetricsSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface AzureMetricsSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface AzureMetricsSourcePath {
azureTagFilters?: outputs.AzureMetricsSourcePathAzureTagFilter[];
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.AzureMetricsSourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
pathExpression?: string;
region?: string;
snsTopicOrSubscriptionArns: outputs.AzureMetricsSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.AzureMetricsSourcePathTagFilter[];
type: string;
useVersionedApi?: boolean;
}
export interface AzureMetricsSourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.AzureMetricsSourcePathAzureTagFilterTag[];
type: string;
}
export interface AzureMetricsSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface AzureMetricsSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface AzureMetricsSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface AzureMetricsSourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface CloudSyslogSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface CloudSyslogSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface CloudfrontSourceAuthentication {
/**
* Your AWS access key if using type `S3BucketAuthentication`
*/
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* Your AWS role ARN if using type `AWSRoleBasedAuthentication`. This is not supported for AWS China regions.
*/
roleArn?: string;
/**
* Your AWS secret key if using type `S3BucketAuthentication`
*/
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`
*/
type: string;
}
export interface CloudfrontSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface CloudfrontSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface CloudfrontSourcePath {
azureTagFilters?: outputs.CloudfrontSourcePathAzureTagFilter[];
/**
* The name of the bucket. This is needed if using type `S3BucketPathExpression`.
*/
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.CloudfrontSourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
/**
* The path to the data. This is needed if using type `S3BucketPathExpression`.
*/
pathExpression?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* This is a computed field for SNS topic/subscription ARN.
*/
snsTopicOrSubscriptionArns: outputs.CloudfrontSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.CloudfrontSourcePathTagFilter[];
/**
* type of polling source. This has to be `S3BucketPathExpression` for `CloudFront` source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface CloudfrontSourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.CloudfrontSourcePathAzureTagFilterTag[];
type: string;
}
export interface CloudfrontSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface CloudfrontSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface CloudfrontSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface CloudfrontSourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface CloudtrailSourceAuthentication {
/**
* Your AWS access key if using type `S3BucketAuthentication`
*/
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* Your AWS role ARN if using type `AWSRoleBasedAuthentication`. This is not supported for AWS China regions.
*/
roleArn?: string;
/**
* Your AWS secret key if using type `S3BucketAuthentication`
*/
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`
*/
type: string;
}
export interface CloudtrailSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface CloudtrailSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface CloudtrailSourcePath {
azureTagFilters?: outputs.CloudtrailSourcePathAzureTagFilter[];
/**
* The name of the bucket.
*/
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.CloudtrailSourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
/**
* The path to the data.
*/
pathExpression?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* This is a computed field for SNS topic/subscription ARN.
*/
snsTopicOrSubscriptionArns: outputs.CloudtrailSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.CloudtrailSourcePathTagFilter[];
/**
* type of polling source. This has to be `S3BucketPathExpression` for `CloudTrail` source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface CloudtrailSourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.CloudtrailSourcePathAzureTagFilterTag[];
type: string;
}
export interface CloudtrailSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface CloudtrailSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface CloudtrailSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface CloudtrailSourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface CloudwatchSourceAuthentication {
/**
* Your AWS access key if using type `S3BucketAuthentication`
*/
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* Your AWS role ARN if using type `AWSRoleBasedAuthentication`. This is not supported for AWS China regions.
*/
roleArn?: string;
/**
* Your AWS secret key if using type `S3BucketAuthentication`
*/
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`
*/
type: string;
}
export interface CloudwatchSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface CloudwatchSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface CloudwatchSourcePath {
azureTagFilters?: outputs.CloudwatchSourcePathAzureTagFilter[];
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.CloudwatchSourcePathCustomService[];
environment?: string;
eventHubName?: string;
/**
* List of namespaces. By default all namespaces are selected. Details can be found [here](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Amazon-CloudWatch-Source-for-Metrics#aws%C2%A0tag-filtering-namespace-support). You can also specify custom namespace.
*/
limitToNamespaces?: string[];
/**
* List of Amazon regions.
*/
limitToRegions?: string[];
limitToServices?: string[];
/**
* Namespace for which you want to define the tag filters. Use value as `All` to apply the tag filter for all namespaces.
*/
namespace?: string;
pathExpression?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
snsTopicOrSubscriptionArns: outputs.CloudwatchSourcePathSnsTopicOrSubscriptionArn[];
/**
* Tag filters allow you to filter the CloudWatch metrics you collect by the AWS tags you have assigned to your AWS resources. You can define tag filters for each supported namespace. If you do not define any tag filters, all metrics will be collected for the regions and namespaces you configured for the source above. More info on tag filters can be found [here](https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Amazon-Web-Services/Amazon-CloudWatch-Source-for-Metrics#about-aws-tag-filtering)
*/
tagFilters?: outputs.CloudwatchSourcePathTagFilter[];
/**
* type of polling source. This has to be `CloudWatchPath` for CloudWatch source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface CloudwatchSourcePathAzureTagFilter {
/**
* Namespace for which you want to define the tag filters. Use value as `All` to apply the tag filter for all namespaces.
*/
namespace?: string;
/**
* List of key-value pairs of tag filters. Eg: `["k3=v3"]`
*/
tags?: outputs.CloudwatchSourcePathAzureTagFilterTag[];
type: string;
}
export interface CloudwatchSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface CloudwatchSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface CloudwatchSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface CloudwatchSourcePathTagFilter {
/**
* Namespace for which you want to define the tag filters. Use value as `All` to apply the tag filter for all namespaces.
*/
namespace?: string;
/**
* List of key-value pairs of tag filters. Eg: `["k3=v3"]`
*/
tags?: string[];
/**
* This value has to be set to `TagFilters`
*/
type?: string;
}
export interface ContentPermissionPermission {
/**
* Content permission name. Valid values are `View`, `GrantView`,
* `Edit`, `GrantEdit`, `Manage`, and `GrantManage`. You can read more about permission levels
* [here](https://help.sumologic.com/Manage/Content_Sharing/Share-Content#available-permission-levels).
*/
permissionName: string;
/**
* An identifier that belongs to the source type chosen above. For example,
* if the `sourceType` is set to `user`, `sourceId` should be identifier of the user you want to share
* content with (same goes for role and org source type).
*/
sourceId: string;
/**
* Type of source for the permission. Valid values are `user`, `role`,
* and `org`.
*/
sourceType: string;
}
export interface CseAggregationRuleAggregationFunction {
/**
* One or more expressions to pass as arguments to the function
*/
arguments: string[];
/**
* The function to aggregate with
*/
function: string;
/**
* The name to use to reference the result in the trigger_expression
*/
name: string;
}
export interface CseAggregationRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on.
*/
expression: string;
}
export interface CseAggregationRuleSeverityMapping {
/**
* The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
*/
default?: number;
/**
* The field to use in the "fieldValue"/"fieldValueMapping" cases.
*/
field?: string;
/**
* The map of record values to severities to use in the "fieldValueMapping" case
*/
mappings?: outputs.CseAggregationRuleSeverityMappingMapping[];
/**
* Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
*/
type: string;
}
export interface CseAggregationRuleSeverityMappingMapping {
/**
* The record value to map from
*/
from: string;
/**
* The severity value to map to
*/
to: number;
/**
* Must be set to "eq" currently
*/
type: string;
}
export interface CseChainRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on.
*/
expression: string;
}
export interface CseChainRuleExpressionsAndLimit {
/**
* The expression for which records to match on
*/
expression: string;
/**
* How many times this expression must match for the Signal to fire
*/
limit: number;
}
export interface CseCustomInsightDynamicSeverity {
/**
* The severity of the generated Insight (CRITICAL, HIGH, MEDIUM, or LOW)
*/
insightSeverity: string;
/**
* minimum Signal severity as the threshold for an Insight severity level
*/
minimumSignalSeverity: number;
}
export interface CseEntityNormalizationConfigurationDomainMapping {
/**
* The normalized domain.
*/
normalizedDomain: string;
/**
* The raw domain to be normalized.
*/
rawDomain: string;
}
export interface CseFirstSeenRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on
*/
expression: string;
}
export interface CseLogMappingField {
/**
* List of alternate values.
*/
alternateValues?: string[];
/**
* Case insensitive flag.
*/
caseInsensitive?: boolean;
/**
* Default value of the field.
*/
defaultValue?: string;
/**
* List of field join values.
*/
fieldJoins?: string[];
/**
* Format of the field. (JSON, Windows, Syslog, CEF, LEEF )
*/
format?: string;
/**
* List of format parameters.
*/
formatParameters?: string[];
/**
* Join delimiter.
*/
joinDelimiter?: string;
/**
* List of lookup key value pair for field. See lookupSchema for details.
*/
lookups?: outputs.CseLogMappingFieldLookup[];
/**
* The name of the log mapping.
*/
name: string;
/**
* List of skipped values.
*/
skippedValues?: string[];
/**
* Split delimiter to be used. (some example: ",", "-", "|")
*/
splitDelimiter?: string;
/**
* The index value to select (starting at zero)
*/
splitIndex?: string;
/**
* Time zone.
*/
timeZone?: string;
/**
* Lookup value.
*/
value?: string;
/**
* The value type.
*/
valueType?: string;
}
export interface CseLogMappingFieldLookup {
/**
* Lookup key.
*/
key: string;
/**
* Lookup value.
*/
value: string;
}
export interface CseLogMappingStructuredInput {
/**
* Event id pattern.
*/
eventIdPattern: string;
/**
* Log format. (JSON, Windows, Syslog, CEF, LEEF )
*/
logFormat: string;
/**
* Product name.
*/
product: string;
/**
* Vendor name.
*/
vendor: string;
}
export interface CseLogMappingUnstructuredFields {
/**
* List of grok pattern names.
*
*
* The following attributes are exported:
*/
patternNames: string[];
}
export interface CseMatchListItem {
/**
* Match list description.
*/
description: string;
/**
* Match list item expiration. (Format: YYYY-MM-DDTHH:mm:ss)
*
* The following attributes are exported:
*/
expiration?: string;
/**
* The internal ID of the match list.
*/
id: string;
/**
* Match list item value.
*/
value: string;
}
export interface CseMatchRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on.
*/
expression: string;
}
export interface CseMatchRuleSeverityMapping {
/**
* The severity to use in the "constant" case or to fall back to if the field used by "fieldValue"/"fieldValueMapping" is not populated.
*/
default?: number;
/**
* The field to use in the "fieldValue"/"fieldValueMapping" cases.
*/
field?: string;
/**
* The map of record values to severities to use in the "fieldValueMapping" case
*/
mappings?: outputs.CseMatchRuleSeverityMappingMapping[];
/**
* Whether to set a constant severity ("constant"), set the severity based on the direct value of a record field ("fieldValue"), or map a record field value to a severity ("fieldValueMapping").
*/
type: string;
}
export interface CseMatchRuleSeverityMappingMapping {
/**
* The record value to map from
*/
from: string;
/**
* The severity value to map to
*/
to: number;
/**
* Must be set to "eq" currently
*/
type: string;
}
export interface CseOutlierRuleAggregationFunctions {
/**
* One or more expressions to pass as arguments to the function
*/
arguments: string[];
/**
* The function to aggregate with
*/
function: string;
/**
* The name of the Rule
*/
name: string;
}
export interface CseOutlierRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on
*/
expression: string;
}
export interface CseTagSchemaValueOption {
/**
* Value option label.
*/
label?: string;
/**
* Value option link.
*
*
*
* The following attributes are exported:
*/
link?: string;
/**
* Value option value.
*/
value: string;
}
export interface CseThresholdRuleEntitySelector {
entityType: string;
/**
* The expression or field name to generate the Signal on.
*/
expression: string;
}
export interface DashboardColoringRule {
colorThresholds?: outputs.DashboardColoringRuleColorThreshold[];
multipleSeriesAggregateFunction: string;
scope: string;
singleSeriesAggregateFunction: string;
}
export interface DashboardColoringRuleColorThreshold {
color: string;
max?: number;
min?: number;
}
export interface DashboardLayout {
grid?: outputs.DashboardLayoutGrid;
}
export interface DashboardLayoutGrid {
layoutStructures: outputs.DashboardLayoutGridLayoutStructure[];
}
export interface DashboardLayoutGridLayoutStructure {
key: string;
structure: string;
}
export interface DashboardPanel {
serviceMapPanel?: outputs.DashboardPanelServiceMapPanel;
sumoSearchPanel?: outputs.DashboardPanelSumoSearchPanel;
textPanel?: outputs.DashboardPanelTextPanel;
tracesListPanel?: outputs.DashboardPanelTracesListPanel;
}
export interface DashboardPanelServiceMapPanel {
application?: string;
environment?: string;
id: string;
keepVisualSettingsConsistentWithParent?: boolean;
key: string;
service?: string;
showRemoteServices?: boolean;
/**
* Title of the dashboard.
*/
title?: string;
visualSettings?: string;
}
export interface DashboardPanelSumoSearchPanel {
coloringRule?: outputs.DashboardPanelSumoSearchPanelColoringRule;
/**
* Description of the dashboard.
*/
description?: string;
id: string;
keepVisualSettingsConsistentWithParent?: boolean;
key: string;
linkedDashboard?: outputs.DashboardPanelSumoSearchPanelLinkedDashboard;
queries?: outputs.DashboardPanelSumoSearchPanelQuery[];
/**
* Time range of the dashboard. See time range schema
* for details.
*/
timeRange?: outputs.DashboardPanelSumoSearchPanelTimeRange;
/**
* Title of the dashboard.
*/
title?: string;
visualSettings?: string;
}
export interface DashboardPanelSumoSearchPanelColoringRule {
colorThresholds?: outputs.DashboardPanelSumoSearchPanelColoringRuleColorThreshold[];
multipleSeriesAggregateFunction: string;
scope: string;
singleSeriesAggregateFunction: string;
}
export interface DashboardPanelSumoSearchPanelColoringRuleColorThreshold {
color: string;
max?: number;
min?: number;
}
export interface DashboardPanelSumoSearchPanelLinkedDashboard {
id: string;
includeTimeRange?: boolean;
includeVariables?: boolean;
relativePath?: string;
}
export interface DashboardPanelSumoSearchPanelQuery {
metricsQueryData?: outputs.DashboardPanelSumoSearchPanelQueryMetricsQueryData;
metricsQueryMode?: string;
outputCardinalityLimit?: number;
parseMode?: string;
queryKey: string;
queryString: string;
queryType: string;
timeSource?: string;
transient?: boolean;
}
export interface DashboardPanelSumoSearchPanelQueryMetricsQueryData {
aggregationType?: string;
filters: outputs.DashboardPanelSumoSearchPanelQueryMetricsQueryDataFilter[];
groupBy?: string;
metric: string;
operators?: outputs.DashboardPanelSumoSearchPanelQueryMetricsQueryDataOperator[];
}
export interface DashboardPanelSumoSearchPanelQueryMetricsQueryDataFilter {
key: string;
negation?: boolean;
value: string;
}
export interface DashboardPanelSumoSearchPanelQueryMetricsQueryDataOperator {
operatorName: string;
parameters: outputs.DashboardPanelSumoSearchPanelQueryMetricsQueryDataOperatorParameter[];
}
export interface DashboardPanelSumoSearchPanelQueryMetricsQueryDataOperatorParameter {
key: string;
value: string;
}
export interface DashboardPanelSumoSearchPanelTimeRange {
beginBoundedTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRange;
completeLiteralTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeCompleteLiteralTimeRange;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRange {
from: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFrom;
to?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeTo;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFrom {
epochTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromEpochTimeRange;
iso8601TimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange;
literalTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange;
relativeTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromEpochTimeRange {
epochMillis: number;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange {
rangeName: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange {
relativeTime: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeTo {
epochTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToEpochTimeRange;
iso8601TimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToIso8601TimeRange;
literalTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToLiteralTimeRange;
relativeTimeRange?: outputs.DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToRelativeTimeRange;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToEpochTimeRange {
epochMillis: number;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToLiteralTimeRange {
rangeName: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeBeginBoundedTimeRangeToRelativeTimeRange {
relativeTime: string;
}
export interface DashboardPanelSumoSearchPanelTimeRangeCompleteLiteralTimeRange {
rangeName: string;
}
export interface DashboardPanelTextPanel {
id: string;
keepVisualSettingsConsistentWithParent?: boolean;
key: string;
text?: string;
/**
* Title of the dashboard.
*/
title?: string;
visualSettings?: string;
}
export interface DashboardPanelTracesListPanel {
id: string;
keepVisualSettingsConsistentWithParent?: boolean;
key: string;
queries?: outputs.DashboardPanelTracesListPanelQuery[];
/**
* Time range of the dashboard. See time range schema
* for details.
*/
timeRange?: outputs.DashboardPanelTracesListPanelTimeRange;
/**
* Title of the dashboard.
*/
title?: string;
visualSettings?: string;
}
export interface DashboardPanelTracesListPanelQuery {
metricsQueryData?: outputs.DashboardPanelTracesListPanelQueryMetricsQueryData;
metricsQueryMode?: string;
outputCardinalityLimit?: number;
parseMode?: string;
queryKey: string;
queryString: string;
queryType: string;
timeSource?: string;
transient?: boolean;
}
export interface DashboardPanelTracesListPanelQueryMetricsQueryData {
aggregationType?: string;
filters: outputs.DashboardPanelTracesListPanelQueryMetricsQueryDataFilter[];
groupBy?: string;
metric: string;
operators?: outputs.DashboardPanelTracesListPanelQueryMetricsQueryDataOperator[];
}
export interface DashboardPanelTracesListPanelQueryMetricsQueryDataFilter {
key: string;
negation?: boolean;
value: string;
}
export interface DashboardPanelTracesListPanelQueryMetricsQueryDataOperator {
operatorName: string;
parameters: outputs.DashboardPanelTracesListPanelQueryMetricsQueryDataOperatorParameter[];
}
export interface DashboardPanelTracesListPanelQueryMetricsQueryDataOperatorParameter {
key: string;
value: string;
}
export interface DashboardPanelTracesListPanelTimeRange {
beginBoundedTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRange;
completeLiteralTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeCompleteLiteralTimeRange;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRange {
from: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFrom;
to?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeTo;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFrom {
epochTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromEpochTimeRange;
iso8601TimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange;
literalTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange;
relativeTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromEpochTimeRange {
epochMillis: number;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange {
rangeName: string;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange {
relativeTime: string;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeTo {
epochTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToEpochTimeRange;
iso8601TimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToIso8601TimeRange;
literalTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToLiteralTimeRange;
relativeTimeRange?: outputs.DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToRelativeTimeRange;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToEpochTimeRange {
epochMillis: number;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToLiteralTimeRange {
rangeName: string;
}
export interface DashboardPanelTracesListPanelTimeRangeBeginBoundedTimeRangeToRelativeTimeRange {
relativeTime: string;
}
export interface DashboardPanelTracesListPanelTimeRangeCompleteLiteralTimeRange {
rangeName: string;
}
export interface DashboardTimeRange {
beginBoundedTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRange;
completeLiteralTimeRange?: outputs.DashboardTimeRangeCompleteLiteralTimeRange;
}
export interface DashboardTimeRangeBeginBoundedTimeRange {
from: outputs.DashboardTimeRangeBeginBoundedTimeRangeFrom;
to?: outputs.DashboardTimeRangeBeginBoundedTimeRangeTo;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeFrom {
epochTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeFromEpochTimeRange;
iso8601TimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange;
literalTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange;
relativeTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeFromEpochTimeRange {
epochMillis: number;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeFromIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeFromLiteralTimeRange {
rangeName: string;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeFromRelativeTimeRange {
relativeTime: string;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeTo {
epochTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeToEpochTimeRange;
iso8601TimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeToIso8601TimeRange;
literalTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeToLiteralTimeRange;
relativeTimeRange?: outputs.DashboardTimeRangeBeginBoundedTimeRangeToRelativeTimeRange;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeToEpochTimeRange {
epochMillis: number;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeToIso8601TimeRange {
iso8601Time: string;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeToLiteralTimeRange {
rangeName: string;
}
export interface DashboardTimeRangeBeginBoundedTimeRangeToRelativeTimeRange {
relativeTime: string;
}
export interface DashboardTimeRangeCompleteLiteralTimeRange {
rangeName: string;
}
export interface DashboardTopologyLabelMap {
datas: outputs.DashboardTopologyLabelMapData[];
}
export interface DashboardTopologyLabelMapData {
label: string;
values: string[];
}
export interface DashboardVariable {
allowMultiSelect?: boolean;
defaultValue?: string;
displayName?: string;
hideFromUi?: boolean;
id: string;
includeAllOption?: boolean;
name: string;
sourceDefinition: outputs.DashboardVariableSourceDefinition;
}
export interface DashboardVariableSourceDefinition {
csvVariableSourceDefinition?: outputs.DashboardVariableSourceDefinitionCsvVariableSourceDefinition;
logQueryVariableSourceDefinition?: outputs.DashboardVariableSourceDefinitionLogQueryVariableSourceDefinition;
metadataVariableSourceDefinition?: outputs.DashboardVariableSourceDefinitionMetadataVariableSourceDefinition;
}
export interface DashboardVariableSourceDefinitionCsvVariableSourceDefinition {
values: string;
}
export interface DashboardVariableSourceDefinitionLogQueryVariableSourceDefinition {
field: string;
query: string;
}
export interface DashboardVariableSourceDefinitionMetadataVariableSourceDefinition {
filter: string;
key: string;
}
export interface DataForwardingDestinationAuthentication {
/**
* The AWS Access ID to access the S3 bucket.
*/
accessKey?: string;
/**
* The AWS Role ARN to access the S3 bucket.
*/
roleArn?: string;
/**
* The AWS Secret Key to access the S3 bucket.
*/
secretKey?: string;
/**
* AWS IAM authentication method used for access. Possible values are: 1. `AccessKey` 2. `RoleBased`
*/
type: string;
}
export interface ElbSourceAuthentication {
/**
* Your AWS access key if using type `S3BucketAuthentication`.
*/
accessKey?: string;
authProviderX509CertUrl?: string;
authUri?: string;
clientEmail?: string;
clientId?: string;
clientSecret?: string;
clientX509CertUrl?: string;
privateKey?: string;
privateKeyId?: string;
projectId?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* Your AWS role ARN if using type `AWSRoleBasedAuthentication`.This is not supported for AWS China regions.
*/
roleArn?: string;
/**
* Your AWS secret key if using type `S3BucketAuthentication`.
*/
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
tokenUri?: string;
/**
* Must be either `S3BucketAuthentication` or `AWSRoleBasedAuthentication`.
*/
type: string;
}
export interface ElbSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface ElbSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface ElbSourcePath {
azureTagFilters?: outputs.ElbSourcePathAzureTagFilter[];
/**
* The name of the bucket.
*/
bucketName?: string;
consumerGroup?: string;
customServices?: outputs.ElbSourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
limitToRegions?: string[];
limitToServices?: string[];
namespace?: string;
/**
* The path to the data.
*/
pathExpression?: string;
/**
* Your AWS Bucket region.
*/
region?: string;
/**
* This is a computed field for SNS topic/subscription ARN.
*/
snsTopicOrSubscriptionArns: outputs.ElbSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.ElbSourcePathTagFilter[];
/**
* type of polling source. This has to be `S3BucketPathExpression` for `ELB` source.
*/
type: string;
useVersionedApi?: boolean;
}
export interface ElbSourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.ElbSourcePathAzureTagFilterTag[];
type: string;
}
export interface ElbSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface ElbSourcePathCustomService {
prefixes?: string[];
serviceName?: string;
}
export interface ElbSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface ElbSourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface GcpMetricsSourceAuthentication {
accessKey?: string;
/**
* As per the service_account.json downloaded from GCP
*/
authProviderX509CertUrl?: string;
/**
* As per the service_account.json downloaded from GCP
*/
authUri?: string;
/**
* As per the service_account.json downloaded from GCP
*/
clientEmail?: string;
/**
* As per the service_account.json downloaded from GCP
*/
clientId?: string;
clientSecret?: string;
/**
* As per the service_account.json downloaded from GCP
*/
clientX509CertUrl?: string;
/**
* As per the service_account.json downloaded from GCP
*/
privateKey?: string;
/**
* As per the service_account.json downloaded from GCP
*/
privateKeyId?: string;
/**
* As per the service_account.json downloaded from GCP
*/
projectId?: string;
region?: string;
roleArn?: string;
secretKey?: string;
sharedAccessPolicyKey?: string;
sharedAccessPolicyName?: string;
tenantId?: string;
/**
* As per the service_account.json downloaded from GCP
*/
tokenUri?: string;
/**
* Must be `serviceAccount`.
*/
type: string;
}
export interface GcpMetricsSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface GcpMetricsSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface GcpMetricsSourcePath {
azureTagFilters?: outputs.GcpMetricsSourcePathAzureTagFilter[];
bucketName?: string;
consumerGroup?: string;
/**
* Sumoloigc provides list of services that can be used in limitToServices for which metrics would be collected. Custom Services allow you to define your own service w.r.t. metric collection. You can provide list of metric prefixes that should be collected as part of the custom service. This provides fine-grain control w.r.t. what all metrics are ingested by sumologic.
*/
customServices?: outputs.GcpMetricsSourcePathCustomService[];
environment?: string;
eventHubName?: string;
limitToNamespaces?: string[];
/**
* List of regions for which metrics would be collected (Empty to collect from all regions)
*/
limitToRegions?: string[];
/**
* List of services from which metrics would be collected
*/
limitToServices?: string[];
namespace?: string;
pathExpression?: string;
region?: string;
snsTopicOrSubscriptionArns: outputs.GcpMetricsSourcePathSnsTopicOrSubscriptionArn[];
tagFilters?: outputs.GcpMetricsSourcePathTagFilter[];
/**
* Type of polling source. This has to be `GcpMetricsPath`.
*/
type: string;
useVersionedApi?: boolean;
}
export interface GcpMetricsSourcePathAzureTagFilter {
namespace?: string;
tags?: outputs.GcpMetricsSourcePathAzureTagFilterTag[];
type: string;
}
export interface GcpMetricsSourcePathAzureTagFilterTag {
name: string;
values?: string[];
}
export interface GcpMetricsSourcePathCustomService {
/**
* List of metric type prefixes. Eg: `["compute.googleapis.com/instance/","compute.googleapis.com/guest/"]`
*/
prefixes?: string[];
/**
* Name of the custom service you want to define.
*/
serviceName?: string;
}
export interface GcpMetricsSourcePathSnsTopicOrSubscriptionArn {
arn: string;
isSuccess: boolean;
}
export interface GcpMetricsSourcePathTagFilter {
namespace?: string;
tags?: string[];
type?: string;
}
export interface GcpSourceAuthentication {
type?: string;
}
export interface GcpSourceDefaultDateFormat {
format: string;
locator?: string;
}
export interface GcpSourceFilter {
filterType: string;
mask?: string;
name: string;
regexp: string;
}
export interface GcpSourcePath {
type?: string;
}
export interface GetAppsApp {
accountTypes: string[];
appType: string;
attributes?: outputs.GetAppsAppAttributes;
author: string;
beta: boolean;
description: string;
family: string;
icon: string;
installable: boolean;
installs: number;
latestVersion: string;
name: string;
showOnMarketplace: boolean;
uuid: string;
}
export interface GetAppsAppAttributes {
categories?: string[];
collections?: string[];
useCases?: string[];
}
export interface GetPartitionsPartition {
analyticsTier: string;
dataForwardingId: string;
id: string;
indexType: string;
isActive: boolean;
isCompliant: boolean;
isIncludedInDefaultSearch: boolean;
name: string;
reduceRetentionPeriodImmediately: boolean;