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

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

Parameters:

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.

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

Parameters:

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.

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

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 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:

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.

• 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.

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.

• 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.

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.

• 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.

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.

• 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.

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.