1. Packages
  2. Google Cloud Native
  3. API Docs
  4. billingbudgets
  5. billingbudgets/v1beta1
  6. getBudget

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.30.0 published on Friday, Apr 14, 2023 by Pulumi

google-native.billingbudgets/v1beta1.getBudget

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.30.0 published on Friday, Apr 14, 2023 by Pulumi

    Returns a budget. WARNING: There are some fields exposed on the Google Cloud Console that aren’t available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

    Using getBudget

    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 getBudget(args: GetBudgetArgs, opts?: InvokeOptions): Promise<GetBudgetResult>
    function getBudgetOutput(args: GetBudgetOutputArgs, opts?: InvokeOptions): Output<GetBudgetResult>
    def get_budget(billing_account_id: Optional[str] = None,
                   budget_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetBudgetResult
    def get_budget_output(billing_account_id: Optional[pulumi.Input[str]] = None,
                   budget_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetBudgetResult]
    func LookupBudget(ctx *Context, args *LookupBudgetArgs, opts ...InvokeOption) (*LookupBudgetResult, error)
    func LookupBudgetOutput(ctx *Context, args *LookupBudgetOutputArgs, opts ...InvokeOption) LookupBudgetResultOutput

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

    public static class GetBudget 
    {
        public static Task<GetBudgetResult> InvokeAsync(GetBudgetArgs args, InvokeOptions? opts = null)
        public static Output<GetBudgetResult> Invoke(GetBudgetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBudgetResult> getBudget(GetBudgetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:billingbudgets/v1beta1:getBudget
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getBudget Result

    The following output properties are available:

    AllUpdatesRule Pulumi.GoogleNative.Billingbudgets.V1Beta1.Outputs.GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    Amount Pulumi.GoogleNative.Billingbudgets.V1Beta1.Outputs.GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    Budgeted amount.

    BudgetFilter Pulumi.GoogleNative.Billingbudgets.V1Beta1.Outputs.GoogleCloudBillingBudgetsV1beta1FilterResponse

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    DisplayName string

    User data for display name in UI. Validation: <= 60 chars.

    Etag string

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    Name string

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    ThresholdRules List<Pulumi.GoogleNative.Billingbudgets.V1Beta1.Outputs.GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse>

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    AllUpdatesRule GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    Amount GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    Budgeted amount.

    BudgetFilter GoogleCloudBillingBudgetsV1beta1FilterResponse

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    DisplayName string

    User data for display name in UI. Validation: <= 60 chars.

    Etag string

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    Name string

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    ThresholdRules []GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    allUpdatesRule GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    amount GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    Budgeted amount.

    budgetFilter GoogleCloudBillingBudgetsV1beta1FilterResponse

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    displayName String

    User data for display name in UI. Validation: <= 60 chars.

    etag String

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    name String

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    thresholdRules List<GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse>

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    allUpdatesRule GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    amount GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    Budgeted amount.

    budgetFilter GoogleCloudBillingBudgetsV1beta1FilterResponse

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    displayName string

    User data for display name in UI. Validation: <= 60 chars.

    etag string

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    name string

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    thresholdRules GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse[]

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    all_updates_rule GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    amount GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    Budgeted amount.

    budget_filter GoogleCloudBillingBudgetsV1beta1FilterResponse

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    display_name str

    User data for display name in UI. Validation: <= 60 chars.

    etag str

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    name str

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    threshold_rules Sequence[GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse]

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    allUpdatesRule Property Map

    Optional. Rules to apply to notifications sent based on budget spend and thresholds.

    amount Property Map

    Budgeted amount.

    budgetFilter Property Map

    Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters.

    displayName String

    User data for display name in UI. Validation: <= 60 chars.

    etag String

    Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag will cause an update to overwrite other changes.

    name String

    Resource name of the budget. The resource name implies the scope of a budget. Values are of the form billingAccounts/{billingAccountId}/budgets/{budgetId}.

    thresholdRules List<Property Map>

    Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for pubsubTopic notifications. Required if using email notifications.

    Supporting Types

    GoogleCloudBillingBudgetsV1beta1AllUpdatesRuleResponse

    DisableDefaultIamRecipients bool

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    MonitoringNotificationChannels List<string>

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    PubsubTopic string

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    SchemaVersion string

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    DisableDefaultIamRecipients bool

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    MonitoringNotificationChannels []string

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    PubsubTopic string

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    SchemaVersion string

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    disableDefaultIamRecipients Boolean

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    monitoringNotificationChannels List<String>

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    pubsubTopic String

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    schemaVersion String

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    disableDefaultIamRecipients boolean

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    monitoringNotificationChannels string[]

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    pubsubTopic string

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    schemaVersion string

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    disable_default_iam_recipients bool

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    monitoring_notification_channels Sequence[str]

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    pubsub_topic str

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    schema_version str

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    disableDefaultIamRecipients Boolean

    Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.

    monitoringNotificationChannels List<String>

    Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/{project_id}/notificationChannels/{channel_id}. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients for more details.

    pubsubTopic String

    Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications for more details. Caller is expected to have pubsub.topics.setIamPolicy permission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task for more details on Pub/Sub roles and permissions.

    schemaVersion String

    Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.

    GoogleCloudBillingBudgetsV1beta1BudgetAmountResponse

    LastPeriodAmount Pulumi.GoogleNative.Billingbudgets.V1Beta1.Inputs.GoogleCloudBillingBudgetsV1beta1LastPeriodAmountResponse

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    SpecifiedAmount Pulumi.GoogleNative.Billingbudgets.V1Beta1.Inputs.GoogleTypeMoneyResponse

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    LastPeriodAmount GoogleCloudBillingBudgetsV1beta1LastPeriodAmountResponse

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    SpecifiedAmount GoogleTypeMoneyResponse

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    lastPeriodAmount GoogleCloudBillingBudgetsV1beta1LastPeriodAmountResponse

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    specifiedAmount GoogleTypeMoneyResponse

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    lastPeriodAmount GoogleCloudBillingBudgetsV1beta1LastPeriodAmountResponse

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    specifiedAmount GoogleTypeMoneyResponse

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    last_period_amount GoogleCloudBillingBudgetsV1beta1LastPeriodAmountResponse

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    specified_amount GoogleTypeMoneyResponse

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    lastPeriodAmount Property Map

    Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period.

    specifiedAmount Property Map

    A specified amount to use as the budget. currency_code is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The currency_code is provided on output.

    GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    EndDate Pulumi.GoogleNative.Billingbudgets.V1Beta1.Inputs.GoogleTypeDateResponse

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    StartDate Pulumi.GoogleNative.Billingbudgets.V1Beta1.Inputs.GoogleTypeDateResponse

    The start date must be after January 1, 2017.

    EndDate GoogleTypeDateResponse

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    StartDate GoogleTypeDateResponse

    The start date must be after January 1, 2017.

    endDate GoogleTypeDateResponse

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    startDate GoogleTypeDateResponse

    The start date must be after January 1, 2017.

    endDate GoogleTypeDateResponse

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    startDate GoogleTypeDateResponse

    The start date must be after January 1, 2017.

    end_date GoogleTypeDateResponse

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    start_date GoogleTypeDateResponse

    The start date must be after January 1, 2017.

    endDate Property Map

    Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date.

    startDate Property Map

    The start date must be after January 1, 2017.

    GoogleCloudBillingBudgetsV1beta1FilterResponse

    CalendarPeriod string

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    CreditTypes List<string>

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    CreditTypesTreatment string

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    CustomPeriod Pulumi.GoogleNative.Billingbudgets.V1Beta1.Inputs.GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    Labels Dictionary<string, string>

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    Projects List<string>

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    Services List<string>

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    Subaccounts List<string>

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    CalendarPeriod string

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    CreditTypes []string

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    CreditTypesTreatment string

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    CustomPeriod GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    Labels map[string]string

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    Projects []string

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    Services []string

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    Subaccounts []string

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    calendarPeriod String

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    creditTypes List<String>

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    creditTypesTreatment String

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    customPeriod GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    labels Map<String,String>

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    projects List<String>

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    services List<String>

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    subaccounts List<String>

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    calendarPeriod string

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    creditTypes string[]

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    creditTypesTreatment string

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    customPeriod GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    labels {[key: string]: string}

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    projects string[]

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    services string[]

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    subaccounts string[]

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    calendar_period str

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    credit_types Sequence[str]

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    credit_types_treatment str

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    custom_period GoogleCloudBillingBudgetsV1beta1CustomPeriodResponse

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    labels Mapping[str, str]

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    projects Sequence[str]

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    services Sequence[str]

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    subaccounts Sequence[str]

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    calendarPeriod String

    Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget will track usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it will track usage from July 1 to September 30 when the current calendar month is July, August, September, so on.

    creditTypes List<String>

    Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See a list of acceptable credit type values. If Filter.credit_types_treatment is not INCLUDE_SPECIFIED_CREDITS, this field must be empty.

    creditTypesTreatment String

    Optional. If not set, default behavior is INCLUDE_ALL_CREDITS.

    customPeriod Property Map

    Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur.

    labels Map<String>

    Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report will include all labeled and unlabeled usage. An object containing a single "key": value pair. Example: { "name": "wrench" }. Currently, multiple entries or multiple values per entry are not allowed.

    projects List<String>

    Optional. A set of projects of the form projects/{project}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on.

    services List<String>

    Optional. A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

    subaccounts List<String>

    Optional. A set of subaccounts of the form billingAccounts/{account_id}, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account will be included. If omitted, the report will include usage from the parent account and all subaccounts, if they exist.

    GoogleCloudBillingBudgetsV1beta1ThresholdRuleResponse

    SpendBasis string

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    ThresholdPercent double

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    SpendBasis string

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    ThresholdPercent float64

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    spendBasis String

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    thresholdPercent Double

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    spendBasis string

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    thresholdPercent number

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    spend_basis str

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    threshold_percent float

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    spendBasis String

    Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

    thresholdPercent Number

    Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

    GoogleTypeDateResponse

    Day int

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    Month int

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    Year int

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    Day int

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    Month int

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    Year int

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    day Integer

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    month Integer

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    year Integer

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    day number

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    month number

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    year number

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    day int

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    month int

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    year int

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    day Number

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

    month Number

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

    year Number

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

    GoogleTypeMoneyResponse

    CurrencyCode string

    The three-letter currency code defined in ISO 4217.

    Nanos int

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    Units string

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    CurrencyCode string

    The three-letter currency code defined in ISO 4217.

    Nanos int

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    Units string

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    currencyCode String

    The three-letter currency code defined in ISO 4217.

    nanos Integer

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    units String

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    currencyCode string

    The three-letter currency code defined in ISO 4217.

    nanos number

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    units string

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    currency_code str

    The three-letter currency code defined in ISO 4217.

    nanos int

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    units str

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    currencyCode String

    The three-letter currency code defined in ISO 4217.

    nanos Number

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    units String

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.30.0 published on Friday, Apr 14, 2023 by Pulumi