Docs Packages
  1. Packages
  2. Sumo Logic
  3. API Docs
  4. IngestBudget
Sumo Logic v0.21.0 published on Thursday, Apr 11, 2024 by Pulumi
pulumi/pulumi-sumologic

sumologic.IngestBudget

Explore with Pulumi AI

sumologic logo
Sumo Logic v0.21.0 published on Thursday, Apr 11, 2024 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic Ingest Budget. To assign an Ingest Budget to the Collector use the field _budget with the Field Value of the Ingest Budget to assign.

    Example Usage

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

const budget = new sumologic.IngestBudget("budget", {
    capacityBytes: 30000000000,
    description: "For testing purposes",
    fieldValue: "test",
});
const collector = new sumologic.Collector("collector", {fields: {
    _budget: budget.fieldValue,
}});

    import pulumi
import pulumi_sumologic as sumologic

budget = sumologic.IngestBudget("budget",
    capacity_bytes=30000000000,
    description="For testing purposes",
    field_value="test")
collector = sumologic.Collector("collector", fields={
    "_budget": budget.field_value,
})

    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 {
		budget, err := sumologic.NewIngestBudget(ctx, "budget", &sumologic.IngestBudgetArgs{
			CapacityBytes: pulumi.Int(30000000000),
			Description:   pulumi.String("For testing purposes"),
			FieldValue:    pulumi.String("test"),
		})
		if err != nil {
			return err
		}
		_, err = sumologic.NewCollector(ctx, "collector", &sumologic.CollectorArgs{
			Fields: pulumi.StringMap{
				"_budget": budget.FieldValue,
			},
		})
		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.IngestBudget("budget", new()
    {
        CapacityBytes = 30000000000,
        Description = "For testing purposes",
        FieldValue = "test",
    });

    var collector = new SumoLogic.Collector("collector", new()
    {
        Fields = 
        {
            { "_budget", budget.FieldValue },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.IngestBudget;
import com.pulumi.sumologic.IngestBudgetArgs;
import com.pulumi.sumologic.Collector;
import com.pulumi.sumologic.CollectorArgs;
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 IngestBudget("budget", IngestBudgetArgs.builder()        
            .capacityBytes(30000000000)
            .description("For testing purposes")
            .fieldValue("test")
            .build());

        var collector = new Collector("collector", CollectorArgs.builder()        
            .fields(Map.of("_budget", budget.fieldValue()))
            .build());

    }
}

    resources:
  collector:
    type: sumologic:Collector
    properties:
      fields:
        _budget: ${budget.fieldValue}
  budget:
    type: sumologic:IngestBudget
    properties:
      capacityBytes: 3e+10
      description: For testing purposes
      fieldValue: test

    Create IngestBudget Resource

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

    Constructor syntax

    new IngestBudget(name: string, args: IngestBudgetArgs, opts?: CustomResourceOptions);
    @overload
def IngestBudget(resource_name: str,
                 args: IngestBudgetArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def IngestBudget(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 capacity_bytes: Optional[int] = None,
                 field_value: Optional[str] = None,
                 action: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 reset_time: Optional[str] = None,
                 timezone: Optional[str] = None)
    func NewIngestBudget(ctx *Context, name string, args IngestBudgetArgs, opts ...ResourceOption) (*IngestBudget, error)
    public IngestBudget(string name, IngestBudgetArgs args, CustomResourceOptions? opts = null)
    public IngestBudget(String name, IngestBudgetArgs args)
public IngestBudget(String name, IngestBudgetArgs args, CustomResourceOptions options)

    type: sumologic:IngestBudget
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 IngestBudgetArgs
    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 IngestBudgetArgs
    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 IngestBudgetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IngestBudgetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IngestBudgetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var ingestBudgetResource = new SumoLogic.IngestBudget("ingestBudgetResource", new()
{
    CapacityBytes = 0,
    FieldValue = "string",
    Action = "string",
    Description = "string",
    Name = "string",
    ResetTime = "string",
    Timezone = "string",
});

    example, err := sumologic.NewIngestBudget(ctx, "ingestBudgetResource", &sumologic.IngestBudgetArgs{
	CapacityBytes: pulumi.Int(0),
	FieldValue:    pulumi.String("string"),
	Action:        pulumi.String("string"),
	Description:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	ResetTime:     pulumi.String("string"),
	Timezone:      pulumi.String("string"),
})

    var ingestBudgetResource = new IngestBudget("ingestBudgetResource", IngestBudgetArgs.builder()        
    .capacityBytes(0)
    .fieldValue("string")
    .action("string")
    .description("string")
    .name("string")
    .resetTime("string")
    .timezone("string")
    .build());

    ingest_budget_resource = sumologic.IngestBudget("ingestBudgetResource",
    capacity_bytes=0,
    field_value="string",
    action="string",
    description="string",
    name="string",
    reset_time="string",
    timezone="string")

    const ingestBudgetResource = new sumologic.IngestBudget("ingestBudgetResource", {
    capacityBytes: 0,
    fieldValue: "string",
    action: "string",
    description: "string",
    name: "string",
    resetTime: "string",
    timezone: "string",
});

    type: sumologic:IngestBudget
properties:
    action: string
    capacityBytes: 0
    description: string
    fieldValue: string
    name: string
    resetTime: string
    timezone: string

    IngestBudget 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 IngestBudget resource accepts the following input properties:

    CapacityBytes int
    Capacity of the ingest budget, in bytes.
    FieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    Action string

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

    The following attributes are exported:

    Description string
    Description of the ingest budget.
    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
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC
    CapacityBytes int
    Capacity of the ingest budget, in bytes.
    FieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    Action string

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

    The following attributes are exported:

    Description string
    Description of the ingest budget.
    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
    Timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC
    capacityBytes Integer
    Capacity of the ingest budget, in bytes.
    fieldValue String
    Custom field value that is used to assign Collectors to the ingest budget.
    action String

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

    The following attributes are exported:

    description String
    Description of the ingest budget.
    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
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC
    capacityBytes number
    Capacity of the ingest budget, in bytes.
    fieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    action string

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

    The following attributes are exported:

    description string
    Description of the ingest budget.
    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
    timezone string
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC
    capacity_bytes int
    Capacity of the ingest budget, in bytes.
    field_value str
    Custom field value that is used to assign Collectors to the ingest budget.
    action str

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

    The following attributes are exported:

    description str
    Description of the ingest budget.
    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
    timezone str
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC
    capacityBytes Number
    Capacity of the ingest budget, in bytes.
    fieldValue String
    Custom field value that is used to assign Collectors to the ingest budget.
    action String

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

    The following attributes are exported:

    description String
    Description of the ingest budget.
    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
    timezone String
    The time zone to use for this collector. The value follows the tzdata naming convention. Defaults to Etc/UTC

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IngestBudget 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 IngestBudget Resource

    Get an existing IngestBudget 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?: IngestBudgetState, opts?: CustomResourceOptions): IngestBudget
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        capacity_bytes: Optional[int] = None,
        description: Optional[str] = None,
        field_value: Optional[str] = None,
        name: Optional[str] = None,
        reset_time: Optional[str] = None,
        timezone: Optional[str] = None) -> IngestBudget
    func GetIngestBudget(ctx *Context, name string, id IDInput, state *IngestBudgetState, opts ...ResourceOption) (*IngestBudget, error)
    public static IngestBudget Get(string name, Input<string> id, IngestBudgetState? state, CustomResourceOptions? opts = null)
    public static IngestBudget get(String name, Output<String> id, IngestBudgetState 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.

    The following attributes are exported:

    CapacityBytes int
    Capacity of the ingest budget, in bytes.
    Description string
    Description of the ingest budget.
    FieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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.

    The following attributes are exported:

    CapacityBytes int
    Capacity of the ingest budget, in bytes.
    Description string
    Description of the ingest budget.
    FieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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.

    The following attributes are exported:

    capacityBytes Integer
    Capacity of the ingest budget, in bytes.
    description String
    Description of the ingest budget.
    fieldValue String
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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.

    The following attributes are exported:

    capacityBytes number
    Capacity of the ingest budget, in bytes.
    description string
    Description of the ingest budget.
    fieldValue string
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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.

    The following attributes are exported:

    capacity_bytes int
    Capacity of the ingest budget, in bytes.
    description str
    Description of the ingest budget.
    field_value str
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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.

    The following attributes are exported:

    capacityBytes Number
    Capacity of the ingest budget, in bytes.
    description String
    Description of the ingest budget.
    fieldValue String
    Custom field value that is used to assign Collectors to the ingest budget.
    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
    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/ingestBudget:IngestBudget budget budgetName

    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.
    sumologic logo
    Sumo Logic v0.21.0 published on Thursday, Apr 11, 2024 by Pulumi
    pulumi/pulumi-sumologic