Sumo Logic v0.23.7, Oct 24 24

Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi

sumologic.IngestBudgetV2

Explore with Pulumi AI

Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as sumologic from "@pulumi/sumologic";

const budget = new sumologic.IngestBudgetV2("budget", {
    name: "testBudget",
    scope: "_sourceCategory=*prod*nginx*",
    budgetType: "dailyVolume",
    capacityBytes: 30000000000,
    description: "For testing purposes",
    timezone: "Etc/UTC",
    action: "keepCollecting",
    resetTime: "00:00",
    auditThreshold: 85,
});

import pulumi
import pulumi_sumologic as sumologic

budget = sumologic.IngestBudgetV2("budget",
    name="testBudget",
    scope="_sourceCategory=*prod*nginx*",
    budget_type="dailyVolume",
    capacity_bytes=30000000000,
    description="For testing purposes",
    timezone="Etc/UTC",
    action="keepCollecting",
    reset_time="00:00",
    audit_threshold=85)

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{
			Name:           pulumi.String("testBudget"),
			Scope:          pulumi.String("_sourceCategory=*prod*nginx*"),
			BudgetType:     pulumi.String("dailyVolume"),
			CapacityBytes:  pulumi.Int(30000000000),
			Description:    pulumi.String("For testing purposes"),
			Timezone:       pulumi.String("Etc/UTC"),
			Action:         pulumi.String("keepCollecting"),
			ResetTime:      pulumi.String("00:00"),
			AuditThreshold: pulumi.Int(85),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SumoLogic = Pulumi.SumoLogic;

return await Deployment.RunAsync(() => 
{
    var budget = new SumoLogic.IngestBudgetV2("budget", new()
    {
        Name = "testBudget",
        Scope = "_sourceCategory=*prod*nginx*",
        BudgetType = "dailyVolume",
        CapacityBytes = 30000000000,
        Description = "For testing purposes",
        Timezone = "Etc/UTC",
        Action = "keepCollecting",
        ResetTime = "00:00",
        AuditThreshold = 85,
    });

});

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()
            .name("testBudget")
            .scope("_sourceCategory=*prod*nginx*")
            .budgetType("dailyVolume")
            .capacityBytes(30000000000)
            .description("For testing purposes")
            .timezone("Etc/UTC")
            .action("keepCollecting")
            .resetTime("00:00")
            .auditThreshold(85)
            .build());

    }
}

resources:
  budget:
    type: sumologic:IngestBudgetV2
    properties:
      name: testBudget
      scope: _sourceCategory=*prod*nginx*
      budgetType: dailyVolume
      capacityBytes: 3e+10
      description: For testing purposes
      timezone: Etc/UTC
      action: keepCollecting
      resetTime: 00:00
      auditThreshold: 85

Create IngestBudgetV2 Resource

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

Constructor syntax

new IngestBudgetV2(name: string, args: IngestBudgetV2Args, opts?: CustomResourceOptions);

@overload
def IngestBudgetV2(resource_name: str,
                   args: IngestBudgetV2Args,
                   opts: Optional[ResourceOptions] = None)

