/* * Copyright 2018-2023 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 RegisterScalableTargetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

*/ private String serviceNamespace; /** *

* The identifier of the resource that is associated with the scalable target. This string consists of the resource * type and unique identifier. *

* */ private String resourceId; /** *

* The scalable dimension associated with the scalable target. This string consists of the service namespace, * resource type, and scaling property. *

* */ private String scalableDimension; /** *

* The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can * scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is * required when registering a new scalable target. *

*

* For the following resources, the minimum value allowed is 0. *

* *

* It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points * are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU * utilization. *

*

* For all other resources, the minimum allowed value depends on the type of resource that you are using. If you * provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message * will provide the minimum value that the resource can accept. *

*/ private Integer minCapacity; /** *

* The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can * scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is * required when registering a new scalable target. *

*

* Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each * service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher * limit, you can request an increase. For more information, consult the documentation for that service. For * information about the default quotas for each service, see Service endpoints and * quotas in the Amazon Web Services General Reference. *

*/ private Integer maxCapacity; /** *

* This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it * must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your * behalf. *

*

* If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it * creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles. *

*/ private String roleARN; /** *

* An embedded object that contains attributes and attribute values that are used to suspend and resume automatic * scaling. Setting the value of an attribute to true suspends the specified scaling activities. * Setting it to false (default) resumes the specified scaling activities. *

*

* Suspension Outcomes *

* *

* For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide. *

*/ private SuspendedState suspendedState; /** *

* Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is * created. To tag an existing scalable target, use the TagResource operation. *

*

* Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have * more than one tag on a scalable target with the same tag key. *

*

* Use tags to control access to a scalable target. For more information, see Tagging * support for Application Auto Scaling in the Application Auto Scaling User Guide. *

*/ private java.util.Map tags; /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

* * @param serviceNamespace * The namespace of the Amazon Web Services service that provides the resource. For a resource provided by * your own application or service, use custom-resource instead. * @see ServiceNamespace */ public void setServiceNamespace(String serviceNamespace) { this.serviceNamespace = serviceNamespace; } /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

* * @return The namespace of the Amazon Web Services service that provides the resource. For a resource provided by * your own application or service, use custom-resource instead. * @see ServiceNamespace */ public String getServiceNamespace() { return this.serviceNamespace; } /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

* * @param serviceNamespace * The namespace of the Amazon Web Services service that provides the resource. For a resource provided by * your own application or service, use custom-resource instead. * @return Returns a reference to this object so that method calls can be chained together. * @see ServiceNamespace */ public RegisterScalableTargetRequest withServiceNamespace(String serviceNamespace) { setServiceNamespace(serviceNamespace); return this; } /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

* * @param serviceNamespace * The namespace of the Amazon Web Services service that provides the resource. For a resource provided by * your own application or service, use custom-resource instead. * @see ServiceNamespace */ public void setServiceNamespace(ServiceNamespace serviceNamespace) { withServiceNamespace(serviceNamespace); } /** *

* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own * application or service, use custom-resource instead. *

* * @param serviceNamespace * The namespace of the Amazon Web Services service that provides the resource. For a resource provided by * your own application or service, use custom-resource instead. * @return Returns a reference to this object so that method calls can be chained together. * @see ServiceNamespace */ public RegisterScalableTargetRequest withServiceNamespace(ServiceNamespace serviceNamespace) { this.serviceNamespace = serviceNamespace.toString(); return this; } /** *

* The identifier of the resource that is associated with the scalable target. This string consists of the resource * type and unique identifier. *

* * * @param resourceId * The identifier of the resource that is associated with the scalable target. This string consists of the * resource type and unique identifier.

*