software.amazon.awssdk.services.applicationautoscaling.model

Class ScalingActivity

java.lang.Object

software.amazon.awssdk.services.applicationautoscaling.model.ScalingActivity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScalingActivity.Builder,ScalingActivity>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingActivity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingActivity.Builder,ScalingActivity>

Represents a scaling activity.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScalingActivity.Builder

Method Summary

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()
String	resourceId() The identifier of the resource associated with the scaling activity.
ScalableDimension	scalableDimension() The scalable dimension.
String	scalableDimensionAsString() The scalable dimension.
List<SdkField<?>>	sdkFields()
static Class<? extends ScalingActivity.Builder>	serializableBuilderClass()
ServiceNamespace	serviceNamespace() The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.
String	serviceNamespaceAsString() The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or 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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

activityId

public String activityId()

The unique identifier of the scaling activity.

Returns:

The unique identifier of the scaling activity.

serviceNamespace

public ServiceNamespace serviceNamespace()

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or 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().

Returns:

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

See Also:

ServiceNamespace

serviceNamespaceAsString

public String serviceNamespaceAsString()

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or 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().

Returns:

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or 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 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.

• Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

• Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider.

Returns:

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.

• Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

• Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider.

scalableDimension

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.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

• custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

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().

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.

• rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

• custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

See Also:

ScalableDimension

scalableDimensionAsString

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.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

• custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

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().

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.

• rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

• custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

See Also:

ScalableDimension

description

public String description()

A simple description of what action the scaling activity intends to accomplish.

Returns:

A simple description of what action the scaling activity intends to accomplish.

cause

public String cause()

A simple description of what caused the scaling activity to happen.

Returns:

A simple description of what caused the scaling activity to happen.

startTime

public Instant startTime()

The Unix timestamp for when the scaling activity began.

Returns:

The Unix timestamp for when the scaling activity began.

endTime

public Instant endTime()

The Unix timestamp for when the scaling activity ended.

Returns:

The Unix timestamp for when the scaling activity ended.

statusCode

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().

Returns:

Indicates the status of the scaling activity.

See Also:

ScalingActivityStatusCode

statusCodeAsString

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().

Returns:

Indicates the status of the scaling activity.

See Also:

ScalingActivityStatusCode

statusMessage

public String statusMessage()

A simple message about the current status of the scaling activity.

Returns:

A simple message about the current status of the scaling activity.

details

public String details()

The details about the scaling activity.

Returns:

The details about the scaling activity.

toBuilder

public ScalingActivity.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<ScalingActivity.Builder,ScalingActivity>

Returns:

a builder for type T

builder

public static ScalingActivity.Builder builder()

serializableBuilderClass

public static Class<? extends ScalingActivity.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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.