PredefinedMetric

java.lang.Object
- java.lang.Enum<PredefinedMetric>
- - software.amazon.awscdk.services.applicationautoscaling.PredefinedMetric

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<PredefinedMetric>

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:01.861Z")
public enum PredefinedMetric
extends java.lang.Enum<PredefinedMetric>

One of the predefined autoscaling metrics.

Example:

 import software.amazon.awscdk.services.lambda.*;
 Code code;
 Function handler = Function.Builder.create(this, "MyFunction")
         .runtime(Runtime.PYTHON_3_7)
         .handler("index.handler")
         .code(code)
         .reservedConcurrentExecutions(2)
         .build();
 Version fnVer = handler.getCurrentVersion();
 ScalableTarget target = ScalableTarget.Builder.create(this, "ScalableTarget")
         .serviceNamespace(ServiceNamespace.LAMBDA)
         .maxCapacity(100)
         .minCapacity(10)
         .resourceId(String.format("function:%s:%s", handler.getFunctionName(), fnVer.getVersion()))
         .scalableDimension("lambda:function:ProvisionedConcurrency")
         .build();
 target.scaleToTrackMetric("PceTracking", BasicTargetTrackingScalingPolicyProps.builder()
         .targetValue(0.9)
         .predefinedMetric(PredefinedMetric.LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION)
         .build());

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALB_REQUEST_COUNT_PER_TARGET` ALB_REQUEST_COUNT_PER_TARGET.
`APPSTREAM_AVERAGE_CAPACITY_UTILIZATION` Average percentage of instances in an AppStream fleet that are being used.
`CASSANDRA_READ_CAPACITY_UTILIZATION` Percentage of provisioned read capacity units utilized by a Keyspaces table.
`CASSANDRA_WRITE_CAPACITY_UTILIZATION` Percentage of provisioned write capacity units utilized by a Keyspaces table.
`COMPREHEND_INFERENCE_UTILIZATION` Percentage of provisioned inference units utilized by a Comprehend endpoint.
`DYANMODB_WRITE_CAPACITY_UTILIZATION` Deprecated. use `PredefinedMetric.DYNAMODB_WRITE_CAPACITY_UTILIZATION`
`DYNAMODB_READ_CAPACITY_UTILIZATION` Percentage of provisioned read capacity units consumed by a DynamoDB table.
`DYNAMODB_WRITE_CAPACITY_UTILIZATION` Percentage of provisioned write capacity units consumed by a DynamoDB table.
`EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION` EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION.
`EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN` EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN.
`EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT` EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT.
`ECS_SERVICE_AVERAGE_CPU_UTILIZATION` ECS_SERVICE_AVERAGE_CPU_UTILIZATION.
`ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION` ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION.
`ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE` ELASTIC_CACHE_REPLICA_ENGINE_CPU_UTILIZATION.
`ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION` ELASTIC_CACHE_PRIMARY_ENGINE_CPU_UTILIZATION.
`ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION` ELASTIC_CACHE_REPLICA_ENGINE_CPU_UTILIZATION.
`KAFKA_BROKER_STORAGE_UTILIZATION` KAFKA_BROKER_STORAGE_UTILIZATION.
`LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION` LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION.
`NEPTURE_READER_AVERAGE_CPU_UTILIZATION` Average CPU Utilization of read replica instances in a Neptune DB cluster.
`RDS_READER_AVERAGE_CPU_UTILIZATION` RDS_READER_AVERAGE_CPU_UTILIZATION.
`RDS_READER_AVERAGE_DATABASE_CONNECTIONS` RDS_READER_AVERAGE_DATABASE_CONNECTIONS.
`SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE` SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PredefinedMetric`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PredefinedMetric[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - APPSTREAM_AVERAGE_CAPACITY_UTILIZATION
```
public static final PredefinedMetric APPSTREAM_AVERAGE_CAPACITY_UTILIZATION
```
    Average percentage of instances in an AppStream fleet that are being used.
  - CASSANDRA_READ_CAPACITY_UTILIZATION
```
public static final PredefinedMetric CASSANDRA_READ_CAPACITY_UTILIZATION
```
    Percentage of provisioned read capacity units utilized by a Keyspaces table.
  - CASSANDRA_WRITE_CAPACITY_UTILIZATION
```
public static final PredefinedMetric CASSANDRA_WRITE_CAPACITY_UTILIZATION
```
    Percentage of provisioned write capacity units utilized by a Keyspaces table.
  - COMPREHEND_INFERENCE_UTILIZATION
```
public static final PredefinedMetric COMPREHEND_INFERENCE_UTILIZATION
```
    Percentage of provisioned inference units utilized by a Comprehend endpoint.
  - NEPTURE_READER_AVERAGE_CPU_UTILIZATION
```
public static final PredefinedMetric NEPTURE_READER_AVERAGE_CPU_UTILIZATION
```
    Average CPU Utilization of read replica instances in a Neptune DB cluster.
  - DYNAMODB_READ_CAPACITY_UTILIZATION
```
public static final PredefinedMetric DYNAMODB_READ_CAPACITY_UTILIZATION
```
    Percentage of provisioned read capacity units consumed by a DynamoDB table.
  - DYNAMODB_WRITE_CAPACITY_UTILIZATION
```
public static final PredefinedMetric DYNAMODB_WRITE_CAPACITY_UTILIZATION
```
    Percentage of provisioned write capacity units consumed by a DynamoDB table.
    Suffix dummy is necessary due to jsii bug (https://github.com/aws/jsii/issues/2782). Duplicate values will be dropped, so this suffix is added as a workaround. The value will be replaced when this enum is used.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - DYANMODB_WRITE_CAPACITY_UTILIZATION
```
@Deprecated
public static final PredefinedMetric DYANMODB_WRITE_CAPACITY_UTILIZATION
```
    Deprecated. use `PredefinedMetric.DYNAMODB_WRITE_CAPACITY_UTILIZATION`
    
    (deprecated) DYANMODB_WRITE_CAPACITY_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ALB_REQUEST_COUNT_PER_TARGET
```
public static final PredefinedMetric ALB_REQUEST_COUNT_PER_TARGET
```
    ALB_REQUEST_COUNT_PER_TARGET.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - RDS_READER_AVERAGE_CPU_UTILIZATION
```
public static final PredefinedMetric RDS_READER_AVERAGE_CPU_UTILIZATION
```
    RDS_READER_AVERAGE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - RDS_READER_AVERAGE_DATABASE_CONNECTIONS
```
public static final PredefinedMetric RDS_READER_AVERAGE_DATABASE_CONNECTIONS
```
    RDS_READER_AVERAGE_DATABASE_CONNECTIONS.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION
```
public static final PredefinedMetric EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION
```
    EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN
```
public static final PredefinedMetric EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN
```
    EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT
```
public static final PredefinedMetric EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT
```
    EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE
```
public static final PredefinedMetric SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE
```
    SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ECS_SERVICE_AVERAGE_CPU_UTILIZATION
```
public static final PredefinedMetric ECS_SERVICE_AVERAGE_CPU_UTILIZATION
```
    ECS_SERVICE_AVERAGE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION
```
public static final PredefinedMetric ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION
```
    ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION
```
public static final PredefinedMetric LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION
```
    LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/lambda/latest/dg/monitoring-metrics.html#monitoring-metrics-concurrency
  - KAFKA_BROKER_STORAGE_UTILIZATION
```
public static final PredefinedMetric KAFKA_BROKER_STORAGE_UTILIZATION
```
    KAFKA_BROKER_STORAGE_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION
```
public static final PredefinedMetric ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION
```
    ELASTIC_CACHE_PRIMARY_ENGINE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION
```
public static final PredefinedMetric ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION
```
    ELASTIC_CACHE_REPLICA_ENGINE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
  - ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE
```
public static final PredefinedMetric ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE
```
    ELASTIC_CACHE_REPLICA_ENGINE_CPU_UTILIZATION.
    
    See Also:
    
    https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PredefinedMetricSpecification.html
- Method Detail
  - values
```
public static PredefinedMetric[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PredefinedMetric c : PredefinedMetric.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PredefinedMetric valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum PredefinedMetric

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

APPSTREAM_AVERAGE_CAPACITY_UTILIZATION

CASSANDRA_READ_CAPACITY_UTILIZATION

CASSANDRA_WRITE_CAPACITY_UTILIZATION

COMPREHEND_INFERENCE_UTILIZATION

NEPTURE_READER_AVERAGE_CPU_UTILIZATION

DYNAMODB_READ_CAPACITY_UTILIZATION

DYNAMODB_WRITE_CAPACITY_UTILIZATION

DYANMODB_WRITE_CAPACITY_UTILIZATION

ALB_REQUEST_COUNT_PER_TARGET

RDS_READER_AVERAGE_CPU_UTILIZATION

RDS_READER_AVERAGE_DATABASE_CONNECTIONS

EC2_SPOT_FLEET_REQUEST_AVERAGE_CPU_UTILIZATION

EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_IN

EC2_SPOT_FLEET_REQUEST_AVERAGE_NETWORK_OUT

SAGEMAKER_VARIANT_INVOCATIONS_PER_INSTANCE

ECS_SERVICE_AVERAGE_CPU_UTILIZATION

ECS_SERVICE_AVERAGE_MEMORY_UTILIZATION

LAMBDA_PROVISIONED_CONCURRENCY_UTILIZATION

KAFKA_BROKER_STORAGE_UTILIZATION

ELASTICACHE_PRIMARY_ENGINE_CPU_UTILIZATION

ELASTICACHE_REPLICA_ENGINE_CPU_UTILIZATION

ELASTICACHE_DATABASE_MEMORY_USAGE_COUNTED_FOR_EVICT_PERCENTAGE

Method Detail

values

valueOf