sumologic.IngestBudgetV2
Provides a [Sumologic Ingest Budget v2][1].This API is in private beta and is not available until given access. To participate in the beta program contact your Sumo Logic account representative.
Example Usage
using System.Collections.Generic;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;
return await Deployment.RunAsync(() =>
{
var budget = new SumoLogic.IngestBudgetV2("budget", new()
{
Action = "keepCollecting",
AuditThreshold = 85,
CapacityBytes = 30000000000,
Description = "For testing purposes",
ResetTime = "00:00",
Scope = "_sourceCategory=*prod*nginx*",
Timezone = "Etc/UTC",
});
});
package main
import (
"github.com/pulumi/pulumi-sumologic/sdk/go/sumologic"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sumologic.NewIngestBudgetV2(ctx, "budget", &sumologic.IngestBudgetV2Args{
Action: pulumi.String("keepCollecting"),
AuditThreshold: pulumi.Int(85),
CapacityBytes: pulumi.Int(30000000000),
Description: pulumi.String("For testing purposes"),
ResetTime: pulumi.String("00:00"),
Scope: pulumi.String("_sourceCategory=*prod*nginx*"),
Timezone: pulumi.String("Etc/UTC"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.IngestBudgetV2;
import com.pulumi.sumologic.IngestBudgetV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var budget = new IngestBudgetV2("budget", IngestBudgetV2Args.builder()
.action("keepCollecting")
.auditThreshold(85)
.capacityBytes(30000000000)
.description("For testing purposes")
.resetTime("00:00")
.scope("_sourceCategory=*prod*nginx*")
.timezone("Etc/UTC")
.build());
}
}
import pulumi
import pulumi_sumologic as sumologic
budget = sumologic.IngestBudgetV2("budget",
action="keepCollecting",
audit_threshold=85,
capacity_bytes=30000000000,
description="For testing purposes",
reset_time="00:00",
scope="_sourceCategory=*prod*nginx*",
timezone="Etc/UTC")
import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";
const budget = new sumologic.IngestBudgetV2("budget", {
action: "keepCollecting",
auditThreshold: 85,
capacityBytes: 30000000000,
description: "For testing purposes",
resetTime: "00:00",
scope: "_sourceCategory=*prod*nginx*",
timezone: "Etc/UTC",
});
resources:
budget:
type: sumologic:IngestBudgetV2
properties:
action: keepCollecting
auditThreshold: 85
capacityBytes: 3e+10
description: For testing purposes
resetTime: 00:00
scope: _sourceCategory=*prod*nginx*
timezone: Etc/UTC
Create IngestBudgetV2 Resource
new IngestBudgetV2(name: string, args: IngestBudgetV2Args, opts?: CustomResourceOptions);
@overload
def IngestBudgetV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
audit_threshold: Optional[int] = None,
capacity_bytes: Optional[int] = None,
description: Optional[str] = None,
name: Optional[str] = None,
reset_time: Optional[str] = None,
scope: Optional[str] = None,
timezone: Optional[str] = None)
@overload
def IngestBudgetV2(resource_name: str,
args: IngestBudgetV2Args,
opts: Optional[ResourceOptions] = None)
func NewIngestBudgetV2(ctx *Context, name string, args IngestBudgetV2Args, opts ...ResourceOption) (*IngestBudgetV2, error)
public IngestBudgetV2(string name, IngestBudgetV2Args args, CustomResourceOptions? opts = null)
public IngestBudgetV2(String name, IngestBudgetV2Args args)
public IngestBudgetV2(String name, IngestBudgetV2Args args, CustomResourceOptions options)
type: sumologic:IngestBudgetV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IngestBudgetV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IngestBudgetV2Args
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IngestBudgetV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IngestBudgetV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IngestBudgetV2Args
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IngestBudgetV2 Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The IngestBudgetV2 resource accepts the following input properties:
- Action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- Capacity
Bytes int Capacity of the ingest budget, in bytes.
- Reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- Scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- Timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- Audit
Threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- Description string
The description of the collector.
- Name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- Action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- Capacity
Bytes int Capacity of the ingest budget, in bytes.
- Reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- Scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- Timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- Audit
Threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- Description string
The description of the collector.
- Name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- action String
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- capacity
Bytes Integer Capacity of the ingest budget, in bytes.
- reset
Time String Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope String
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone String
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- audit
Threshold Integer The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- description String
The description of the collector.
- name String
Display name of the ingest budget. This must be unique across all of the ingest budgets
- action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- capacity
Bytes number Capacity of the ingest budget, in bytes.
- reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- audit
Threshold number The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- description string
The description of the collector.
- name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- action str
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- capacity_
bytes int Capacity of the ingest budget, in bytes.
- reset_
time str Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope str
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone str
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- audit_
threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- description str
The description of the collector.
- name str
Display name of the ingest budget. This must be unique across all of the ingest budgets
- action String
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- capacity
Bytes Number Capacity of the ingest budget, in bytes.
- reset
Time String Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope String
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone String
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- audit
Threshold Number The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- description String
The description of the collector.
- name String
Display name of the ingest budget. This must be unique across all of the ingest budgets
Outputs
All input properties are implicitly available as output properties. Additionally, the IngestBudgetV2 resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing IngestBudgetV2 Resource
Get an existing IngestBudgetV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: IngestBudgetV2State, opts?: CustomResourceOptions): IngestBudgetV2
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
action: Optional[str] = None,
audit_threshold: Optional[int] = None,
capacity_bytes: Optional[int] = None,
description: Optional[str] = None,
name: Optional[str] = None,
reset_time: Optional[str] = None,
scope: Optional[str] = None,
timezone: Optional[str] = None) -> IngestBudgetV2
func GetIngestBudgetV2(ctx *Context, name string, id IDInput, state *IngestBudgetV2State, opts ...ResourceOption) (*IngestBudgetV2, error)
public static IngestBudgetV2 Get(string name, Input<string> id, IngestBudgetV2State? state, CustomResourceOptions? opts = null)
public static IngestBudgetV2 get(String name, Output<String> id, IngestBudgetV2State state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- Audit
Threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- Capacity
Bytes int Capacity of the ingest budget, in bytes.
- Description string
The description of the collector.
- Name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- Reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- Scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- Timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- Action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- Audit
Threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- Capacity
Bytes int Capacity of the ingest budget, in bytes.
- Description string
The description of the collector.
- Name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- Reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- Scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- Timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- action String
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- audit
Threshold Integer The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- capacity
Bytes Integer Capacity of the ingest budget, in bytes.
- description String
The description of the collector.
- name String
Display name of the ingest budget. This must be unique across all of the ingest budgets
- reset
Time String Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope String
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone String
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- action string
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- audit
Threshold number The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- capacity
Bytes number Capacity of the ingest budget, in bytes.
- description string
The description of the collector.
- name string
Display name of the ingest budget. This must be unique across all of the ingest budgets
- reset
Time string Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope string
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone string
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- action str
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- audit_
threshold int The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- capacity_
bytes int Capacity of the ingest budget, in bytes.
- description str
The description of the collector.
- name str
Display name of the ingest budget. This must be unique across all of the ingest budgets
- reset_
time str Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope str
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone str
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
- action String
Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are
stopCollecting
andkeepCollecting
.- audit
Threshold Number The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.
- capacity
Bytes Number Capacity of the ingest budget, in bytes.
- description String
The description of the collector.
- name String
Display name of the ingest budget. This must be unique across all of the ingest budgets
- reset
Time String Reset time of the ingest budget in HH:MM format. Defaults to
00:00
- scope String
A scope is a constraint that will be used to identify the messages on which budget needs to be applied. A scope is consists of key and value separated by =. The field must be enabled in the fields table.
- timezone String
The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to
Etc/UTC
Import
Ingest budgets can be imported using the name, e.g.hcl
$ pulumi import sumologic:index/ingestBudgetV2:IngestBudgetV2 budget budgetName
[1]https://help.sumologic.com/Beta/Metadata_Ingest_Budgets [2]https://en.wikipedia.org/wiki/Tz_database
Package Details
- Repository
- Sumo Logic pulumi/pulumi-sumologic
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
sumologic
Terraform Provider.