@Generated(value="software.amazon.awssdk:codegen") public final class ScalingActivity extends Object implements StructuredPojo, ToCopyableBuilder<ScalingActivity.Builder,ScalingActivity>
Represents a scaling activity.
Modifier and Type | Class and Description |
---|---|
static interface |
ScalingActivity.Builder |
Modifier and Type | Method and Description |
---|---|
String |
activityId()
The unique identifier of the scaling activity.
|
static ScalingActivity.Builder |
builder() |
String |
cause()
A simple description of what caused the scaling activity to happen.
|
String |
description()
A simple description of what action the scaling activity intends to accomplish.
|
String |
details()
The details about the scaling activity.
|
Instant |
endTime()
The Unix timestamp for when the scaling activity ended.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
resourceId()
The identifier of the resource associated with the scaling activity.
|
ScalableDimension |
scalableDimension()
The scalable dimension.
|
String |
scalableDimensionAsString()
The scalable dimension.
|
static Class<? extends ScalingActivity.Builder> |
serializableBuilderClass() |
ServiceNamespace |
serviceNamespace()
The namespace of the AWS service.
|
String |
serviceNamespaceAsString()
The namespace of the AWS service.
|
Instant |
startTime()
The Unix timestamp for when the scaling activity began.
|
ScalingActivityStatusCode |
statusCode()
Indicates the status of the scaling activity.
|
String |
statusCodeAsString()
Indicates the status of the scaling activity.
|
String |
statusMessage()
A simple message about the current status of the scaling activity.
|
ScalingActivity.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String activityId()
The unique identifier of the scaling activity.
public ServiceNamespace serviceNamespace()
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
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()
.
ServiceNamespace
public String serviceNamespaceAsString()
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
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()
.
ServiceNamespace
public String resourceId()
The identifier of the resource associated with the scaling activity. 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
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.
Example: cluster:my-db-cluster
.
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
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster
name. Example: cluster:my-db-cluster
.
public 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.
rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for
Aurora MySQL-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()
.
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.
rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster.
Available for Aurora MySQL-compatible edition.
ScalableDimension
public String scalableDimensionAsString()
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.
rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for
Aurora MySQL-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()
.
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.
rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster.
Available for Aurora MySQL-compatible edition.
ScalableDimension
public String description()
A simple description of what action the scaling activity intends to accomplish.
public String cause()
A simple description of what caused the scaling activity to happen.
public Instant startTime()
The Unix timestamp for when the scaling activity began.
public Instant endTime()
The Unix timestamp for when the scaling activity ended.
public ScalingActivityStatusCode statusCode()
Indicates the status of the scaling activity.
If the service returns an enum value that is not available in the current SDK version, statusCode
will
return ScalingActivityStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusCodeAsString()
.
ScalingActivityStatusCode
public String statusCodeAsString()
Indicates the status of the scaling activity.
If the service returns an enum value that is not available in the current SDK version, statusCode
will
return ScalingActivityStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is
available from statusCodeAsString()
.
ScalingActivityStatusCode
public String statusMessage()
A simple message about the current status of the scaling activity.
public String details()
The details about the scaling activity.
public ScalingActivity.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ScalingActivity.Builder,ScalingActivity>
public static ScalingActivity.Builder builder()
public static Class<? extends ScalingActivity.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.