com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-applicationautoscaling Show documentation
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.applicationautoscaling.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PutScalingPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the scaling policy.
*
*/
private String policyName;
/**
*
* 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.
*
*/
private String serviceNamespace;
/**
*
* 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. More information is available in our GitHub repository.
*
*
*
*/
private String resourceId;
/**
*
* 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.
*
*
*
*/
private String scalableDimension;
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*/
private String policyType;
/**
*
* A step scaling policy.
*
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*
*/
private StepScalingPolicyConfiguration stepScalingPolicyConfiguration;
/**
*
* 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
* .
*
*/
private TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration;
/**
*
* The name of the scaling policy.
*
*
* @param policyName
* The name of the scaling policy.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
*
* The name of the scaling policy.
*
*
* @return The name of the scaling policy.
*/
public String getPolicyName() {
return this.policyName;
}
/**
*
* The name of the scaling policy.
*
*
* @param policyName
* The name of the scaling policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutScalingPolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see ServiceNamespace
*/
public void setServiceNamespace(String serviceNamespace) {
this.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.
*
*
* @return 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.
* @see ServiceNamespace
*/
public String getServiceNamespace() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public PutScalingPolicyRequest withServiceNamespace(String serviceNamespace) {
setServiceNamespace(serviceNamespace);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see ServiceNamespace
*/
public void setServiceNamespace(ServiceNamespace serviceNamespace) {
withServiceNamespace(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServiceNamespace
*/
public PutScalingPolicyRequest withServiceNamespace(ServiceNamespace serviceNamespace) {
this.serviceNamespace = serviceNamespace.toString();
return this;
}
/**
*
* 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. More information is available in our GitHub repository.
*
*
*
*
* @param 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. More information is available in our GitHub repository.
*
*
*/
public void setResourceId(String resourceId) {
this.resourceId = 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. More information is available in our GitHub repository.
*
*
*
*
* @return 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. More information is available in our GitHub repository.
*
*
*/
public String getResourceId() {
return this.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. More information is available in our GitHub repository.
*
*
*
*
* @param 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. More information is available in our GitHub repository.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutScalingPolicyRequest withResourceId(String resourceId) {
setResourceId(resourceId);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see ScalableDimension
*/
public void setScalableDimension(String scalableDimension) {
this.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.
*
*
*
*
* @return 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.
*
*
* @see ScalableDimension
*/
public String getScalableDimension() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public PutScalingPolicyRequest withScalableDimension(String scalableDimension) {
setScalableDimension(scalableDimension);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see ScalableDimension
*/
public void setScalableDimension(ScalableDimension scalableDimension) {
withScalableDimension(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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScalableDimension
*/
public PutScalingPolicyRequest withScalableDimension(ScalableDimension scalableDimension) {
this.scalableDimension = scalableDimension.toString();
return this;
}
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*
* @param policyType
* The policy type. This parameter is required if you are creating a scaling policy.
*
* For information on which services do not support StepScaling or
* TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
* @see PolicyType
*/
public void setPolicyType(String policyType) {
this.policyType = policyType;
}
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*
* @return The policy type. This parameter is required if you are creating a scaling policy.
*
* For information on which services do not support StepScaling or
* TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
* @see PolicyType
*/
public String getPolicyType() {
return this.policyType;
}
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*
* @param policyType
* The policy type. This parameter is required if you are creating a scaling policy.
*
* For information on which services do not support StepScaling or
* TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public PutScalingPolicyRequest withPolicyType(String policyType) {
setPolicyType(policyType);
return this;
}
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*
* @param policyType
* The policy type. This parameter is required if you are creating a scaling policy.
*
* For information on which services do not support StepScaling or
* TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
* @see PolicyType
*/
public void setPolicyType(PolicyType policyType) {
withPolicyType(policyType);
}
/**
*
* The policy type. This parameter is required if you are creating a scaling policy.
*
*
* For information on which services do not support StepScaling or TargetTrackingScaling,
* see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
*
*
* @param policyType
* The policy type. This parameter is required if you are creating a scaling policy.
*
* For information on which services do not support StepScaling or
* TargetTrackingScaling, see the information about Limits in Step Scaling Policies and Target Tracking Scaling Policies in the Application Auto Scaling User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public PutScalingPolicyRequest withPolicyType(PolicyType policyType) {
this.policyType = policyType.toString();
return this;
}
/**
*
* A step scaling policy.
*
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*
*
* @param stepScalingPolicyConfiguration
* A step scaling policy.
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*/
public void setStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration) {
this.stepScalingPolicyConfiguration = stepScalingPolicyConfiguration;
}
/**
*
* A step scaling policy.
*
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*
*
* @return A step scaling policy.
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*/
public StepScalingPolicyConfiguration getStepScalingPolicyConfiguration() {
return this.stepScalingPolicyConfiguration;
}
/**
*
* A step scaling policy.
*
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
*
*
* @param stepScalingPolicyConfiguration
* A step scaling policy.
*
* This parameter is required if you are creating a policy and the policy type is StepScaling.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutScalingPolicyRequest withStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration) {
setStepScalingPolicyConfiguration(stepScalingPolicyConfiguration);
return this;
}
/**
*
* 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
* .
*
*
* @param 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.
*/
public void setTargetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration) {
this.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
* .
*
*
* @return 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.
*/
public TargetTrackingScalingPolicyConfiguration getTargetTrackingScalingPolicyConfiguration() {
return this.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
* .
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutScalingPolicyRequest withTargetTrackingScalingPolicyConfiguration(
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration) {
setTargetTrackingScalingPolicyConfiguration(targetTrackingScalingPolicyConfiguration);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getPolicyName() != null)
sb.append("PolicyName: ").append(getPolicyName()).append(",");
if (getServiceNamespace() != null)
sb.append("ServiceNamespace: ").append(getServiceNamespace()).append(",");
if (getResourceId() != null)
sb.append("ResourceId: ").append(getResourceId()).append(",");
if (getScalableDimension() != null)
sb.append("ScalableDimension: ").append(getScalableDimension()).append(",");
if (getPolicyType() != null)
sb.append("PolicyType: ").append(getPolicyType()).append(",");
if (getStepScalingPolicyConfiguration() != null)
sb.append("StepScalingPolicyConfiguration: ").append(getStepScalingPolicyConfiguration()).append(",");
if (getTargetTrackingScalingPolicyConfiguration() != null)
sb.append("TargetTrackingScalingPolicyConfiguration: ").append(getTargetTrackingScalingPolicyConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutScalingPolicyRequest == false)
return false;
PutScalingPolicyRequest other = (PutScalingPolicyRequest) obj;
if (other.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getServiceNamespace() == null ^ this.getServiceNamespace() == null)
return false;
if (other.getServiceNamespace() != null && other.getServiceNamespace().equals(this.getServiceNamespace()) == false)
return false;
if (other.getResourceId() == null ^ this.getResourceId() == null)
return false;
if (other.getResourceId() != null && other.getResourceId().equals(this.getResourceId()) == false)
return false;
if (other.getScalableDimension() == null ^ this.getScalableDimension() == null)
return false;
if (other.getScalableDimension() != null && other.getScalableDimension().equals(this.getScalableDimension()) == false)
return false;
if (other.getPolicyType() == null ^ this.getPolicyType() == null)
return false;
if (other.getPolicyType() != null && other.getPolicyType().equals(this.getPolicyType()) == false)
return false;
if (other.getStepScalingPolicyConfiguration() == null ^ this.getStepScalingPolicyConfiguration() == null)
return false;
if (other.getStepScalingPolicyConfiguration() != null
&& other.getStepScalingPolicyConfiguration().equals(this.getStepScalingPolicyConfiguration()) == false)
return false;
if (other.getTargetTrackingScalingPolicyConfiguration() == null ^ this.getTargetTrackingScalingPolicyConfiguration() == null)
return false;
if (other.getTargetTrackingScalingPolicyConfiguration() != null
&& other.getTargetTrackingScalingPolicyConfiguration().equals(this.getTargetTrackingScalingPolicyConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode + ((getServiceNamespace() == null) ? 0 : getServiceNamespace().hashCode());
hashCode = prime * hashCode + ((getResourceId() == null) ? 0 : getResourceId().hashCode());
hashCode = prime * hashCode + ((getScalableDimension() == null) ? 0 : getScalableDimension().hashCode());
hashCode = prime * hashCode + ((getPolicyType() == null) ? 0 : getPolicyType().hashCode());
hashCode = prime * hashCode + ((getStepScalingPolicyConfiguration() == null) ? 0 : getStepScalingPolicyConfiguration().hashCode());
hashCode = prime * hashCode + ((getTargetTrackingScalingPolicyConfiguration() == null) ? 0 : getTargetTrackingScalingPolicyConfiguration().hashCode());
return hashCode;
}
@Override
public PutScalingPolicyRequest clone() {
return (PutScalingPolicyRequest) super.clone();
}
}