Class: Aws::Budgets::Types::Action

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

Overview

A budget action resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_id ⇒ String

A system-generated universally unique identifier (UUID) for the action.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#action_threshold ⇒ Types::ActionThreshold

The trigger threshold of the action.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#action_type ⇒ String

The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#approval_model ⇒ String

This specifies if the action needs manual or automatic approval.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#budget_name ⇒ String

A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::Definition

Where you specify all of the type-specific parameters.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arn ⇒ String

The role passed for action execution and reversion. Roles and actions must be in the same account.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#notification_type ⇒ String

The type of a notification. It must be ACTUAL or FORECASTED.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the action.

Returns:

  • (String) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#subscribers ⇒ Array<Types::Subscriber>

A list of subscribers.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 77

class Action < Struct.new(
  :action_id,
  :budget_name,
  :notification_type,
  :action_type,
  :action_threshold,
  :definition,
  :execution_role_arn,
  :approval_model,
  :status,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end