Interface CfnScalingPolicy.PredefinedMetricSpecificationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnScalingPolicy.PredefinedMetricSpecificationProperty.Jsii$Proxy
Enclosing class:
CfnScalingPolicy

@Stability(Stable) public static interface CfnScalingPolicy.PredefinedMetricSpecificationProperty extends software.amazon.jsii.JsiiSerializable
Contains predefined metric specification information for a target tracking scaling policy for Application Auto Scaling.

PredefinedMetricSpecification is a property of the AWS::ApplicationAutoScaling::ScalingPolicy TargetTrackingScalingPolicyConfiguration property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationautoscaling.*;
 PredefinedMetricSpecificationProperty predefinedMetricSpecificationProperty = PredefinedMetricSpecificationProperty.builder()
         .predefinedMetricType("predefinedMetricType")
         // the properties below are optional
         .resourceLabel("resourceLabel")
         .build();
 
  • Method Details

    • getPredefinedMetricType

      @Stability(Stable) @NotNull String getPredefinedMetricType()
      The metric type.

      The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.

    • getResourceLabel

      @Stability(Stable) @Nullable default String getResourceLabel()
      Identifies the resource associated with the metric type.

      You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

      You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

      app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff .

      Where:

      • app/invalid input: '<'load-balancer-name>/invalid input: '<'load-balancer-id> is the final portion of the load balancer ARN
      • targetgroup/invalid input: '<'target-group-name>/invalid input: '<'target-group-id> is the final portion of the target group ARN.

      To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    • builder

      Returns:
      a CfnScalingPolicy.PredefinedMetricSpecificationProperty.Builder of CfnScalingPolicy.PredefinedMetricSpecificationProperty