@overload
def IngestBudgetV2(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   action: Optional[str] = None,
                   capacity_bytes: Optional[int] = None,
                   reset_time: Optional[str] = None,
                   scope: Optional[str] = None,
                   timezone: Optional[str] = None,
                   audit_threshold: Optional[int] = None,
                   budget_type: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = 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.

Parameters

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.

Constructor example

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

var ingestBudgetV2Resource = new SumoLogic.IngestBudgetV2("ingestBudgetV2Resource", new()
{
    Action = "string",
    CapacityBytes = 0,
    ResetTime = "string",
    Scope = "string",
    Timezone = "string",
    AuditThreshold = 0,
    BudgetType = "string",
    Description = "string",
    Name = "string",
});

example, err := sumologic.NewIngestBudgetV2(ctx, "ingestBudgetV2Resource", &sumologic.IngestBudgetV2Args{
	Action:         pulumi.String("string"),
	CapacityBytes:  pulumi.Int(0),
	ResetTime:      pulumi.String("string"),
	Scope:          pulumi.String("string"),
	Timezone:       pulumi.String("string"),
	AuditThreshold: pulumi.Int(0),
	BudgetType:     pulumi.String("string"),
	Description:    pulumi.String("string"),
	Name:           pulumi.String("string"),
})

var ingestBudgetV2Resource = new IngestBudgetV2("ingestBudgetV2Resource", IngestBudgetV2Args.builder()
    .action("string")
    .capacityBytes(0)
    .resetTime("string")
    .scope("string")
    .timezone("string")
    .auditThreshold(0)
    .budgetType("string")
    .description("string")
    .name("string")
    .build());

ingest_budget_v2_resource = sumologic.IngestBudgetV2("ingestBudgetV2Resource",
    action="string",
    capacity_bytes=0,
    reset_time="string",
    scope="string",
    timezone="string",
    audit_threshold=0,
    budget_type="string",
    description="string",
    name="string")

const ingestBudgetV2Resource = new sumologic.IngestBudgetV2("ingestBudgetV2Resource", {
    action: "string",
    capacityBytes: 0,
    resetTime: "string",
    scope: "string",
    timezone: "string",
    auditThreshold: 0,
    budgetType: "string",
    description: "string",
    name: "string",
});

type: sumologic:IngestBudgetV2
properties:
    action: string
    auditThreshold: 0
    budgetType: string
    capacityBytes: 0
    description: string
    name: string
    resetTime: string
    scope: string
    timezone: string

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

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

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 and keepCollecting.

CapacityBytes int

Capacity of the ingest budget, in bytes. It takes a few minutes for Collectors to stop collecting when capacity is reached. We recommend setting a soft limit that is lower than your needed hard limit. The capacity bytes unit varies based on the budgetType field. For dailyVolume budgetType the capacity specified is in bytes/day whereas for minuteVolume budgetType its bytes/min.

ResetTime 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

AuditThreshold int

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

BudgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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 and keepCollecting.

CapacityBytes int

ResetTime string

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

Scope string

Timezone string

The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC

AuditThreshold int

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

BudgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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 and keepCollecting.

capacityBytes Integer

resetTime String

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope String

timezone String

The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC

auditThreshold Integer

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType String

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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 and keepCollecting.

capacityBytes number

resetTime string

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope string

timezone string

The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC

auditThreshold number

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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 and keepCollecting.

capacity_bytes int

reset_time str

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope str

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.

The following attributes are exported:

budget_type str

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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 and keepCollecting.

capacityBytes Number

resetTime String

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope String

timezone String

The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC

auditThreshold Number

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType String

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

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,
        budget_type: Optional[str] = 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.

The following state arguments are supported:

Action string

Action to take when ingest budget's capacity is reached. All actions are audited. Supported values are stopCollecting and keepCollecting.

AuditThreshold int

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

BudgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

CapacityBytes int

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

ResetTime string

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

Scope string

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 and keepCollecting.

AuditThreshold int

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

BudgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

CapacityBytes int

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

ResetTime string

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

Scope string

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 and keepCollecting.

auditThreshold Integer

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType String

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

capacityBytes Integer

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

resetTime String

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope String

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 and keepCollecting.

auditThreshold number

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType string

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

capacityBytes number

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

resetTime string

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope string

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 and keepCollecting.

audit_threshold int

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budget_type str

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

capacity_bytes int

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

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 and keepCollecting.

auditThreshold Number

The threshold as a percentage of when an ingest budget's capacity usage is logged in the Audit Index.

The following attributes are exported:

budgetType String

The type of budget. Supported values are: * dailyVolume * minuteVolume. Default value is dailyVolume.

capacityBytes Number

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

resetTime String

Reset time of the ingest budget in HH:MM format. Defaults to 00:00

scope String

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 budget ID, e.g.:

hcl

$ pulumi import sumologic:index/ingestBudgetV2:IngestBudgetV2 budget 00000000000123AB

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

Package Details

Repository: Sumo Logic pulumi/pulumi-sumologic
License: Apache-2.0
Notes: This Pulumi package is based on the sumologic Terraform Provider.

Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi

pulumi/pulumi-sumologic

sumologic.IngestBudgetV2

On this page

On this page

Example Usage

Create IngestBudgetV2 Resource

Constructor syntax

Parameters

Constructor example

IngestBudgetV2 Resource Properties

Inputs

Outputs

Look up Existing IngestBudgetV2 Resource

Import

Package Details

On this page

On this page