Synopsis
Calls the Application Auto Scaling RegisterScalableTarget API operation.
Syntax
Add-AASScalableTarget-ServiceNamespace <ServiceNamespace>-MaxCapacity <Int32>-MinCapacity <Int32>-ResourceId <String>-RoleARN <String>-ScalableDimension <ScalableDimension>-PassThru <SwitchParameter>-Force <SwitchParameter>
Description
Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.
After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it using DeregisterScalableTarget.
Parameters
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MaxCapacity <Int32>
The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-MinCapacity <Int32>
The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-PassThru <SwitchParameter>
Returns the value passed to the ServiceNamespace parameter. By default, this cmdlet does not generate any output.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ResourceId <String>
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
- ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. - Spot fleet request - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. - DynamoDB table - The resource type is
tableand the unique identifier is the resource ID. Example:table/my-table. - DynamoDB global secondary index - The resource type is
indexand the unique identifier is the resource ID. Example:table/my-table/index/my-table-index. - Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. - Amazon SageMaker endpoint variants - The resource type is
variantand 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
OutputValuefrom the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RoleARN <String>
Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ScalableDimension <ScalableDimension>
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount- The desired task count of an ECS service.ec2:spot-fleet-request:TargetCapacity- The target capacity of a Spot fleet request.elasticmapreduce:instancegroup:InstanceCount- The instance count of an EMR Instance Group.appstream:fleet:DesiredCapacity- The desired capacity of an AppStream 2.0 fleet.dynamodb:table:ReadCapacityUnits- The provisioned read capacity for a DynamoDB table.dynamodb:table:WriteCapacityUnits- The provisioned write capacity for a DynamoDB table.dynamodb:index:ReadCapacityUnits- The provisioned read capacity for a DynamoDB global secondary index.dynamodb:index:WriteCapacityUnits- The provisioned write capacity for a DynamoDB global secondary index.rds:cluster:ReadReplicaCount- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.sagemaker:variant:DesiredInstanceCount- The number of EC2 instances for an Amazon SageMaker model endpoint variant.custom-resource:ResourceType:Property- The scalable dimension for a custom resource provided by your own application or service.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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. | Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ) |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
You can pipe a ServiceNamespace object to this cmdlet for the ServiceNamespace parameter.
Outputs
None or Amazon.ApplicationAutoScaling.ServiceNamespace
When you use the PassThru parameter, this cmdlet outputs the value supplied to the ServiceNamespace parameter. Otherwise, this cmdlet does not return any output. The service response (type Amazon.ApplicationAutoScaling.Model.RegisterScalableTargetResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
