Hierarchy

  • CloudCostManagementApi

Constructors

Properties

Methods

createCostAWSCURConfig createCostAzureUCConfigs createCostGCPUsageCostConfig createCustomAllocationRule createTagPipelinesRuleset deleteBudget deleteCostAWSCURConfig deleteCostAzureUCConfig deleteCostGCPUsageCostConfig deleteCostTagDescriptionByKey deleteCustomAllocationRule deleteCustomCostsFile deleteTagPipelinesRuleset generateCostTagDescriptionByKey getBudget getCommitmentsCommitmentList getCommitmentsCoverageScalar getCommitmentsCoverageTimeseries getCommitmentsOnDemandHotspotsScalar getCommitmentsSavingsScalar getCommitmentsSavingsTimeseries getCommitmentsUtilizationScalar getCommitmentsUtilizationTimeseries getCostAWSCURConfig getCostAnomaly getCostAzureUCConfig getCostGCPUsageCostConfig getCostTagDescriptionByKey getCostTagKey getCostTagMetadataCurrency getCustomAllocationRule getCustomCostsFile getTagPipelinesRuleset listBudgets listCostAWSCURConfigs listCostAnomalies listCostAzureUCConfigs listCostGCPUsageCostConfigs listCostOCIConfigs listCostTagDescriptions listCostTagKeySources listCostTagKeys listCostTagMetadata listCostTagMetadataMetrics listCostTagMetadataMonths listCostTagMetadataOrchestrators listCostTags listCustomAllocationRules listCustomAllocationRulesStatus listCustomCostsFiles listTagPipelinesRulesets listTagPipelinesRulesetsStatus reorderCustomAllocationRules reorderTagPipelinesRulesets searchCostRecommendations updateCostAWSCURConfig updateCostAzureUCConfigs updateCostGCPUsageCostConfig updateCustomAllocationRule updateTagPipelinesRuleset uploadCustomCostsFile upsertBudget upsertCostTagDescriptionByKey validateBudget validateCsvBudget validateQuery

Constructors

Properties

configuration: Configuration
requestFactory: CloudCostManagementApiRequestFactory
responseProcessor: CloudCostManagementApiResponseProcessor

Methods

  • Create a new custom allocation rule with the specified filters and allocation strategy.

    Strategy Methods:

    • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.
    • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.
    • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).

    Filter Conditions:

    • Use value for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like"
    • Use values for multi-value conditions: "in", "not in"
    • Cannot use both value and values simultaneously.

    Supported operators: is, is not, contains, in, not in, =, !=, like, not like

    Parameters

    Returns Promise<ArbitraryRuleResponse>

  • Update an existing custom allocation rule with new filters and allocation strategy.

    Strategy Methods:

    • PROPORTIONAL/EVEN: Allocates costs proportionally/evenly based on existing costs. Requires: granularity, allocated_by_tag_keys. Optional: based_on_costs, allocated_by_filters, evaluate_grouped_by_tag_keys, evaluate_grouped_by_filters.
    • PROPORTIONAL_TIMESERIES/EVEN_TIMESERIES: Allocates based on timeseries data. Requires: granularity, based_on_timeseries. Optional: evaluate_grouped_by_tag_keys.
    • PERCENT: Allocates fixed percentages to specific tags. Requires: allocated_by (array of percentage allocations).
    • USAGE_METRIC: Allocates based on usage metrics (implementation varies).

    Filter Conditions:

    • Use value for single-value conditions: "is", "is not", "contains", "=", "!=", "like", "not like"
    • Use values for multi-value conditions: "in", "not in"
    • Cannot use both value and values simultaneously.

    Supported operators: is, is not, contains, in, not in, =, !=, like, not like

    Parameters

    Returns Promise<ArbitraryRuleResponse>

Generated using TypeDoc