Package software.amazon.awscdk.services.autoscalingplans

Class CfnScalingPlan.ScalingInstructionProperty.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.autoscalingplans.CfnScalingPlan.ScalingInstructionProperty.Jsii$Proxy
All Implemented Interfaces:
CfnScalingPlan.ScalingInstructionProperty, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnScalingPlan.ScalingInstructionProperty
@Stability(Stable) @Internal public static final class CfnScalingPlan.ScalingInstructionProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnScalingPlan.ScalingInstructionProperty
An implementation for CfnScalingPlan.ScalingInstructionProperty

  • Constructor Details

  • Method Details

    • getMaxCapacity

      public final Number getMaxCapacity()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The maximum capacity of the resource.

      The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior .

      Specified by:
      getMaxCapacity in interface CfnScalingPlan.ScalingInstructionProperty

    • getMinCapacity

      public final Number getMinCapacity()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The minimum capacity of the resource.
      Specified by:
      getMinCapacity in interface CfnScalingPlan.ScalingInstructionProperty

    • getResourceId

      public final String getResourceId()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The ID of the resource. This string consists of the resource type and unique identifier.

      • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg .
      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp .
      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE .
      • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table .
      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index .
      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster .
      Specified by:
      getResourceId in interface CfnScalingPlan.ScalingInstructionProperty

    • getScalableDimension

      public final String getScalableDimension()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The scalable dimension associated with the resource.

      • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
      • ecs:service:DesiredCount - The desired task count of an ECS service.
      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      Specified by:
      getScalableDimension in interface CfnScalingPlan.ScalingInstructionProperty

    • getServiceNamespace

      public final String getServiceNamespace()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The namespace of the AWS service.
      Specified by:
      getServiceNamespace in interface CfnScalingPlan.ScalingInstructionProperty

    • getTargetTrackingConfigurations

      public final Object getTargetTrackingConfigurations()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The target tracking configurations (up to 10).

      Each of these structures must specify a unique scaling metric and a target value for the metric.

      Specified by:
      getTargetTrackingConfigurations in interface CfnScalingPlan.ScalingInstructionProperty

    • getCustomizedLoadMetricSpecification

      public final Object getCustomizedLoadMetricSpecification()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The customized load metric to use for predictive scaling.

      This property or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

      Specified by:
      getCustomizedLoadMetricSpecification in interface CfnScalingPlan.ScalingInstructionProperty

    • getDisableDynamicScaling

      public final Object getDisableDynamicScaling()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      Controls whether dynamic scaling by AWS Auto Scaling is disabled.

      When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

      The default is enabled ( false ).

      Specified by:
      getDisableDynamicScaling in interface CfnScalingPlan.ScalingInstructionProperty

    • getPredefinedLoadMetricSpecification

      public final Object getPredefinedLoadMetricSpecification()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The predefined load metric to use for predictive scaling.

      This property or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

      Specified by:
      getPredefinedLoadMetricSpecification in interface CfnScalingPlan.ScalingInstructionProperty

    • getPredictiveScalingMaxCapacityBehavior

      public final String getPredictiveScalingMaxCapacityBehavior()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource.

      The default value is SetForecastCapacityToMaxCapacity .

      The following are possible values:

      • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
      • SetMaxCapacityToForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.
      • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling can scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

      Valid only when configuring predictive scaling.

      Specified by:
      getPredictiveScalingMaxCapacityBehavior in interface CfnScalingPlan.ScalingInstructionProperty

    • getPredictiveScalingMaxCapacityBuffer

      public final Number getPredictiveScalingMaxCapacityBuffer()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity.

      The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer. With a 10 percent buffer, if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

      Valid only when configuring predictive scaling. Required if PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity , and cannot be used otherwise.

      The range is 1-100.

      Specified by:
      getPredictiveScalingMaxCapacityBuffer in interface CfnScalingPlan.ScalingInstructionProperty

    • getPredictiveScalingMode

      public final String getPredictiveScalingMode()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The predictive scaling mode.

      The default value is ForecastAndScale . Otherwise, AWS Auto Scaling forecasts capacity but does not apply any scheduled scaling actions based on the capacity forecast.

      Specified by:
      getPredictiveScalingMode in interface CfnScalingPlan.ScalingInstructionProperty

    • getScalingPolicyUpdateBehavior

      public final String getScalingPolicyUpdateBehavior()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      Controls whether your scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

      The default value is KeepExternalPolicies .

      Valid only when configuring dynamic scaling.

      Specified by:
      getScalingPolicyUpdateBehavior in interface CfnScalingPlan.ScalingInstructionProperty

    • getScheduledActionBufferTime

      public final Number getScheduledActionBufferTime()
      Description copied from interface: CfnScalingPlan.ScalingInstructionProperty
      The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out.

      For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

      Valid only when configuring predictive scaling.

      Specified by:
      getScheduledActionBufferTime in interface CfnScalingPlan.ScalingInstructionProperty

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object