AutoScalingPolicy¶
- class oci.autoscaling.models.AutoScalingPolicy(**kwargs)¶
Bases:
objectAutoscaling policies define the criteria that trigger autoscaling actions and the actions to take.
An autoscaling policy is part of an autoscaling configuration. For more information, see Autoscaling.
You can create the following types of autoscaling policies:
Schedule-based: Autoscaling events take place at the specific times that you schedule.
Threshold-based: An autoscaling action is triggered when a performance metric meets or exceeds a threshold.
Methods:
__init__(**kwargs)Initializes a new AutoScalingPolicy object with values from keyword arguments.
get_subtype(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
Attributes:
Gets the capacity of this AutoScalingPolicy.
Gets the display_name of this AutoScalingPolicy.
Gets the id of this AutoScalingPolicy.
Gets the is_enabled of this AutoScalingPolicy.
[Required] Gets the policy_type of this AutoScalingPolicy.
[Required] Gets the time_created of this AutoScalingPolicy.
- __init__(**kwargs)¶
Initializes a new AutoScalingPolicy object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
capacity (oci.autoscaling.models.Capacity) – The value to assign to the capacity property of this AutoScalingPolicy.
id (str) – The value to assign to the id property of this AutoScalingPolicy.
display_name (str) – The value to assign to the display_name property of this AutoScalingPolicy.
policy_type (str) – The value to assign to the policy_type property of this AutoScalingPolicy.
time_created (datetime) – The value to assign to the time_created property of this AutoScalingPolicy.
is_enabled (bool) – The value to assign to the is_enabled property of this AutoScalingPolicy.
- property capacity¶
Gets the capacity of this AutoScalingPolicy. The capacity requirements of the autoscaling policy.
- Returns
The capacity of this AutoScalingPolicy.
- Return type
- property display_name¶
Gets the display_name of this AutoScalingPolicy. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this AutoScalingPolicy.
- Return type
str
- static get_subtype(object_dictionary)¶
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
- property id¶
Gets the id of this AutoScalingPolicy. The ID of the autoscaling policy that is assigned after creation.
- Returns
The id of this AutoScalingPolicy.
- Return type
str
- property is_enabled¶
Gets the is_enabled of this AutoScalingPolicy. Whether the autoscaling policy is enabled.
- Returns
The is_enabled of this AutoScalingPolicy.
- Return type
bool
- property policy_type¶
[Required] Gets the policy_type of this AutoScalingPolicy. The type of autoscaling policy.
- Returns
The policy_type of this AutoScalingPolicy.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this AutoScalingPolicy. The date and time the autoscaling configuration was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this AutoScalingPolicy.
- Return type
datetime