Package software.amazon.awssdk.services.applicationautoscaling.model

Interface PutScalingPolicyRequest.Builder

All Superinterfaces:

CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Enclosing class:

PutScalingPolicyRequest

public static interface PutScalingPolicyRequest.Builder
extends CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Method Summary

Modifier and Type	Method	Description
PutScalingPolicyRequest.Builder	policyName(String policyName)	The name of the scaling policy.
PutScalingPolicyRequest.Builder	policyType(String policyType)	The policy type.
PutScalingPolicyRequest.Builder	policyType(PolicyType policyType)	The policy type.
PutScalingPolicyRequest.Builder	resourceId(String resourceId)	The identifier of the resource associated with the scaling policy.
PutScalingPolicyRequest.Builder	scalableDimension(String scalableDimension)	The scalable dimension.
PutScalingPolicyRequest.Builder	scalableDimension(ScalableDimension scalableDimension)	The scalable dimension.
PutScalingPolicyRequest.Builder	serviceNamespace(String serviceNamespace)	The namespace of the AWS service.
PutScalingPolicyRequest.Builder	serviceNamespace(ServiceNamespace serviceNamespace)	The namespace of the AWS service.
PutScalingPolicyRequest.Builder	stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)	A step scaling policy.
PutScalingPolicyRequest.Builder	targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)	A target tracking policy.

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

copy

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

apply, build

Method Detail

policyName

PutScalingPolicyRequest.Builder policyName(String policyName)

The name of the scaling policy.

Parameters:

policyName - The name of the scaling policy.

Returns:

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

serviceNamespace

PutScalingPolicyRequest.Builder serviceNamespace(String serviceNamespace)

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace of the AWS 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

PutScalingPolicyRequest.Builder serviceNamespace(ServiceNamespace serviceNamespace)

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Parameters:

serviceNamespace - The namespace of the AWS 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

resourceId

PutScalingPolicyRequest.Builder resourceId(String resourceId)

The identifier of the resource associated with the scaling policy. 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.

Parameters:

resourceId - The identifier of the resource associated with the scaling policy. 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.

Returns:

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

scalableDimension

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

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.

Returns:

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

See Also:

ScalableDimension

scalableDimension

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

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.

Returns:

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

See Also:

ScalableDimension

policyType

PutScalingPolicyRequest.Builder policyType(String policyType)

The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

Parameters:

policyType - The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

Returns:

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

See Also:

PolicyType

policyType

PutScalingPolicyRequest.Builder policyType(PolicyType policyType)

The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

Parameters:

policyType - The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

Returns:

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

See Also:

PolicyType

stepScalingPolicyConfiguration

PutScalingPolicyRequest.Builder stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)

A step scaling policy.

This parameter is required if you are creating a policy and the policy type is StepScaling.

Parameters:

stepScalingPolicyConfiguration - A step scaling policy.

This parameter is required if you are creating a policy and the policy type is StepScaling.

Returns:

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

targetTrackingScalingPolicyConfiguration

PutScalingPolicyRequest.Builder targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)

A target tracking policy.

This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

Parameters:

targetTrackingScalingPolicyConfiguration - A target tracking policy.

This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

Returns:

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