Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sumologic Provider
  3. API Docs
  4. ScanBudget
Sumo Logic v1.0.6 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-sumologic

sumologic.ScanBudget

Explore with Pulumi AI

sumologic logo
Sumo Logic v1.0.6 published on Tuesday, Mar 11, 2025 by Pulumi
pulumi/pulumi-sumologic

    Provides a Sumologic Scan Budget.

    Example Usage

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

const budget = new sumologic.ScanBudget("budget", {
    name: "TestBudget",
    capacity: 10,
    unit: "GB",
    budgetType: "ScanBudget",
    window: "Query",
    applicableOn: "PerEntity",
    groupBy: "User",
    action: "StopScan",
    status: "active",
    scope: {
        includedUsers: ["000000000000011C"],
        excludedUsers: [],
        includedRoles: [],
        excludedRoles: ["0000000000000196"],
    },
});

    import pulumi
import pulumi_sumologic as sumologic

budget = sumologic.ScanBudget("budget",
    name="TestBudget",
    capacity=10,
    unit="GB",
    budget_type="ScanBudget",
    window="Query",
    applicable_on="PerEntity",
    group_by="User",
    action="StopScan",
    status="active",
    scope={
        "included_users": ["000000000000011C"],
        "excluded_users": [],
        "included_roles": [],
        "excluded_roles": ["0000000000000196"],
    })

    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.NewScanBudget(ctx, "budget", &sumologic.ScanBudgetArgs{
			Name:         pulumi.String("TestBudget"),
			Capacity:     pulumi.Int(10),
			Unit:         pulumi.String("GB"),
			BudgetType:   pulumi.String("ScanBudget"),
			Window:       pulumi.String("Query"),
			ApplicableOn: pulumi.String("PerEntity"),
			GroupBy:      pulumi.String("User"),
			Action:       pulumi.String("StopScan"),
			Status:       pulumi.String("active"),
			Scope: &sumologic.ScanBudgetScopeArgs{
				IncludedUsers: pulumi.StringArray{
					pulumi.String("000000000000011C"),
				},
				ExcludedUsers: pulumi.StringArray{},
				IncludedRoles: pulumi.StringArray{},
				ExcludedRoles: pulumi.StringArray{
					pulumi.String("0000000000000196"),
				},
			},
		})
		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.ScanBudget("budget", new()
    {
        Name = "TestBudget",
        Capacity = 10,
        Unit = "GB",
        BudgetType = "ScanBudget",
        Window = "Query",
        ApplicableOn = "PerEntity",
        GroupBy = "User",
        Action = "StopScan",
        Status = "active",
        Scope = new SumoLogic.Inputs.ScanBudgetScopeArgs
        {
            IncludedUsers = new[]
            {
                "000000000000011C",
            },
            ExcludedUsers = new() { },
            IncludedRoles = new() { },
            ExcludedRoles = new[]
            {
                "0000000000000196",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sumologic.ScanBudget;
import com.pulumi.sumologic.ScanBudgetArgs;
import com.pulumi.sumologic.inputs.ScanBudgetScopeArgs;
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 ScanBudget("budget", ScanBudgetArgs.builder()
            .name("TestBudget")
            .capacity(10)
            .unit("GB")
            .budgetType("ScanBudget")
            .window("Query")
            .applicableOn("PerEntity")
            .groupBy("User")
            .action("StopScan")
            .status("active")
            .scope(ScanBudgetScopeArgs.builder()
                .includedUsers("000000000000011C")
                .excludedUsers()
                .includedRoles()
                .excludedRoles("0000000000000196")
                .build())
            .build());

    }
}

    resources:
  budget:
    type: sumologic:ScanBudget
    properties:
      name: TestBudget
      capacity: 10
      unit: GB
      budgetType: ScanBudget
      window: Query
      applicableOn: PerEntity
      groupBy: User
      action: StopScan
      status: active
      scope:
        includedUsers:
          - 000000000000011C
        excludedUsers: []
        includedRoles: []
        excludedRoles:
          - '0000000000000196'

    Create ScanBudget Resource

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

    Constructor syntax

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

@overload
def ScanBudget(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               action: Optional[str] = None,
               applicable_on: Optional[str] = None,
               budget_type: Optional[str] = None,
               capacity: Optional[int] = None,
               group_by: Optional[str] = None,
               scope: Optional[ScanBudgetScopeArgs] = None,
               status: Optional[str] = None,
               unit: Optional[str] = None,
               window: Optional[str] = None,
               name: Optional[str] = None)
    func NewScanBudget(ctx *Context, name string, args ScanBudgetArgs, opts ...ResourceOption) (*ScanBudget, error)
    public ScanBudget(string name, ScanBudgetArgs args, CustomResourceOptions? opts = null)
    public ScanBudget(String name, ScanBudgetArgs args)
public ScanBudget(String name, ScanBudgetArgs args, CustomResourceOptions options)

    type: sumologic:ScanBudget
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 ScanBudgetArgs
    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 ScanBudgetArgs
    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 ScanBudgetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScanBudgetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScanBudgetArgs
    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 scanBudgetResource = new SumoLogic.ScanBudget("scanBudgetResource", new()
{
    Action = "string",
    ApplicableOn = "string",
    BudgetType = "string",
    Capacity = 0,
    GroupBy = "string",
    Scope = new SumoLogic.Inputs.ScanBudgetScopeArgs
    {
        ExcludedRoles = new[]
        {
            "string",
        },
        ExcludedUsers = new[]
        {
            "string",
        },
        IncludedRoles = new[]
        {
            "string",
        },
        IncludedUsers = new[]
        {
            "string",
        },
    },
    Status = "string",
    Unit = "string",
    Window = "string",
    Name = "string",
});

    example, err := sumologic.NewScanBudget(ctx, "scanBudgetResource", &sumologic.ScanBudgetArgs{
	Action:       pulumi.String("string"),
	ApplicableOn: pulumi.String("string"),
	BudgetType:   pulumi.String("string"),
	Capacity:     pulumi.Int(0),
	GroupBy:      pulumi.String("string"),
	Scope: &sumologic.ScanBudgetScopeArgs{
		ExcludedRoles: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExcludedUsers: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludedRoles: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludedUsers: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Status: pulumi.String("string"),
	Unit:   pulumi.String("string"),
	Window: pulumi.String("string"),
	Name:   pulumi.String("string"),
})

    var scanBudgetResource = new ScanBudget("scanBudgetResource", ScanBudgetArgs.builder()
    .action("string")
    .applicableOn("string")
    .budgetType("string")
    .capacity(0)
    .groupBy("string")
    .scope(ScanBudgetScopeArgs.builder()
        .excludedRoles("string")
        .excludedUsers("string")
        .includedRoles("string")
        .includedUsers("string")
        .build())
    .status("string")
    .unit("string")
    .window("string")
    .name("string")
    .build());

    scan_budget_resource = sumologic.ScanBudget("scanBudgetResource",
    action="string",
    applicable_on="string",
    budget_type="string",
    capacity=0,
    group_by="string",
    scope={
        "excluded_roles": ["string"],
        "excluded_users": ["string"],
        "included_roles": ["string"],
        "included_users": ["string"],
    },
    status="string",
    unit="string",
    window="string",
    name="string")

    const scanBudgetResource = new sumologic.ScanBudget("scanBudgetResource", {
    action: "string",
    applicableOn: "string",
    budgetType: "string",
    capacity: 0,
    groupBy: "string",
    scope: {
        excludedRoles: ["string"],
        excludedUsers: ["string"],
        includedRoles: ["string"],
        includedUsers: ["string"],
    },
    status: "string",
    unit: "string",
    window: "string",
    name: "string",
});

    type: sumologic:ScanBudget
properties:
    action: string
    applicableOn: string
    budgetType: string
    capacity: 0
    groupBy: string
    name: string
    scope:
        excludedRoles:
            - string
        excludedUsers:
            - string
        includedRoles:
            - string
        includedUsers:
            - string
    status: string
    unit: string
    window: string

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

    Action string
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    ApplicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    BudgetType string
    Type of the budget. Supported values are: ScanBudget.
    Capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    GroupBy string
    Grouping Entity of the budget. Supported values are: User.
    Scope Pulumi.SumoLogic.Inputs.ScanBudgetScope
    Scope of the budget.
    Status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    Unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    Window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    Name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    Action string
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    ApplicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    BudgetType string
    Type of the budget. Supported values are: ScanBudget.
    Capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    GroupBy string
    Grouping Entity of the budget. Supported values are: User.
    Scope ScanBudgetScopeArgs
    Scope of the budget.
    Status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    Unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    Window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    Name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    action String
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn String
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType String
    Type of the budget. Supported values are: ScanBudget.
    capacity Integer
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy String
    Grouping Entity of the budget. Supported values are: User.
    scope ScanBudgetScope
    Scope of the budget.
    status String

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit String
    Unit of the capacity. Supported values are: MB, GB and TB.
    window String
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    name String
    Display name of the scan budget. This must be unique across all the scan budgets.
    action string
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType string
    Type of the budget. Supported values are: ScanBudget.
    capacity number
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy string
    Grouping Entity of the budget. Supported values are: User.
    scope ScanBudgetScope
    Scope of the budget.
    status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    action str
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicable_on str
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budget_type str
    Type of the budget. Supported values are: ScanBudget.
    capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    group_by str
    Grouping Entity of the budget. Supported values are: User.
    scope ScanBudgetScopeArgs
    Scope of the budget.
    status str

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit str
    Unit of the capacity. Supported values are: MB, GB and TB.
    window str
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    name str
    Display name of the scan budget. This must be unique across all the scan budgets.
    action String
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn String
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType String
    Type of the budget. Supported values are: ScanBudget.
    capacity Number
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy String
    Grouping Entity of the budget. Supported values are: User.
    scope Property Map
    Scope of the budget.
    status String

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit String
    Unit of the capacity. Supported values are: MB, GB and TB.
    window String
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    name String
    Display name of the scan budget. This must be unique across all the scan budgets.

    Outputs

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

    Get an existing ScanBudget 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?: ScanBudgetState, opts?: CustomResourceOptions): ScanBudget
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        applicable_on: Optional[str] = None,
        budget_type: Optional[str] = None,
        capacity: Optional[int] = None,
        group_by: Optional[str] = None,
        name: Optional[str] = None,
        scope: Optional[ScanBudgetScopeArgs] = None,
        status: Optional[str] = None,
        unit: Optional[str] = None,
        window: Optional[str] = None) -> ScanBudget
    func GetScanBudget(ctx *Context, name string, id IDInput, state *ScanBudgetState, opts ...ResourceOption) (*ScanBudget, error)
    public static ScanBudget Get(string name, Input<string> id, ScanBudgetState? state, CustomResourceOptions? opts = null)
    public static ScanBudget get(String name, Output<String> id, ScanBudgetState state, CustomResourceOptions options)
    resources:  _:    type: sumologic:ScanBudget    get:      id: ${id}
    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 be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    ApplicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    BudgetType string
    Type of the budget. Supported values are: ScanBudget.
    Capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    GroupBy string
    Grouping Entity of the budget. Supported values are: User.
    Name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    Scope Pulumi.SumoLogic.Inputs.ScanBudgetScope
    Scope of the budget.
    Status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    Unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    Window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    Action string
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    ApplicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    BudgetType string
    Type of the budget. Supported values are: ScanBudget.
    Capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    GroupBy string
    Grouping Entity of the budget. Supported values are: User.
    Name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    Scope ScanBudgetScopeArgs
    Scope of the budget.
    Status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    Unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    Window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    action String
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn String
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType String
    Type of the budget. Supported values are: ScanBudget.
    capacity Integer
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy String
    Grouping Entity of the budget. Supported values are: User.
    name String
    Display name of the scan budget. This must be unique across all the scan budgets.
    scope ScanBudgetScope
    Scope of the budget.
    status String

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit String
    Unit of the capacity. Supported values are: MB, GB and TB.
    window String
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    action string
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn string
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType string
    Type of the budget. Supported values are: ScanBudget.
    capacity number
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy string
    Grouping Entity of the budget. Supported values are: User.
    name string
    Display name of the scan budget. This must be unique across all the scan budgets.
    scope ScanBudgetScope
    Scope of the budget.
    status string

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit string
    Unit of the capacity. Supported values are: MB, GB and TB.
    window string
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    action str
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicable_on str
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budget_type str
    Type of the budget. Supported values are: ScanBudget.
    capacity int
    Capacity of the scan budget. Only whole numbers are supported.
    group_by str
    Grouping Entity of the budget. Supported values are: User.
    name str
    Display name of the scan budget. This must be unique across all the scan budgets.
    scope ScanBudgetScopeArgs
    Scope of the budget.
    status str

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit str
    Unit of the capacity. Supported values are: MB, GB and TB.
    window str
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.
    action String
    Action to be taken if the budget is breached. Supported values are: StopForeGroundScan and Warn.
    applicableOn String
    Grouping of the budget. Supported values are: PerEntity and Sum.
    budgetType String
    Type of the budget. Supported values are: ScanBudget.
    capacity Number
    Capacity of the scan budget. Only whole numbers are supported.
    groupBy String
    Grouping Entity of the budget. Supported values are: User.
    name String
    Display name of the scan budget. This must be unique across all the scan budgets.
    scope Property Map
    Scope of the budget.
    status String

    Signifies the state of the budget. Supported values are: active and inactive.

    The following attributes are exported:

    unit String
    Unit of the capacity. Supported values are: MB, GB and TB.
    window String
    Window of the budget. Supported values are: Query, Daily, Weekly and Monthly.

    Supporting Types

    ScanBudgetScope, ScanBudgetScopeArgs

    ExcludedRoles List<string>
    ExcludedUsers List<string>
    IncludedRoles List<string>
    IncludedUsers List<string>
    ExcludedRoles []string
    ExcludedUsers []string
    IncludedRoles []string
    IncludedUsers []string
    excludedRoles List<String>
    excludedUsers List<String>
    includedRoles List<String>
    includedUsers List<String>
    excludedRoles string[]
    excludedUsers string[]
    includedRoles string[]
    includedUsers string[]
    excluded_roles Sequence[str]
    excluded_users Sequence[str]
    included_roles Sequence[str]
    included_users Sequence[str]
    excludedRoles List<String>
    excludedUsers List<String>
    includedRoles List<String>
    includedUsers List<String>

    Import

    Scan budgets can be imported using the budget ID, e.g.:

    hcl

    $ pulumi import sumologic:index/scanBudget:ScanBudget 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.
    sumologic logo
    Sumo Logic v1.0.6 published on Tuesday, Mar 11, 2025 by Pulumi
    pulumi/pulumi-sumologic