Class: AWSCDK::ApplicationAutoScaling::CfnScalableTarget::SuspendedStateProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
application_auto_scaling/cfn_scalable_target.rb

Overview

SuspendedState is a property of the AWS::ApplicationAutoScaling::ScalableTarget resource that specifies whether the scaling activities for a scalable target are in a suspended state.

For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide .

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dynamic_scaling_in_suspended: nil, dynamic_scaling_out_suspended: nil, scheduled_scaling_suspended: nil) ⇒ SuspendedStateProperty

Returns a new instance of SuspendedStateProperty.

Parameters:

  • dynamic_scaling_in_suspended (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)

    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended.

  • dynamic_scaling_out_suspended (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)

    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended.

  • scheduled_scaling_suspended (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil)

    Whether scheduled scaling is suspended.



749
750
751
752
753
754
755
756
# File 'application_auto_scaling/cfn_scalable_target.rb', line 749

def initialize(dynamic_scaling_in_suspended: nil, dynamic_scaling_out_suspended: nil, scheduled_scaling_suspended: nil)
  @dynamic_scaling_in_suspended = dynamic_scaling_in_suspended
  Jsii::Type.check_type(@dynamic_scaling_in_suspended, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dynamicScalingInSuspended") unless @dynamic_scaling_in_suspended.nil?
  @dynamic_scaling_out_suspended = dynamic_scaling_out_suspended
  Jsii::Type.check_type(@dynamic_scaling_out_suspended, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dynamicScalingOutSuspended") unless @dynamic_scaling_out_suspended.nil?
  @scheduled_scaling_suspended = scheduled_scaling_suspended
  Jsii::Type.check_type(@scheduled_scaling_suspended, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "scheduledScalingSuspended") unless @scheduled_scaling_suspended.nil?
end

Instance Attribute Details

#dynamic_scaling_in_suspendedBoolean, ... (readonly)

Whether scale in by a target tracking scaling policy or a step scaling policy is suspended.

Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false .



764
765
766
# File 'application_auto_scaling/cfn_scalable_target.rb', line 764

def dynamic_scaling_in_suspended
  @dynamic_scaling_in_suspended
end

#dynamic_scaling_out_suspendedBoolean, ... (readonly)

Whether scale out by a target tracking scaling policy or a step scaling policy is suspended.

Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false .



771
772
773
# File 'application_auto_scaling/cfn_scalable_target.rb', line 771

def dynamic_scaling_out_suspended
  @dynamic_scaling_out_suspended
end

#scheduled_scaling_suspendedBoolean, ... (readonly)

Whether scheduled scaling is suspended.

Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false .



778
779
780
# File 'application_auto_scaling/cfn_scalable_target.rb', line 778

def scheduled_scaling_suspended
  @scheduled_scaling_suspended
end

Class Method Details

.jsii_propertiesObject



780
781
782
783
784
785
786
# File 'application_auto_scaling/cfn_scalable_target.rb', line 780

def self.jsii_properties
  {
    :dynamic_scaling_in_suspended => "dynamicScalingInSuspended",
    :dynamic_scaling_out_suspended => "dynamicScalingOutSuspended",
    :scheduled_scaling_suspended => "scheduledScalingSuspended",
  }
end

Instance Method Details

#to_jsiiObject



788
789
790
791
792
793
794
795
796
# File 'application_auto_scaling/cfn_scalable_target.rb', line 788

def to_jsii
  result = {}
  result.merge!({
    "dynamicScalingInSuspended" => @dynamic_scaling_in_suspended,
    "dynamicScalingOutSuspended" => @dynamic_scaling_out_suspended,
    "scheduledScalingSuspended" => @scheduled_scaling_suspended,
  })
  result.compact
end