Class ScalingPlanResource
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ScalingPlanResource.Builder,
ScalingPlanResource>
Represents a scalable resource.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ScalingPlanResource.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ScalingPolicies property.final String
The ID of the resource.final ScalableDimension
The scalable dimension for the resource.final String
The scalable dimension for the resource.final String
The name of the scaling plan.final Long
The version number of the scaling plan.final List
<ScalingPolicy> The scaling policies.final ScalingStatusCode
The scaling status of the resource.final String
The scaling status of the resource.final String
A simple message about the current scaling status of the resource.static Class
<? extends ScalingPlanResource.Builder> final ServiceNamespace
The namespace of the AWS service.final String
The namespace of the AWS service.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
scalingPlanName
The name of the scaling plan.
- Returns:
- The name of the scaling plan.
-
scalingPlanVersion
The version number of the scaling plan.
- Returns:
- The version number of the scaling plan.
-
serviceNamespace
The namespace of the AWS service.
If the service returns an enum value that is not available in the current SDK version,
serviceNamespace
will returnServiceNamespace.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceNamespaceAsString()
.- Returns:
- The namespace of the AWS service.
- See Also:
-
serviceNamespaceAsString
The namespace of the AWS service.
If the service returns an enum value that is not available in the current SDK version,
serviceNamespace
will returnServiceNamespace.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromserviceNamespaceAsString()
.- Returns:
- The namespace of the AWS service.
- See Also:
-
resourceId
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
.
- Returns:
- 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
.
-
-
-
scalableDimension
The scalable dimension for 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.
If the service returns an enum value that is not available in the current SDK version,
scalableDimension
will returnScalableDimension.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalableDimensionAsString()
.- Returns:
- The scalable dimension for 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.
-
- See Also:
-
-
scalableDimensionAsString
The scalable dimension for 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.
If the service returns an enum value that is not available in the current SDK version,
scalableDimension
will returnScalableDimension.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalableDimensionAsString()
.- Returns:
- The scalable dimension for 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.
-
- See Also:
-
-
hasScalingPolicies
public final boolean hasScalingPolicies()For responses, this returns true if the service returned a value for the ScalingPolicies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
scalingPolicies
The scaling policies.
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
hasScalingPolicies()
method.- Returns:
- The scaling policies.
-
scalingStatusCode
The scaling status of the resource.
-
Active
- The scaling configuration is active. -
Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. -
PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
If the service returns an enum value that is not available in the current SDK version,
scalingStatusCode
will returnScalingStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalingStatusCodeAsString()
.- Returns:
- The scaling status of the resource.
-
Active
- The scaling configuration is active. -
Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. -
PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
-
- See Also:
-
-
scalingStatusCodeAsString
The scaling status of the resource.
-
Active
- The scaling configuration is active. -
Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. -
PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
If the service returns an enum value that is not available in the current SDK version,
scalingStatusCode
will returnScalingStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscalingStatusCodeAsString()
.- Returns:
- The scaling status of the resource.
-
Active
- The scaling configuration is active. -
Inactive
- The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information. -
PartiallyActive
- The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
-
- See Also:
-
-
scalingStatusMessage
A simple message about the current scaling status of the resource.
- Returns:
- A simple message about the current scaling status of the resource.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ScalingPlanResource.Builder,
ScalingPlanResource> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-