software.amazon.awssdk.services.applicationautoscaling.model

Interface PutScalingPolicyRequest.Builder

All Superinterfaces:

ApplicationAutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutScalingPolicyRequest

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

Method Summary

Modifier and Type	Method and Description
PutScalingPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutScalingPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutScalingPolicyRequest.Builder	policyName(String policyName) The name of the scaling policy.
PutScalingPolicyRequest.Builder	policyType(PolicyType policyType) The policy type.
PutScalingPolicyRequest.Builder	policyType(String policyType) The policy type.
PutScalingPolicyRequest.Builder	resourceId(String resourceId) The identifier of the resource associated with the scaling policy.
PutScalingPolicyRequest.Builder	scalableDimension(ScalableDimension scalableDimension) The scalable dimension.
PutScalingPolicyRequest.Builder	scalableDimension(String scalableDimension) The scalable dimension.
PutScalingPolicyRequest.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.
PutScalingPolicyRequest.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.
default PutScalingPolicyRequest.Builder	stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration) A step scaling policy.
PutScalingPolicyRequest.Builder	stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration) A step scaling policy.
default PutScalingPolicyRequest.Builder	targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration) A target tracking policy.
PutScalingPolicyRequest.Builder	targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration) A target tracking policy.

Methods inherited from interface software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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

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

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.

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

• 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

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.

• 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

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.

• 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

policyType

PutScalingPolicyRequest.Builder policyType(String policyType)

The policy type. This parameter is required if you are creating a policy.

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported.

Parameters:

policyType - The policy type. This parameter is required if you are creating a policy.

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are 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

policyType

PutScalingPolicyRequest.Builder policyType(PolicyType policyType)

The policy type. This parameter is required if you are creating a policy.

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are supported. For any other service, only StepScaling is supported.

Parameters:

policyType - The policy type. This parameter is required if you are creating a policy.

For DynamoDB, only TargetTrackingScaling is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both StepScaling and TargetTrackingScaling are 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

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.

stepScalingPolicyConfiguration

default PutScalingPolicyRequest.Builder stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration)

A step scaling policy.

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

This is a convenience that creates an instance of the StepScalingPolicyConfiguration.Builder avoiding the need to create one manually via StepScalingPolicyConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stepScalingPolicyConfiguration(StepScalingPolicyConfiguration).

Parameters:

stepScalingPolicyConfiguration - a consumer that will call methods on StepScalingPolicyConfiguration.Builder

Returns:

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

See Also:

stepScalingPolicyConfiguration(StepScalingPolicyConfiguration)

targetTrackingScalingPolicyConfiguration

PutScalingPolicyRequest.Builder targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)

A target tracking policy.

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

Parameters:

targetTrackingScalingPolicyConfiguration - A target tracking policy.

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

Returns:

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

targetTrackingScalingPolicyConfiguration

default PutScalingPolicyRequest.Builder targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration)

A target tracking policy.

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

This is a convenience that creates an instance of the TargetTrackingScalingPolicyConfiguration.Builder avoiding the need to create one manually via TargetTrackingScalingPolicyConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration).

Parameters:

targetTrackingScalingPolicyConfiguration - a consumer that will call methods on TargetTrackingScalingPolicyConfiguration.Builder

Returns:

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

See Also:

targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration)

overrideConfiguration

PutScalingPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PutScalingPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.