ScalingPolicy (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.applicationautoscaling.model.ScalingPolicy

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>

@Generated("software.amazon.awssdk:codegen")
public class ScalingPolicy
extends Object
implements StructuredPojo, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>

Represents a scaling policy.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ScalingPolicy.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ScalingPolicy.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Alarm>`	`alarms()`	The CloudWatch alarms associated with the scaling policy.
`static ScalingPolicy.Builder`	`builder()`
`Date`	`creationTime()`	The Unix timestamp for when the scaling policy was created.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`policyARN()`	The Amazon Resource Name (ARN) of the scaling policy.
`String`	`policyName()`	The name of the scaling policy.
`String`	`policyType()`	The scaling policy type.
`String`	`resourceId()`	The identifier of the resource associated with the scaling policy.
`String`	`scalableDimension()`	The scalable dimension.
`static Class<? extends ScalingPolicy.Builder>`	`serializableBuilderClass()`
`String`	`serviceNamespace()`	The namespace of the AWS service.
`StepScalingPolicyConfiguration`	`stepScalingPolicyConfiguration()`	A step scaling policy.
`TargetTrackingScalingPolicyConfiguration`	`targetTrackingScalingPolicyConfiguration()`	A target tracking policy.
`ScalingPolicy.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

- Method Detail
  - policyARN
```
public String policyARN()
```
    The Amazon Resource Name (ARN) of the scaling policy.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the scaling policy.
  - policyName
```
public String policyName()
```
    The name of the scaling policy.
    
    Returns:
    
    The name of the scaling policy.
  - serviceNamespace
```
public String serviceNamespace()
```
    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    
    Returns:
    
    The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public 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 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.
    - 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 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.
    Returns:
    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 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.
    
    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 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.
  - scalableDimension
```
public String 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.
    - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.
    - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    - 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.
    Returns:
    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.
    
    ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.
    
    elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    
    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.
    See Also:
    
    ScalableDimension
  - policyType
```
public String policyType()
```
    The scaling policy type.
    
    Returns:
    
    The scaling policy type.
    
    See Also:
    
    PolicyType
  - stepScalingPolicyConfiguration
```
public StepScalingPolicyConfiguration stepScalingPolicyConfiguration()
```
    A step scaling policy.
    
    Returns:
    
    A step scaling policy.
  - targetTrackingScalingPolicyConfiguration
```
public TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration()
```
    A target tracking policy.
    
    Returns:
    
    A target tracking policy.
  - alarms
```
public List<Alarm> alarms()
```
    The CloudWatch alarms associated with the scaling policy.
    
    Returns:
    
    The CloudWatch alarms associated with the scaling policy.
  - creationTime
```
public Date creationTime()
```
    The Unix timestamp for when the scaling policy was created.
    
    Returns:
    
    The Unix timestamp for when the scaling policy was created.
  - toBuilder
```
public ScalingPolicy.Builder 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 interface ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ScalingPolicy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalingPolicy.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class ScalingPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

policyARN

policyName

serviceNamespace

resourceId

scalableDimension

policyType

stepScalingPolicyConfiguration

targetTrackingScalingPolicyConfiguration

alarms

creationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall