software.amazon.awssdk.services.autoscalingplans.model

Class ScalingPlanResource

java.lang.Object

software.amazon.awssdk.services.autoscalingplans.model.ScalingPlanResource

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScalingPlanResource.Builder,ScalingPlanResource>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingPlanResource
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPlanResource.Builder,ScalingPlanResource>

Represents a scalable resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScalingPlanResource.Builder

Method Summary

Modifier and Type	Method and Description
static ScalingPlanResource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasScalingPolicies() For responses, this returns true if the service returned a value for the ScalingPolicies property.
String	resourceId() The ID of the resource.
ScalableDimension	scalableDimension() The scalable dimension for the resource.
String	scalableDimensionAsString() The scalable dimension for the resource.
String	scalingPlanName() The name of the scaling plan.
Long	scalingPlanVersion() The version number of the scaling plan.
List<ScalingPolicy>	scalingPolicies() The scaling policies.
ScalingStatusCode	scalingStatusCode() The scaling status of the resource.
String	scalingStatusCodeAsString() The scaling status of the resource.
String	scalingStatusMessage() A simple message about the current scaling status of the resource.
List<SdkField<?>>	sdkFields()
static Class<? extends ScalingPlanResource.Builder>	serializableBuilderClass()
ServiceNamespace	serviceNamespace() The namespace of the AWS service.
String	serviceNamespaceAsString() The namespace of the AWS service.
ScalingPlanResource.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scalingPlanName

public final String scalingPlanName()

The name of the scaling plan.

Returns:

The name of the scaling plan.

scalingPlanVersion

public final Long scalingPlanVersion()

The version number of the scaling plan.

Returns:

The version number of the scaling plan.

serviceNamespace

public final ServiceNamespace 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 return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().

Returns:

The namespace of the AWS service.

See Also:

ServiceNamespace

serviceNamespaceAsString

public final String 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 return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().

Returns:

The namespace of the AWS service.

See Also:

ServiceNamespace

resourceId

public final String 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

public final ScalableDimension 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 return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().

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:

ScalableDimension

scalableDimensionAsString

public final String 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 return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().

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:

ScalableDimension

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 the 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.

scalingPolicies

public final List<ScalingPolicy> 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

public final ScalingStatusCode 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 return ScalingStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingStatusCodeAsString().

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:

ScalingStatusCode

scalingStatusCodeAsString

public final String 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 return ScalingStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingStatusCodeAsString().

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:

ScalingStatusCode

scalingStatusMessage

public final String 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

public ScalingPlanResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScalingPlanResource.Builder,ScalingPlanResource>

builder

public static ScalingPlanResource.Builder builder()

serializableBuilderClass

public static Class<? extends ScalingPlanResource.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo