All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.applicationautoscaling.model.ScalingPolicy Maven / Gradle / Ivy

/*
 * Copyright 2011-2016 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;

/**
 * 

* Represents a scaling policy. *

*/ public class ScalingPolicy implements Serializable, Cloneable { /** *

* The Amazon Resource Name (ARN) of the scaling policy. *

*/ private String policyARN; /** *

* The name of the scaling policy. *

*/ private String policyName; /** *

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

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

    *
  • *
*/ private String scalableDimension; /** *

* The scaling policy type. *

*/ private String policyType; /** *

* The configuration for the step scaling policy. *

*/ private StepScalingPolicyConfiguration stepScalingPolicyConfiguration; /** *

* The CloudWatch alarms associated with the scaling policy. *

*/ private java.util.List alarms; /** *

* The Unix timestamp for when the scaling policy was created. *

*/ private java.util.Date creationTime; /** *

* The Amazon Resource Name (ARN) of the scaling policy. *

* * @param policyARN * The Amazon Resource Name (ARN) of the scaling policy. */ public void setPolicyARN(String policyARN) { this.policyARN = policyARN; } /** *

* The Amazon Resource Name (ARN) of the scaling policy. *

* * @return The Amazon Resource Name (ARN) of the scaling policy. */ public String getPolicyARN() { return this.policyARN; } /** *

* The Amazon Resource Name (ARN) of the scaling policy. *

* * @param policyARN * The Amazon Resource Name (ARN) of the scaling policy. * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy withPolicyARN(String policyARN) { setPolicyARN(policyARN); return this; } /** *

* 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 ScalingPolicy withPolicyName(String policyName) { setPolicyName(policyName); return this; } /** *

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

* * @param serviceNamespace * The namespace of the AWS 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. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. *

* * @return The namespace of the AWS 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. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. *

* * @param serviceNamespace * The namespace of the AWS 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 ScalingPolicy withServiceNamespace(String serviceNamespace) { setServiceNamespace(serviceNamespace); return this; } /** *

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

* * @param serviceNamespace * The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference. * @see ServiceNamespace */ public void setServiceNamespace(ServiceNamespace serviceNamespace) { this.serviceNamespace = serviceNamespace.toString(); } /** *

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

* * @param serviceNamespace * The namespace of the AWS 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 ScalingPolicy withServiceNamespace(ServiceNamespace serviceNamespace) { setServiceNamespace(serviceNamespace); 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. *

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

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

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

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

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

        *
      • * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy 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. *

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

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

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

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

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

              *
            • * @return Returns a reference to this object so that method calls can be chained together. * @see ScalableDimension */ public ScalingPolicy 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. *

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

                *
              • * @see ScalableDimension */ public void setScalableDimension(ScalableDimension scalableDimension) { this.scalableDimension = scalableDimension.toString(); } /** *

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

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

                  *
                • * @return Returns a reference to this object so that method calls can be chained together. * @see ScalableDimension */ public ScalingPolicy withScalableDimension(ScalableDimension scalableDimension) { setScalableDimension(scalableDimension); return this; } /** *

                  * The scaling policy type. *

                  * * @param policyType * The scaling policy type. * @see PolicyType */ public void setPolicyType(String policyType) { this.policyType = policyType; } /** *

                  * The scaling policy type. *

                  * * @return The scaling policy type. * @see PolicyType */ public String getPolicyType() { return this.policyType; } /** *

                  * The scaling policy type. *

                  * * @param policyType * The scaling policy type. * @return Returns a reference to this object so that method calls can be chained together. * @see PolicyType */ public ScalingPolicy withPolicyType(String policyType) { setPolicyType(policyType); return this; } /** *

                  * The scaling policy type. *

                  * * @param policyType * The scaling policy type. * @see PolicyType */ public void setPolicyType(PolicyType policyType) { this.policyType = policyType.toString(); } /** *

                  * The scaling policy type. *

                  * * @param policyType * The scaling policy type. * @return Returns a reference to this object so that method calls can be chained together. * @see PolicyType */ public ScalingPolicy withPolicyType(PolicyType policyType) { setPolicyType(policyType); return this; } /** *

                  * The configuration for the step scaling policy. *

                  * * @param stepScalingPolicyConfiguration * The configuration for the step scaling policy. */ public void setStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration) { this.stepScalingPolicyConfiguration = stepScalingPolicyConfiguration; } /** *

                  * The configuration for the step scaling policy. *

                  * * @return The configuration for the step scaling policy. */ public StepScalingPolicyConfiguration getStepScalingPolicyConfiguration() { return this.stepScalingPolicyConfiguration; } /** *

                  * The configuration for the step scaling policy. *

                  * * @param stepScalingPolicyConfiguration * The configuration for the step scaling policy. * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy withStepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration) { setStepScalingPolicyConfiguration(stepScalingPolicyConfiguration); return this; } /** *

                  * The CloudWatch alarms associated with the scaling policy. *

                  * * @return The CloudWatch alarms associated with the scaling policy. */ public java.util.List getAlarms() { return alarms; } /** *

                  * The CloudWatch alarms associated with the scaling policy. *

                  * * @param alarms * The CloudWatch alarms associated with the scaling policy. */ public void setAlarms(java.util.Collection alarms) { if (alarms == null) { this.alarms = null; return; } this.alarms = new java.util.ArrayList(alarms); } /** *

                  * The CloudWatch alarms associated with the scaling policy. *

                  *

                  * NOTE: This method appends the values to the existing list (if any). Use * {@link #setAlarms(java.util.Collection)} or {@link #withAlarms(java.util.Collection)} if you want to override the * existing values. *

                  * * @param alarms * The CloudWatch alarms associated with the scaling policy. * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy withAlarms(Alarm... alarms) { if (this.alarms == null) { setAlarms(new java.util.ArrayList(alarms.length)); } for (Alarm ele : alarms) { this.alarms.add(ele); } return this; } /** *

                  * The CloudWatch alarms associated with the scaling policy. *

                  * * @param alarms * The CloudWatch alarms associated with the scaling policy. * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy withAlarms(java.util.Collection alarms) { setAlarms(alarms); return this; } /** *

                  * The Unix timestamp for when the scaling policy was created. *

                  * * @param creationTime * The Unix timestamp for when the scaling policy was created. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** *

                  * The Unix timestamp for when the scaling policy was created. *

                  * * @return The Unix timestamp for when the scaling policy was created. */ public java.util.Date getCreationTime() { return this.creationTime; } /** *

                  * The Unix timestamp for when the scaling policy was created. *

                  * * @param creationTime * The Unix timestamp for when the scaling policy was created. * @return Returns a reference to this object so that method calls can be chained together. */ public ScalingPolicy withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** * Returns a string representation of this object; useful for testing and debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPolicyARN() != null) sb.append("PolicyARN: ").append(getPolicyARN()).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 (getAlarms() != null) sb.append("Alarms: ").append(getAlarms()).append(","); if (getCreationTime() != null) sb.append("CreationTime: ").append(getCreationTime()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ScalingPolicy == false) return false; ScalingPolicy other = (ScalingPolicy) obj; if (other.getPolicyARN() == null ^ this.getPolicyARN() == null) return false; if (other.getPolicyARN() != null && other.getPolicyARN().equals(this.getPolicyARN()) == false) return false; 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.getAlarms() == null ^ this.getAlarms() == null) return false; if (other.getAlarms() != null && other.getAlarms().equals(this.getAlarms()) == false) return false; if (other.getCreationTime() == null ^ this.getCreationTime() == null) return false; if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPolicyARN() == null) ? 0 : getPolicyARN().hashCode()); 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 + ((getAlarms() == null) ? 0 : getAlarms().hashCode()); hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode()); return hashCode; } @Override public ScalingPolicy clone() { try { return (ScalingPolicy) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy