Class: Aws::ComputeOptimizerAutomation::Types::CreateAutomationRuleRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

A unique identifier to ensure idempotency of the request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#criteriaTypes::Criteria

A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the automation rule.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the automation rule.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#organization_configurationTypes::OrganizationConfiguration

Configuration for organization-level rules. Required for OrganizationRule type.



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#priorityString

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)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

The types of recommended actions this rule will automate.

Returns:

  • (Array<String>)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#rule_typeString

The type of rule.

Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::Schedule

The schedule for when the rule should run.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the rule

Returns:

  • (String)


440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to associate with the rule.

Returns:



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 440

class CreateAutomationRuleRequest < Struct.new(
  :name,
  :description,
  :rule_type,
  :organization_configuration,
  :priority,
  :recommended_action_types,
  :criteria,
  :schedule,
  :status,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end