@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ScalingPolicy extends Object implements Serializable, Cloneable, StructuredPojo
Represents a scaling policy.
Constructor and Description |
---|
ScalingPolicy() |
Modifier and Type | Method and Description |
---|---|
ScalingPolicy |
clone() |
boolean |
equals(Object obj) |
List<Alarm> |
getAlarms()
The CloudWatch alarms associated with the scaling policy.
|
Date |
getCreationTime()
The Unix timestamp for when the scaling policy was created.
|
String |
getPolicyARN()
The Amazon Resource Name (ARN) of the scaling policy.
|
String |
getPolicyName()
The name of the scaling policy.
|
String |
getPolicyType()
The scaling policy type.
|
String |
getResourceId()
The identifier of the resource associated with the scaling policy.
|
String |
getScalableDimension()
The scalable dimension.
|
String |
getServiceNamespace()
The namespace of the AWS service.
|
StepScalingPolicyConfiguration |
getStepScalingPolicyConfiguration()
A step scaling policy.
|
TargetTrackingScalingPolicyConfiguration |
getTargetTrackingScalingPolicyConfiguration()
A target tracking policy.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAlarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
|
void |
setCreationTime(Date creationTime)
The Unix timestamp for when the scaling policy was created.
|
void |
setPolicyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
|
void |
setPolicyName(String policyName)
The name of the scaling policy.
|
void |
setPolicyType(PolicyType policyType)
The scaling policy type.
|
void |
setPolicyType(String policyType)
The scaling policy type.
|
void |
setResourceId(String resourceId)
The identifier of the resource associated with the scaling policy.
|
void |
setScalableDimension(ScalableDimension scalableDimension)
The scalable dimension.
|
void |
setScalableDimension(String scalableDimension)
The scalable dimension.
|
void |
setServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
void |
setServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
void |
setStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
|
void |
setTargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
ScalingPolicy |
withAlarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy |
withAlarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy |
withCreationTime(Date creationTime)
The Unix timestamp for when the scaling policy was created.
|
ScalingPolicy |
withPolicyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
|
ScalingPolicy |
withPolicyName(String policyName)
The name of the scaling policy.
|
ScalingPolicy |
withPolicyType(PolicyType policyType)
The scaling policy type.
|
ScalingPolicy |
withPolicyType(String policyType)
The scaling policy type.
|
ScalingPolicy |
withResourceId(String resourceId)
The identifier of the resource associated with the scaling policy.
|
ScalingPolicy |
withScalableDimension(ScalableDimension scalableDimension)
The scalable dimension.
|
ScalingPolicy |
withScalableDimension(String scalableDimension)
The scalable dimension.
|
ScalingPolicy |
withServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
ScalingPolicy |
withServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
ScalingPolicy |
withStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
|
ScalingPolicy |
withTargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
|
public void setPolicyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
policyARN
- The Amazon Resource Name (ARN) of the scaling policy.public String getPolicyARN()
The Amazon Resource Name (ARN) of the scaling policy.
public ScalingPolicy withPolicyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
policyARN
- The Amazon Resource Name (ARN) of the scaling policy.public void setPolicyName(String policyName)
The name of the scaling policy.
policyName
- The name of the scaling policy.public String getPolicyName()
The name of the scaling policy.
public ScalingPolicy withPolicyName(String policyName)
The name of the scaling policy.
policyName
- The name of the scaling policy.public void setServiceNamespace(String serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
public String getServiceNamespace()
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
ServiceNamespace
public ScalingPolicy withServiceNamespace(String serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
public void setServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
public ScalingPolicy withServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
public void setResourceId(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
.
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
.
public String getResourceId()
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
.
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
.
public ScalingPolicy withResourceId(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
.
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
.
public void setScalableDimension(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.
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.
ScalableDimension
public String getScalableDimension()
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.
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.
ScalableDimension
public ScalingPolicy withScalableDimension(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.
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.
ScalableDimension
public void setScalableDimension(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.
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.
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.
ScalableDimension
public ScalingPolicy withScalableDimension(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.
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.
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.
ScalableDimension
public void setPolicyType(String policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
public String getPolicyType()
The scaling policy type.
PolicyType
public ScalingPolicy withPolicyType(String policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
public void setPolicyType(PolicyType policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
public ScalingPolicy withPolicyType(PolicyType policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
public void setStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
stepScalingPolicyConfiguration
- A step scaling policy.public StepScalingPolicyConfiguration getStepScalingPolicyConfiguration()
A step scaling policy.
public ScalingPolicy withStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
stepScalingPolicyConfiguration
- A step scaling policy.public void setTargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
targetTrackingScalingPolicyConfiguration
- A target tracking policy.public TargetTrackingScalingPolicyConfiguration getTargetTrackingScalingPolicyConfiguration()
A target tracking policy.
public ScalingPolicy withTargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
targetTrackingScalingPolicyConfiguration
- A target tracking policy.public List<Alarm> getAlarms()
The CloudWatch alarms associated with the scaling policy.
public void setAlarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
alarms
- The CloudWatch alarms associated with the scaling policy.public ScalingPolicy withAlarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
NOTE: This method appends the values to the existing list (if any). Use
setAlarms(java.util.Collection)
or withAlarms(java.util.Collection)
if you want to override the
existing values.
alarms
- The CloudWatch alarms associated with the scaling policy.public ScalingPolicy withAlarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
alarms
- The CloudWatch alarms associated with the scaling policy.public void setCreationTime(Date creationTime)
The Unix timestamp for when the scaling policy was created.
creationTime
- The Unix timestamp for when the scaling policy was created.public Date getCreationTime()
The Unix timestamp for when the scaling policy was created.
public ScalingPolicy withCreationTime(Date creationTime)
The Unix timestamp for when the scaling policy was created.
creationTime
- The Unix timestamp for when the scaling policy was created.public String toString()
toString
in class Object
Object.toString()
public ScalingPolicy clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.