Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Logzio Provider
  3. API Docs
  4. getSubaccount
logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio
logzio/terraform-provider-logzio

logzio.getSubaccount

Explore with Pulumi AI

logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio
logzio/terraform-provider-logzio

# Subaccount Datasource

Use this data source to access information about existing Logz.io Log Monitoring Subaccounts.

Attribute Reference

  • email - (String) Email address of an existing admin user on the main account which will also become the admin of the subaccount being created.
  • account_name - (String) Name of the subaccount.
  • max_daily_gb - (Float) Maximum daily log volume that the subaccount can index, in GB.
  • retention_days - (Integer) Number of days that log data is retained.
  • sharing_objects_accounts - (List) IDs of accounts that can access the account’s Kibana objects. Can be an empty array.
  • searchable - (Boolean) False by default. Determines if other accounts can search logs indexed by the subaccount.
  • accessible - (Boolean) False by default. Determines if users of main account can access the subaccount.
  • doc_size_setting - (Boolean) False by default. If enabled, Logz.io adds a LogSize field to record the size of the log line in bytes, for the purpose of managing account utilization. Learn more about managing account usage
  • utilization_enabled - (Boolean) If enabled, account utilization metrics and expected utilization at the current indexing rate are measured at a pre-defined sampling rate. Useful for managing account utilization and avoiding running out of capacity. Learn more about managing account capacity.
  • frequency_minutes - (Int) Determines the sampling rate in minutes of the utilization.
  • flexible - (Boolean) Defaults to false. Whether the sub account that created is flexible or not. Can be set to flexible only if the main account is flexible.
  • reserved_daily_gb - (Float) The maximum volume of data that an account can index per calendar day. Depends on flexible. For further info see the docs.

Using getSubaccount

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getSubaccount(args: GetSubaccountArgs, opts?: InvokeOptions): Promise<GetSubaccountResult>
function getSubaccountOutput(args: GetSubaccountOutputArgs, opts?: InvokeOptions): Output<GetSubaccountResult>
Copy
def get_subaccount(accessible: Optional[bool] = None,
                   account_id: Optional[float] = None,
                   account_name: Optional[str] = None,
                   account_token: Optional[str] = None,
                   doc_size_setting: Optional[bool] = None,
                   email: Optional[str] = None,
                   flexible: Optional[bool] = None,
                   frequency_minutes: Optional[float] = None,
                   id: Optional[str] = None,
                   max_daily_gb: Optional[float] = None,
                   reserved_daily_gb: Optional[float] = None,
                   retention_days: Optional[float] = None,
                   searchable: Optional[bool] = None,
                   sharing_objects_accounts: Optional[Sequence[float]] = None,
                   timeouts: Optional[GetSubaccountTimeouts] = None,
                   utilization_enabled: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSubaccountResult
def get_subaccount_output(accessible: Optional[pulumi.Input[bool]] = None,
                   account_id: Optional[pulumi.Input[float]] = None,
                   account_name: Optional[pulumi.Input[str]] = None,
                   account_token: Optional[pulumi.Input[str]] = None,
                   doc_size_setting: Optional[pulumi.Input[bool]] = None,
                   email: Optional[pulumi.Input[str]] = None,
                   flexible: Optional[pulumi.Input[bool]] = None,
                   frequency_minutes: Optional[pulumi.Input[float]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   max_daily_gb: Optional[pulumi.Input[float]] = None,
                   reserved_daily_gb: Optional[pulumi.Input[float]] = None,
                   retention_days: Optional[pulumi.Input[float]] = None,
                   searchable: Optional[pulumi.Input[bool]] = None,
                   sharing_objects_accounts: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                   timeouts: Optional[pulumi.Input[GetSubaccountTimeoutsArgs]] = None,
                   utilization_enabled: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSubaccountResult]
Copy
func LookupSubaccount(ctx *Context, args *LookupSubaccountArgs, opts ...InvokeOption) (*LookupSubaccountResult, error)
func LookupSubaccountOutput(ctx *Context, args *LookupSubaccountOutputArgs, opts ...InvokeOption) LookupSubaccountResultOutput
Copy

> Note: This function is named LookupSubaccount in the Go SDK.

public static class GetSubaccount 
{
    public static Task<GetSubaccountResult> InvokeAsync(GetSubaccountArgs args, InvokeOptions? opts = null)
    public static Output<GetSubaccountResult> Invoke(GetSubaccountInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSubaccountResult> getSubaccount(GetSubaccountArgs args, InvokeOptions options)
public static Output<GetSubaccountResult> getSubaccount(GetSubaccountArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: logzio:index/getSubaccount:getSubaccount
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

accessible Boolean
accountId Double
ID of the subaccount.
accountName String
accountToken String
docSizeSetting Boolean
email String
flexible Boolean
frequencyMinutes Double
id String
maxDailyGb Double
reservedDailyGb Double
retentionDays Double
searchable Boolean
sharingObjectsAccounts List<Double>
timeouts GetSubaccountTimeouts
utilizationEnabled Boolean
accessible Boolean
accountId Number
ID of the subaccount.
accountName String
accountToken String
docSizeSetting Boolean
email String
flexible Boolean
frequencyMinutes Number
id String
maxDailyGb Number
reservedDailyGb Number
retentionDays Number
searchable Boolean
sharingObjectsAccounts List<Number>
timeouts Property Map
utilizationEnabled Boolean

getSubaccount Result

The following output properties are available:

Supporting Types

GetSubaccountTimeouts

Read string
Read string
read String
read string
read str
read String

Package Details

Repository
logzio logzio/terraform-provider-logzio
License
Notes
This Pulumi package is based on the logzio Terraform Provider.
logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio
logzio/terraform-provider-logzio