1. Packages
  2. Sumologic Provider
  3. API Docs
  4. IngestBudget
Sumo Logic v0.23.7 published on Thursday, Oct 24, 2024 by Pulumi

sumologic.IngestBudget

Explore with Pulumi AI

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

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

    DEPRECATED: This resource is deprecated and is being removed. Kindly use sumologic.IngestBudgetV2 instead.

    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.

    Constructor 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

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

    The IngestBudget resource accepts the following input properties:

    CapacityBytes int
    FieldValue string
    Action string
    Description string
    Name string
    ResetTime string
    Timezone string
    CapacityBytes int
    FieldValue string
    Action string
    Description string
    Name string
    ResetTime string
    Timezone string
    capacityBytes Integer
    fieldValue String
    action String
    description String
    name String
    resetTime String
    timezone String
    capacityBytes number
    fieldValue string
    action string
    description string
    name string
    resetTime string
    timezone string
    capacityBytes Number
    fieldValue String
    action String
    description String
    name String
    resetTime String
    timezone String

    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
    CapacityBytes int
    Description string
    FieldValue string
    Name string
    ResetTime string
    Timezone string
    Action string
    CapacityBytes int
    Description string
    FieldValue string
    Name string
    ResetTime string
    Timezone string
    action String
    capacityBytes Integer
    description String
    fieldValue String
    name String
    resetTime String
    timezone String
    action string
    capacityBytes number
    description string
    fieldValue string
    name string
    resetTime string
    timezone string
    action String
    capacityBytes Number
    description String
    fieldValue String
    name String
    resetTime String
    timezone String

    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.23.7 published on Thursday, Oct 24, 2024 by Pulumi