« blib/lib/Paws/Budgets/ActionThreshold.pm
↑ Summary
blib/lib/Paws/Budgets/BudgetPerformanceHistory.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Budgets::Budget; | ||
| 3 | use Moose; | ||
| 4 | has BudgetLimit => (is => 'ro', isa => 'Paws::Budgets::Spend'); | ||
| 5 | has BudgetName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has BudgetType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has CalculatedSpend => (is => 'ro', isa => 'Paws::Budgets::CalculatedSpend'); | ||
| 8 | has CostFilters => (is => 'ro', isa => 'Paws::Budgets::CostFilters'); | ||
| 9 | has CostTypes => (is => 'ro', isa => 'Paws::Budgets::CostTypes'); | ||
| 10 | has LastUpdatedTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has PlannedBudgetLimits => (is => 'ro', isa => 'Paws::Budgets::PlannedBudgetLimits'); | ||
| 12 | has TimePeriod => (is => 'ro', isa => 'Paws::Budgets::TimePeriod'); | ||
| 13 | has TimeUnit => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Budgets::Budget | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Budgets::Budget object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { BudgetLimit => $value, ..., TimeUnit => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Budgets::Budget object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->BudgetLimit | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Represents the output of the C<CreateBudget> operation. The content | ||
| 46 | consists of the detailed metadata and data file information, and the | ||
| 47 | current status of the C<budget> object. | ||
| 48 | |||
| 49 | This is the ARN pattern for a budget: | ||
| 50 | |||
| 51 | C<arn:aws:budgets::AccountId:budget/budgetName> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 BudgetLimit => L<Paws::Budgets::Spend> | ||
| 57 | |||
| 58 | The total amount of cost, usage, RI utilization, RI coverage, Savings | ||
| 59 | Plans utilization, or Savings Plans coverage that you want to track | ||
| 60 | with your budget. | ||
| 61 | |||
| 62 | C<BudgetLimit> is required for cost or usage budgets, but optional for | ||
| 63 | RI or Savings Plans utilization or coverage budgets. RI and Savings | ||
| 64 | Plans utilization or coverage budgets default to C<100>, which is the | ||
| 65 | only valid value for RI or Savings Plans utilization or coverage | ||
| 66 | budgets. You can't use C<BudgetLimit> with C<PlannedBudgetLimits> for | ||
| 67 | C<CreateBudget> and C<UpdateBudget> actions. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> BudgetName => Str | ||
| 71 | |||
| 72 | The name of a budget. The name must be unique within an account. The | ||
| 73 | C<:> and C<\> characters aren't allowed in C<BudgetName>. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> BudgetType => Str | ||
| 77 | |||
| 78 | Whether this budget tracks costs, usage, RI utilization, RI coverage, | ||
| 79 | Savings Plans utilization, or Savings Plans coverage. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 CalculatedSpend => L<Paws::Budgets::CalculatedSpend> | ||
| 83 | |||
| 84 | The actual and forecasted cost or usage that the budget tracks. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 CostFilters => L<Paws::Budgets::CostFilters> | ||
| 88 | |||
| 89 | The cost filters, such as service or tag, that are applied to a budget. | ||
| 90 | |||
| 91 | AWS Budgets supports the following services as a filter for RI budgets: | ||
| 92 | |||
| 93 | =over | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Amazon Elastic Compute Cloud - Compute | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | Amazon Redshift | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | Amazon Relational Database Service | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Amazon ElastiCache | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Amazon Elasticsearch Service | ||
| 114 | |||
| 115 | =back | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 CostTypes => L<Paws::Budgets::CostTypes> | ||
| 120 | |||
| 121 | The types of costs that are included in this C<COST> budget. | ||
| 122 | |||
| 123 | C<USAGE>, C<RI_UTILIZATION>, C<RI_COVERAGE>, | ||
| 124 | C<SAVINGS_PLANS_UTILIZATION>, and C<SAVINGS_PLANS_COVERAGE> budgets do | ||
| 125 | not have C<CostTypes>. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 LastUpdatedTime => Str | ||
| 129 | |||
| 130 | The last time that you updated this budget. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 PlannedBudgetLimits => L<Paws::Budgets::PlannedBudgetLimits> | ||
| 134 | |||
| 135 | A map containing multiple C<BudgetLimit>, including current or future | ||
| 136 | limits. | ||
| 137 | |||
| 138 | C<PlannedBudgetLimits> is available for cost or usage budget and | ||
| 139 | supports monthly and quarterly C<TimeUnit>. | ||
| 140 | |||
| 141 | For monthly budgets, provide 12 months of C<PlannedBudgetLimits> | ||
| 142 | values. This must start from the current month and include the next 11 | ||
| 143 | months. The C<key> is the start of the month, C<UTC> in epoch seconds. | ||
| 144 | |||
| 145 | For quarterly budgets, provide 4 quarters of C<PlannedBudgetLimits> | ||
| 146 | value entries in standard calendar quarter increments. This must start | ||
| 147 | from the current quarter and include the next 3 quarters. The C<key> is | ||
| 148 | the start of the quarter, C<UTC> in epoch seconds. | ||
| 149 | |||
| 150 | If the planned budget expires before 12 months for monthly or 4 | ||
| 151 | quarters for quarterly, provide the C<PlannedBudgetLimits> values only | ||
| 152 | for the remaining periods. | ||
| 153 | |||
| 154 | If the budget begins at a date in the future, provide | ||
| 155 | C<PlannedBudgetLimits> values from the start date of the budget. | ||
| 156 | |||
| 157 | After all of the C<BudgetLimit> values in C<PlannedBudgetLimits> are | ||
| 158 | used, the budget continues to use the last limit as the C<BudgetLimit>. | ||
| 159 | At that point, the planned budget provides the same experience as a | ||
| 160 | fixed budget. | ||
| 161 | |||
| 162 | C<DescribeBudget> and C<DescribeBudgets> response along with | ||
| 163 | C<PlannedBudgetLimits> will also contain C<BudgetLimit> representing | ||
| 164 | the current month or quarter limit present in C<PlannedBudgetLimits>. | ||
| 165 | This only applies to budgets created with C<PlannedBudgetLimits>. | ||
| 166 | Budgets created without C<PlannedBudgetLimits> will only contain | ||
| 167 | C<BudgetLimit>, and no C<PlannedBudgetLimits>. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 TimePeriod => L<Paws::Budgets::TimePeriod> | ||
| 171 | |||
| 172 | The period of time that is covered by a budget. The period has a start | ||
| 173 | date and an end date. The start date must come before the end date. The | ||
| 174 | end date must come before C<06/15/87 00:00 UTC>. | ||
| 175 | |||
| 176 | If you create your budget and don't specify a start date, AWS defaults | ||
| 177 | to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or | ||
| 178 | ANNUALLY). For example, if you created your budget on January 24, 2018, | ||
| 179 | chose C<DAILY>, and didn't set a start date, AWS set your start date to | ||
| 180 | C<01/24/18 00:00 UTC>. If you chose C<MONTHLY>, AWS set your start date | ||
| 181 | to C<01/01/18 00:00 UTC>. If you didn't specify an end date, AWS set | ||
| 182 | your end date to C<06/15/87 00:00 UTC>. The defaults are the same for | ||
| 183 | the AWS Billing and Cost Management console and the API. | ||
| 184 | |||
| 185 | You can change either date with the C<UpdateBudget> operation. | ||
| 186 | |||
| 187 | After the end date, AWS deletes the budget and all associated | ||
| 188 | notifications and subscribers. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 B<REQUIRED> TimeUnit => Str | ||
| 192 | |||
| 193 | The length of time until a budget resets the actual and forecasted | ||
| 194 | spend. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head1 SEE ALSO | ||
| 199 | |||
| 200 | This class forms part of L<Paws>, describing an object used in L<Paws::Budgets> | ||
| 201 | |||
| 202 | =head1 BUGS and CONTRIBUTIONS | ||
| 203 | |||
| 204 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 205 | |||
| 206 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 207 | |||
| 208 | =cut | ||
| 209 |