@Generated(value="software.amazon.awssdk:codegen") public final class ScalingPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
Represents a scaling policy to use with Application Auto Scaling.
For more information about configuring scaling policies for a specific service, see Amazon Web Services services that you can use with Application Auto Scaling in the Application Auto Scaling User Guide.
| Modifier and Type | Class and Description |
|---|---|
static interface |
ScalingPolicy.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Alarm> |
alarms()
The CloudWatch alarms associated with the scaling policy.
|
static ScalingPolicy.Builder |
builder() |
Instant |
creationTime()
The Unix timestamp for when the scaling policy was created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAlarms()
For responses, this returns true if the service returned a value for the Alarms property.
|
int |
hashCode() |
String |
policyARN()
The Amazon Resource Name (ARN) of the scaling policy.
|
String |
policyName()
The name of the scaling policy.
|
PolicyType |
policyType()
The scaling policy type.
|
String |
policyTypeAsString()
The scaling policy type.
|
String |
resourceId()
The identifier of the resource associated with the scaling policy.
|
ScalableDimension |
scalableDimension()
The scalable dimension.
|
String |
scalableDimensionAsString()
The scalable dimension.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends ScalingPolicy.Builder> |
serializableBuilderClass() |
ServiceNamespace |
serviceNamespace()
The namespace of the Amazon Web Services service that provides the resource, or a
custom-resource. |
String |
serviceNamespaceAsString()
The namespace of the Amazon Web Services service that provides the resource, or a
custom-resource. |
StepScalingPolicyConfiguration |
stepScalingPolicyConfiguration()
A step scaling policy.
|
TargetTrackingScalingPolicyConfiguration |
targetTrackingScalingPolicyConfiguration()
A target tracking scaling policy.
|
ScalingPolicy.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String policyARN()
The Amazon Resource Name (ARN) of the scaling policy.
public final String policyName()
The name of the scaling policy.
public final ServiceNamespace serviceNamespace()
The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
If the service returns an enum value that is not available in the current SDK version, serviceNamespace
will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from serviceNamespaceAsString().
custom-resource.ServiceNamespacepublic final String serviceNamespaceAsString()
The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
If the service returns an enum value that is not available in the current SDK version, serviceNamespace
will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from serviceNamespaceAsString().
custom-resource.ServiceNamespacepublic final String resourceId()
The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
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 - 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.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and
instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name.
Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example:
table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index
name. 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.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource
ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the
service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using
the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the
endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the
function name with a function version or alias name suffix that is not $LATEST. Example:
function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name.
Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique
identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name.
Example: cluster:mycluster.
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is the
resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
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 - 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.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID
and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet
name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name.
Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is
the index name. 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.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the
resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the
OutputValue from the CloudFormation template stack used to access the resources. The unique
identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are
specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified
using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is
the function name with a function version or alias name suffix that is not $LATEST. Example:
function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table
name. Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN.
Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
.
Amazon ElastiCache replication group - The resource type is replication-group and the unique
identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster
name. Example: cluster:mycluster.
SageMaker Serverless endpoint - The resource type is variant and the unique identifier is
the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
public final ScalableDimension scalableDimension()
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint
variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by
your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an
Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
Serverless endpoint.
If the service returns an enum value that is not available in the current SDK version, scalableDimension
will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from scalableDimensionAsString().
ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model
endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource
provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference
units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units
for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces
table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces
table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an
Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon
ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB
cluster.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a
SageMaker Serverless endpoint.
ScalableDimensionpublic final String scalableDimensionAsString()
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint
variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by
your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an
Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an
Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK
cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache
replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker
Serverless endpoint.
If the service returns an enum value that is not available in the current SDK version, scalableDimension
will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from scalableDimensionAsString().
ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
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.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model
endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource
provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference
units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units
for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces
table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces
table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an
Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon
ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon
ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB
cluster.
sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a
SageMaker Serverless endpoint.
ScalableDimensionpublic final PolicyType policyType()
The scaling policy type.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK,
Amazon ElastiCache, or Neptune.
If the service returns an enum value that is not available in the current SDK version, policyType will
return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
policyTypeAsString().
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon
MSK, Amazon ElastiCache, or Neptune.
PolicyTypepublic final String policyTypeAsString()
The scaling policy type.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK,
Amazon ElastiCache, or Neptune.
If the service returns an enum value that is not available in the current SDK version, policyType will
return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
policyTypeAsString().
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMR
StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon
MSK, Amazon ElastiCache, or Neptune.
PolicyTypepublic final StepScalingPolicyConfiguration stepScalingPolicyConfiguration()
A step scaling policy.
public final TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration()
A target tracking scaling policy.
public final boolean hasAlarms()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Alarm> alarms()
The CloudWatch alarms associated with the scaling policy.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAlarms() method.
public final Instant creationTime()
The Unix timestamp for when the scaling policy was created.
public ScalingPolicy.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>public static ScalingPolicy.Builder builder()
public static Class<? extends ScalingPolicy.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.