ScalingRule (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.elasticmapreduce.model

Class ScalingRule

java.lang.Object
- com.amazonaws.services.elasticmapreduce.model.ScalingRule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingRule
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how Amazon EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScalingRule ()

Constructors
Constructor and Description
`ScalingRule ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ScalingRule`	`clone ()`
`boolean`	`equals (Object obj)`
`ScalingAction`	`getAction ()` The conditions that trigger an automatic scaling activity.
`String`	`getDescription ()` A friendly, more verbose description of the automatic scaling rule.
`String`	`getName ()` The name used to identify an automatic scaling rule.
`ScalingTrigger`	`getTrigger ()` The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAction (ScalingAction action)` The conditions that trigger an automatic scaling activity.
`void`	`setDescription (String description)` A friendly, more verbose description of the automatic scaling rule.
`void`	`setName (String name)` The name used to identify an automatic scaling rule.
`void`	`setTrigger (ScalingTrigger trigger)` The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
`String`	`toString ()` Returns a string representation of this object.
`ScalingRule`	`withAction (ScalingAction action)` The conditions that trigger an automatic scaling activity.
`ScalingRule`	`withDescription (String description)` A friendly, more verbose description of the automatic scaling rule.
`ScalingRule`	`withName (String name)` The name used to identify an automatic scaling rule.
`ScalingRule`	`withTrigger (ScalingTrigger trigger)` The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

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

- Constructor Detail
  - ScalingRule
```
public ScalingRule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
    
    Parameters:
    
    name - The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
  - getName
```
public String getName()
```
    The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
    
    Returns:
    
    The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
  - withName
```
public ScalingRule withName(String name)
```
    The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
    
    Parameters:
    
    name - The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A friendly, more verbose description of the automatic scaling rule.
    
    Parameters:
    
    description - A friendly, more verbose description of the automatic scaling rule.
  - getDescription
```
public String getDescription()
```
    A friendly, more verbose description of the automatic scaling rule.
    
    Returns:
    
    A friendly, more verbose description of the automatic scaling rule.
  - withDescription
```
public ScalingRule withDescription(String description)
```
    A friendly, more verbose description of the automatic scaling rule.
    
    Parameters:
    
    description - A friendly, more verbose description of the automatic scaling rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAction
```
public void setAction(ScalingAction action)
```
    The conditions that trigger an automatic scaling activity.
    
    Parameters:
    
    action - The conditions that trigger an automatic scaling activity.
  - getAction
```
public ScalingAction getAction()
```
    The conditions that trigger an automatic scaling activity.
    
    Returns:
    
    The conditions that trigger an automatic scaling activity.
  - withAction
```
public ScalingRule withAction(ScalingAction action)
```
    The conditions that trigger an automatic scaling activity.
    
    Parameters:
    
    action - The conditions that trigger an automatic scaling activity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrigger
```
public void setTrigger(ScalingTrigger trigger)
```
    The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
    
    Parameters:
    
    trigger - The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
  - getTrigger
```
public ScalingTrigger getTrigger()
```
    The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
    
    Returns:
    
    The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
  - withTrigger
```
public ScalingRule withTrigger(ScalingTrigger trigger)
```
    The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
    
    Parameters:
    
    trigger - The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ScalingRule clone()
```
    Overrides:
    
    clone 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.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ScalingRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScalingRule

Method Detail

setName

getName

withName

setDescription

getDescription

withDescription

setAction

getAction

withAction

setTrigger

getTrigger

withTrigger

toString

equals

hashCode

clone

marshall