Interface ScalingPlanResource.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ScalingPlanResource.Builder,
,ScalingPlanResource> SdkBuilder<ScalingPlanResource.Builder,
,ScalingPlanResource> SdkPojo
- Enclosing class:
ScalingPlanResource
-
Method Summary
Modifier and TypeMethodDescriptionresourceId
(String resourceId) The ID of the resource.scalableDimension
(String scalableDimension) The scalable dimension for the resource.scalableDimension
(ScalableDimension scalableDimension) The scalable dimension for the resource.scalingPlanName
(String scalingPlanName) The name of the scaling plan.scalingPlanVersion
(Long scalingPlanVersion) The version number of the scaling plan.scalingPolicies
(Collection<ScalingPolicy> scalingPolicies) The scaling policies.scalingPolicies
(Consumer<ScalingPolicy.Builder>... scalingPolicies) The scaling policies.scalingPolicies
(ScalingPolicy... scalingPolicies) The scaling policies.scalingStatusCode
(String scalingStatusCode) The scaling status of the resource.scalingStatusCode
(ScalingStatusCode scalingStatusCode) The scaling status of the resource.scalingStatusMessage
(String scalingStatusMessage) A simple message about the current scaling status of the resource.serviceNamespace
(String serviceNamespace) The namespace of the AWS service.serviceNamespace
(ServiceNamespace serviceNamespace) The namespace of the AWS service.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
scalingPlanName
The name of the scaling plan.
- Parameters:
scalingPlanName
- The name of the scaling plan.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingPlanVersion
The version number of the scaling plan.
- Parameters:
scalingPlanVersion
- The version number of the scaling plan.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceNamespace
The namespace of the AWS service.
- Parameters:
serviceNamespace
- The namespace of the AWS service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceNamespace
The namespace of the AWS service.
- Parameters:
serviceNamespace
- The namespace of the AWS service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.
- Parameters:
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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
scalingPolicies
The scaling policies.
- Parameters:
scalingPolicies
- The scaling policies.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingPolicies
The scaling policies.
- Parameters:
scalingPolicies
- The scaling policies.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalingPolicies
The scaling policies.
This is a convenience method that creates an instance of theScalingPolicy.Builder
avoiding the need to create one manually viaScalingPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscalingPolicies(List<ScalingPolicy>)
.- Parameters:
scalingPolicies
- a consumer that will call methods onScalingPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
scalingStatusMessage
A simple message about the current scaling status of the resource.
- Parameters:
scalingStatusMessage
- A simple message about the current scaling status of the resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-