@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ScalingPlanResource extends Object implements Serializable, Cloneable, StructuredPojo
Represents a scalable resource.
Constructor and Description |
---|
ScalingPlanResource() |
Modifier and Type | Method and Description |
---|---|
ScalingPlanResource |
clone() |
boolean |
equals(Object obj) |
String |
getResourceId()
The ID of the resource.
|
String |
getScalableDimension()
The scalable dimension for the resource.
|
String |
getScalingPlanName()
The name of the scaling plan.
|
Long |
getScalingPlanVersion()
The version number of the scaling plan.
|
List<ScalingPolicy> |
getScalingPolicies()
The scaling policies.
|
String |
getScalingStatusCode()
The scaling status of the resource.
|
String |
getScalingStatusMessage()
A simple message about the current scaling status of the resource.
|
String |
getServiceNamespace()
The namespace of the AWS service.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setResourceId(String resourceId)
The ID of the resource.
|
void |
setScalableDimension(String scalableDimension)
The scalable dimension for the resource.
|
void |
setScalingPlanName(String scalingPlanName)
The name of the scaling plan.
|
void |
setScalingPlanVersion(Long scalingPlanVersion)
The version number of the scaling plan.
|
void |
setScalingPolicies(Collection<ScalingPolicy> scalingPolicies)
The scaling policies.
|
void |
setScalingStatusCode(String scalingStatusCode)
The scaling status of the resource.
|
void |
setScalingStatusMessage(String scalingStatusMessage)
A simple message about the current scaling status of the resource.
|
void |
setServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
String |
toString()
Returns a string representation of this object.
|
ScalingPlanResource |
withResourceId(String resourceId)
The ID of the resource.
|
ScalingPlanResource |
withScalableDimension(ScalableDimension scalableDimension)
The scalable dimension for the resource.
|
ScalingPlanResource |
withScalableDimension(String scalableDimension)
The scalable dimension for the resource.
|
ScalingPlanResource |
withScalingPlanName(String scalingPlanName)
The name of the scaling plan.
|
ScalingPlanResource |
withScalingPlanVersion(Long scalingPlanVersion)
The version number of the scaling plan.
|
ScalingPlanResource |
withScalingPolicies(Collection<ScalingPolicy> scalingPolicies)
The scaling policies.
|
ScalingPlanResource |
withScalingPolicies(ScalingPolicy... scalingPolicies)
The scaling policies.
|
ScalingPlanResource |
withScalingStatusCode(ScalingStatusCode scalingStatusCode)
The scaling status of the resource.
|
ScalingPlanResource |
withScalingStatusCode(String scalingStatusCode)
The scaling status of the resource.
|
ScalingPlanResource |
withScalingStatusMessage(String scalingStatusMessage)
A simple message about the current scaling status of the resource.
|
ScalingPlanResource |
withServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
ScalingPlanResource |
withServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
public void setScalingPlanName(String scalingPlanName)
The name of the scaling plan.
scalingPlanName
- The name of the scaling plan.public String getScalingPlanName()
The name of the scaling plan.
public ScalingPlanResource withScalingPlanName(String scalingPlanName)
The name of the scaling plan.
scalingPlanName
- The name of the scaling plan.public void setScalingPlanVersion(Long scalingPlanVersion)
The version number of the scaling plan.
scalingPlanVersion
- The version number of the scaling plan.public Long getScalingPlanVersion()
The version number of the scaling plan.
public ScalingPlanResource withScalingPlanVersion(Long scalingPlanVersion)
The version number of the scaling plan.
scalingPlanVersion
- The version number of the scaling plan.public void setServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
serviceNamespace
- The namespace of the AWS service.ServiceNamespace
public String getServiceNamespace()
The namespace of the AWS service.
ServiceNamespace
public ScalingPlanResource withServiceNamespace(String serviceNamespace)
The namespace of the AWS service.
serviceNamespace
- The namespace of the AWS service.ServiceNamespace
public ScalingPlanResource withServiceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
serviceNamespace
- The namespace of the AWS service.ServiceNamespace
public void setResourceId(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
.
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
.
public String getResourceId()
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
.
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
.
public ScalingPlanResource withResourceId(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
.
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
.
public void setScalableDimension(String 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.
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.
ScalableDimension
public String getScalableDimension()
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.
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.
ScalableDimension
public ScalingPlanResource withScalableDimension(String 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.
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.
ScalableDimension
public ScalingPlanResource withScalableDimension(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.
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.
ScalableDimension
public List<ScalingPolicy> getScalingPolicies()
The scaling policies.
public void setScalingPolicies(Collection<ScalingPolicy> scalingPolicies)
The scaling policies.
scalingPolicies
- The scaling policies.public ScalingPlanResource withScalingPolicies(ScalingPolicy... scalingPolicies)
The scaling policies.
NOTE: This method appends the values to the existing list (if any). Use
setScalingPolicies(java.util.Collection)
or withScalingPolicies(java.util.Collection)
if you
want to override the existing values.
scalingPolicies
- The scaling policies.public ScalingPlanResource withScalingPolicies(Collection<ScalingPolicy> scalingPolicies)
The scaling policies.
scalingPolicies
- The scaling policies.public void setScalingStatusCode(String 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.
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.
ScalingStatusCode
public String getScalingStatusCode()
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.
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.
ScalingStatusCode
public ScalingPlanResource withScalingStatusCode(String 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.
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.
ScalingStatusCode
public ScalingPlanResource withScalingStatusCode(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.
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.
ScalingStatusCode
public void setScalingStatusMessage(String scalingStatusMessage)
A simple message about the current scaling status of the resource.
scalingStatusMessage
- A simple message about the current scaling status of the resource.public String getScalingStatusMessage()
A simple message about the current scaling status of the resource.
public ScalingPlanResource withScalingStatusMessage(String scalingStatusMessage)
A simple message about the current scaling status of the resource.
scalingStatusMessage
- A simple message about the current scaling status of the resource.public String toString()
toString
in class Object
Object.toString()
public ScalingPlanResource clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.