PutScalingPolicyRequest (AWS Java SDK :: Services :: AWS Application Auto Scaling 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingRequest
    - - software.amazon.awssdk.services.applicationautoscaling.model.PutScalingPolicyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PutScalingPolicyRequest
extends ApplicationAutoScalingRequest
implements ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutScalingPolicyRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutScalingPolicyRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PutScalingPolicyRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`policyName()` The name of the scaling policy.
`PolicyType`	`policyType()` The policy type.
`String`	`policyTypeAsString()` The policy type.
`String`	`resourceId()` The identifier of the resource associated with the scaling policy.
`ScalableDimension`	`scalableDimension()` The scalable dimension.
`String`	`scalableDimensionAsString()` The scalable dimension.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutScalingPolicyRequest.Builder>`	`serializableBuilderClass()`
`ServiceNamespace`	`serviceNamespace()` The namespace of the AWS service that provides the resource.
`String`	`serviceNamespaceAsString()` The namespace of the AWS service that provides the resource.
`StepScalingPolicyConfiguration`	`stepScalingPolicyConfiguration()` A step scaling policy.
`TargetTrackingScalingPolicyConfiguration`	`targetTrackingScalingPolicyConfiguration()` A target tracking scaling policy.
`PutScalingPolicyRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - policyName
```
public final String policyName()
```
    The name of the scaling policy.
    
    Returns:
    
    The name of the scaling policy.
  - serviceNamespace
```
public final ServiceNamespace serviceNamespace()
```
    The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
    
    If the service returns an enum value that is not available in the current SDK version, serviceNamespace will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
    
    See Also:
    
    ServiceNamespace
  - serviceNamespaceAsString
```
public final String serviceNamespaceAsString()
```
    The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
    
    If the service returns an enum value that is not available in the current SDK version, serviceNamespace will return ServiceNamespace.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceNamespaceAsString().
    
    Returns:
    
    The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
    
    See Also:
    
    ServiceNamespace
  - resourceId
```
public final 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 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.
    - Amazon 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.
    Returns:
    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 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.
    
    Amazon 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 .
  - scalableDimension
```
public final 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 and Aurora PostgreSQL-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.
    - 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.
    If the service returns an enum value that is not available in the current SDK version, scalableDimension will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().
    Returns:
    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 and Aurora PostgreSQL-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.
    
    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.
    See Also:
    
    ScalableDimension
  - scalableDimensionAsString
```
public final String scalableDimensionAsString()
```
    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 and Aurora PostgreSQL-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.
    - 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.
    If the service returns an enum value that is not available in the current SDK version, scalableDimension will return ScalableDimension.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalableDimensionAsString().
    Returns:
    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 and Aurora PostgreSQL-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.
    
    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.
    See Also:
    
    ScalableDimension
  - policyType
```
public final PolicyType policyType()
```
    The policy type. This parameter is required if you are creating a scaling policy.
    
    The following policy types are supported:
    
    TargetTrackingScaling—Not supported for Amazon EMR
    
    StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.
    
    For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    The policy type. This parameter is required if you are creating a scaling policy.
    
    The following policy types are supported:
    
    TargetTrackingScaling—Not supported for Amazon EMR
    
    StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.
    
    For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
    
    See Also:
    
    PolicyType
  - policyTypeAsString
```
public final String policyTypeAsString()
```
    The policy type. This parameter is required if you are creating a scaling policy.
    
    The following policy types are supported:
    
    TargetTrackingScaling—Not supported for Amazon EMR
    
    StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.
    
    For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    The policy type. This parameter is required if you are creating a scaling policy.
    
    The following policy types are supported:
    
    TargetTrackingScaling—Not supported for Amazon EMR
    
    StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.
    
    For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
    
    See Also:
    
    PolicyType
  - stepScalingPolicyConfiguration
```
public final StepScalingPolicyConfiguration stepScalingPolicyConfiguration()
```
    A step scaling policy.
    
    This parameter is required if you are creating a policy and the policy type is StepScaling.
    
    Returns:
    
    A step scaling policy.
    
    This parameter is required if you are creating a policy and the policy type is StepScaling.
  - targetTrackingScalingPolicyConfiguration
```
public final TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration()
```
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling .
    
    Returns:
    
    A target tracking scaling policy. Includes support for predefined or customized metrics.
    
    This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling.
  - toBuilder
```
public PutScalingPolicyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
    
    Specified by:
    
    toBuilder in class ApplicationAutoScalingRequest
  - builder
```
public static PutScalingPolicyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutScalingPolicyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutScalingPolicyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

policyName

serviceNamespace

serviceNamespaceAsString

resourceId

scalableDimension

scalableDimensionAsString

policyType

policyTypeAsString

stepScalingPolicyConfiguration

targetTrackingScalingPolicyConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields