software.amazon.awssdk.services.applicationautoscaling.model

Interface ScalingActivity.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ScalingActivity.Builder,ScalingActivity>, SdkBuilder<ScalingActivity.Builder,ScalingActivity>, SdkPojo

Enclosing class:

ScalingActivity

public static interface ScalingActivity.Builder
extends SdkPojo, CopyableBuilder<ScalingActivity.Builder,ScalingActivity>

Method Summary

Modifier and Type	Method and Description
ScalingActivity.Builder	activityId(String activityId) The unique identifier of the scaling activity.
ScalingActivity.Builder	cause(String cause) A simple description of what caused the scaling activity to happen.
ScalingActivity.Builder	description(String description) A simple description of what action the scaling activity intends to accomplish.
ScalingActivity.Builder	details(String details) The details about the scaling activity.
ScalingActivity.Builder	endTime(Instant endTime) The Unix timestamp for when the scaling activity ended.
ScalingActivity.Builder	notScaledReasons(Collection<NotScaledReason> notScaledReasons) Machine-readable data that describes the reason for a not scaled activity.
ScalingActivity.Builder	notScaledReasons(Consumer<NotScaledReason.Builder>... notScaledReasons) Machine-readable data that describes the reason for a not scaled activity.
ScalingActivity.Builder	notScaledReasons(NotScaledReason... notScaledReasons) Machine-readable data that describes the reason for a not scaled activity.
ScalingActivity.Builder	resourceId(String resourceId) The identifier of the resource associated with the scaling activity.
ScalingActivity.Builder	scalableDimension(ScalableDimension scalableDimension) The scalable dimension.
ScalingActivity.Builder	scalableDimension(String scalableDimension) The scalable dimension.
ScalingActivity.Builder	serviceNamespace(ServiceNamespace serviceNamespace) The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
ScalingActivity.Builder	serviceNamespace(String serviceNamespace) The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
ScalingActivity.Builder	startTime(Instant startTime) The Unix timestamp for when the scaling activity began.
ScalingActivity.Builder	statusCode(ScalingActivityStatusCode statusCode) Indicates the status of the scaling activity.
ScalingActivity.Builder	statusCode(String statusCode) Indicates the status of the scaling activity.
ScalingActivity.Builder	statusMessage(String statusMessage) A simple message about the current status of the scaling activity.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

activityId

ScalingActivity.Builder activityId(String activityId)

The unique identifier of the scaling activity.

Parameters:

activityId - The unique identifier of the scaling activity.

Returns:

Returns a reference to this object so that method calls can be chained together.

serviceNamespace

ScalingActivity.Builder serviceNamespace(String serviceNamespace)

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

Parameters:

serviceNamespace - The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace, ServiceNamespace

serviceNamespace

ScalingActivity.Builder serviceNamespace(ServiceNamespace serviceNamespace)

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

Parameters:

serviceNamespace - The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace, ServiceNamespace

resourceId

ScalingActivity.Builder resourceId(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 - 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 table name. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. 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.

• SageMaker endpoint variant - 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. More information is available in our GitHub repository.

• Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

• Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

• Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

• Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

• Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .

• Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.

• Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

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

Parameters:

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 - 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 table name. Example: table/my-table.

• DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. 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.

• SageMaker endpoint variant - 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. More information is available in our GitHub repository.

• Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.

• Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.

• Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.

• Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.

• Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5 .

• Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.

• Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

scalableDimension

ScalingActivity.Builder scalableDimension(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.

• elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

• ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

• 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 and Aurora PostgreSQL-compatible edition.

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

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

• comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

• comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

• lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

• cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

• cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

• kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

• elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

• elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

• neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Parameters:

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.

• elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

• ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

• 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 and Aurora PostgreSQL-compatible edition.

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

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

• comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

• comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

• lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

• cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

• cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

• kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

• elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

• elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

• neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension, ScalableDimension

scalableDimension

ScalingActivity.Builder scalableDimension(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.

• elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

• ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

• 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 and Aurora PostgreSQL-compatible edition.

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

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

• comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

• comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

• lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

• cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

• cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

• kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

• elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

• elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

• neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Parameters:

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.

• elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

• ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.

• 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 and Aurora PostgreSQL-compatible edition.

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

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

• comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.

• comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.

• lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.

• cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.

• cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.

• kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

• elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.

• elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.

• neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension, ScalableDimension

description

ScalingActivity.Builder description(String description)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cause

ScalingActivity.Builder cause(String cause)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

ScalingActivity.Builder startTime(Instant startTime)

The Unix timestamp for when the scaling activity began.

Parameters:

startTime - The Unix timestamp for when the scaling activity began.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

ScalingActivity.Builder endTime(Instant endTime)

The Unix timestamp for when the scaling activity ended.

Parameters:

endTime - The Unix timestamp for when the scaling activity ended.

Returns:

Returns a reference to this object so that method calls can be chained together.

statusCode

ScalingActivity.Builder statusCode(String statusCode)

Indicates the status of the scaling activity.

Parameters:

statusCode - Indicates the status of the scaling activity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingActivityStatusCode, ScalingActivityStatusCode

statusCode

ScalingActivity.Builder statusCode(ScalingActivityStatusCode statusCode)

Indicates the status of the scaling activity.

Parameters:

statusCode - Indicates the status of the scaling activity.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingActivityStatusCode, ScalingActivityStatusCode

statusMessage

ScalingActivity.Builder statusMessage(String statusMessage)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

details

ScalingActivity.Builder details(String details)

The details about the scaling activity.

Parameters:

details - The details about the scaling activity.

Returns:

Returns a reference to this object so that method calls can be chained together.

notScaledReasons

ScalingActivity.Builder notScaledReasons(Collection<NotScaledReason> notScaledReasons)

Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

Parameters:

notScaledReasons - Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

Returns:

Returns a reference to this object so that method calls can be chained together.

notScaledReasons

ScalingActivity.Builder notScaledReasons(NotScaledReason... notScaledReasons)

Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

Parameters:

notScaledReasons - Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

Returns:

Returns a reference to this object so that method calls can be chained together.

notScaledReasons

ScalingActivity.Builder notScaledReasons(Consumer<NotScaledReason.Builder>... notScaledReasons)

Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

This is a convenience method that creates an instance of the NotScaledReason.Builder avoiding the need to create one manually via NotScaledReason.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #notScaledReasons(List).

Parameters:

notScaledReasons - a consumer that will call methods on NotScaledReason.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#notScaledReasons(java.util.Collection)