Class: Aws::ComputeOptimizerAutomation::Types::UpdateAutomationRuleRequest

Inherits:

Struct

• Object
• Struct
• Aws::ComputeOptimizerAutomation::Types::UpdateAutomationRuleRequest

Defined in:

gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #criteria ⇒ Types::Criteria

  A set of conditions that specify which recommended action qualify for implementation.

• #description ⇒ String

  The updated description of the automation rule.

• #name ⇒ String

  The updated name of the automation rule.

• #organization_configuration ⇒ Types::OrganizationConfiguration

  Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

• #priority ⇒ String

  The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

• #recommended_action_types ⇒ Array<String>

  Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

• #rule_arn ⇒ String

  The ARN of the rule to update.

• #rule_revision ⇒ Integer

  The revision number of the rule to update.

• #rule_type ⇒ String

  The updated type of automation rule.

• #schedule ⇒ Types::Schedule

  The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

• #status ⇒ String

  The updated status of the automation rule.

Instance Attribute Details

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

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

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#criteria ⇒ Types::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. You can specify up to 20 conditions per filter criteria and 20 values per condition.

Returns:

• (Types::Criteria)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#description ⇒ String

The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#name ⇒ String

The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#organization_configuration ⇒ Types::OrganizationConfiguration

Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

Returns:

• (Types::OrganizationConfiguration)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#priority ⇒ String

The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#recommended_action_types ⇒ Array<String>

Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#rule_arn ⇒ String

The ARN of the rule to update.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#rule_revision ⇒ Integer

The revision number of the rule to update.

Returns:

• (Integer)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#rule_type ⇒ String

The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#schedule ⇒ Types::Schedule

The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

Returns:

• (Types::Schedule)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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

#status ⇒ String

The updated status of the automation rule. Can be Active or Inactive.

Returns:

• (String)

# File 'gems/aws-sdk-computeoptimizerautomation/lib/aws-sdk-computeoptimizerautomation/types.rb', line 2397

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