Class: Aws::CleanRooms::Types::AccessBudgetDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb

Overview

Detailed information about an access budget including time bounds, budget allocation, and configuration settings.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_refresh ⇒ String

Indicates whether the budget automatically refreshes for each time period specified in budgetType. Valid values are:

ENABLED - The budget refreshes automatically at the start of each period.

DISABLED - The budget must be refreshed manually.

NULL - The value is null when budgetType is set to LIFETIME.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end

#budget ⇒ Integer

The total budget allocation amount for this access budget.

Returns:

  • (Integer) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end

#budget_type ⇒ String

Specifies the time period for limiting table usage in queries and jobs. For calendar-based periods, the budget can renew if auto refresh is enabled. For lifetime budgets, the limit applies to the total usage throughout the collaboration. Valid values are:

CALENDAR_DAY - Limit table usage per day.

CALENDAR_WEEK - Limit table usage per week.

CALENDAR_MONTH - Limit table usage per month.

LIFETIME - Limit total table usage for the collaboration duration.

Returns:

  • (String) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time for the access budget period.

Returns:

  • (Time) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end

#remaining_budget ⇒ Integer

The remaining budget amount available for use within this access budget.

Returns:

  • (Integer) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time for the access budget period.

Returns:

  • (Time) 


96
97
98
99
100
101
102
103
104
105
 
# File 'gems/aws-sdk-cleanrooms/lib/aws-sdk-cleanrooms/types.rb', line 96

class AccessBudgetDetails < Struct.new(
  :start_time,
  :end_time,
  :remaining_budget,
  :budget,
  :budget_type,
  :auto_refresh)
  SENSITIVE = []
  include Aws::Structure
end