Class: Aws::ComputeOptimizerAutomation::Types::AutomationRule

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

Overview

Represents a complete automation rule configuration including criteria, schedule, and execution settings.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The 12-digit Amazon Web Services account ID that owns this automation rule.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#created_timestamp ⇒ Time

The timestamp when the automation rule was created.

Returns:

  • (Time) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the automation rule.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timestamp ⇒ Time

The timestamp when the automation rule was last updated.

Returns:

  • (Time) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the automation rule.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#organization_configuration ⇒ Types::OrganizationConfiguration

Configuration settings for organization-wide rules.

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ String

A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#recommended_action_types ⇒ Array<String>

List of recommended action types that this rule can execute.

Returns:

  • (Array<String>) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arn ⇒ String

The Amazon Resource Name (ARN) of the automation rule.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#rule_id ⇒ String

The unique identifier of the automation rule.

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#rule_revision ⇒ Integer

The revision number of the automation rule.

Returns:

  • (Integer) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#rule_type ⇒ String

The type of automation rule (OrganizationRule or AccountRule).

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

The schedule configuration for when the automation rule should execute.

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the automation rule (Active or Inactive).

Returns:

  • (String) 


358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 358

class AutomationRule < Struct.new(
  :rule_arn,
  :rule_id,
  :name,
  :description,
  :rule_type,
  :rule_revision,
  :account_id,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :schedule,
  :status,
  :created_timestamp,
  :last_updated_timestamp)
  SENSITIVE = []
  include Aws::Structure
end