Class: Ansible::Ruby::Modules::Aws_application_scaling_policy

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Aws_application_scaling_policy

Defined in:

lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb

Overview

Creates, updates or removes a Scaling Policy

Instance Method Summary

• #maximum_tasks ⇒ Integer^?

  The maximum value to scale to in response to a scale out event.

• #minimum_tasks ⇒ Integer^?

  The minimum value to scale to in response to a scale in event.

• #override_task_capacity ⇒ Symbol^?

  Whether or not to override values of minimum and/or maximum tasks if it’s already set.

• #policy_name ⇒ String

  The name of the scaling policy.

• #policy_type ⇒ :StepScaling, :TargetTrackingScaling

  The policy type.

• #resource_id ⇒ String

  The identifier of the resource associated with the scalable target.

• #scalable_dimension ⇒ :"ecs:service:DesiredCount", ...

  The scalable dimension associated with the scalable target.

• #service_namespace ⇒ :ecs, ...

  The namespace of the AWS service.

• #step_scaling_policy_configuration ⇒ Hash^?

  A step scaling policy.

• #target_tracking_scaling_policy_configuration ⇒ Hash^?

  A target tracking policy.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#maximum_tasks ⇒ Integer^?

Returns The maximum value to scale to in response to a scale out event. This parameter is required if you are creating a first new policy for the specified service.

Returns:

• (Integer, nil) —

  The maximum value to scale to in response to a scale out event. This parameter is required if you are creating a first new policy for the specified service.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 44

attribute :maximum_tasks

#minimum_tasks ⇒ Integer^?

Returns The minimum value to scale to in response to a scale in event. This parameter is required if you are creating a first new policy for the specified service.

Returns:

• (Integer, nil) —

  The minimum value to scale to in response to a scale in event. This parameter is required if you are creating a first new policy for the specified service.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 40

attribute :minimum_tasks

#override_task_capacity ⇒ Symbol^?

Returns Whether or not to override values of minimum and/or maximum tasks if it’s already set.

Returns:

• (Symbol, nil) —

  Whether or not to override values of minimum and/or maximum tasks if it’s already set.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 48

attribute :override_task_capacity

#policy_name ⇒ String

Returns The name of the scaling policy.

Returns:

• (String) —

  The name of the scaling policy.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 12

attribute :policy_name

#policy_type ⇒ :StepScaling, :TargetTrackingScaling

Returns The policy type.

Returns:

• (:StepScaling, :TargetTrackingScaling) —

  The policy type.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 28

attribute :policy_type

#resource_id ⇒ String

Returns The identifier of the resource associated with the scalable target.

Returns:

• (String) —

  The identifier of the resource associated with the scalable target.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 20

attribute :resource_id

#scalable_dimension ⇒ :"ecs:service:DesiredCount", ...

Returns The scalable dimension associated with the scalable target.

Returns:

• (:"ecs:service:DesiredCount", :"ec2:spot-fleet-request:TargetCapacity", :"elasticmapreduce:instancegroup:InstanceCount", :"appstream:fleet:DesiredCapacity", :"dynamodb:table:ReadCapacityUnits", :"dynamodb:table:WriteCapacityUnits", :"dynamodb:index:ReadCapacityUnits", :"dynamodb:index:WriteCapacityUnits") —

  The scalable dimension associated with the scalable target.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 24

attribute :scalable_dimension

#service_namespace ⇒ :ecs, ...

Returns The namespace of the AWS service.

Returns:

• (:ecs, :elasticmapreduce, :ec2, :appstream, :dynamodb) —

  The namespace of the AWS service.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 16

attribute :service_namespace

#step_scaling_policy_configuration ⇒ Hash^?

Returns A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.

Returns:

• (Hash, nil) —

  A step scaling policy. This parameter is required if you are creating a policy and the policy type is StepScaling.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 32

attribute :step_scaling_policy_configuration

#target_tracking_scaling_policy_configuration ⇒ Hash^?

Returns A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

Returns:

• (Hash, nil) —

  A target tracking policy. This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

# File 'lib/ansible/ruby/modules/generated/cloud/amazon/aws_application_scaling_policy.rb', line 36

attribute :target_tracking_scaling_policy_configuration