NAME

Paws::ApplicationAutoScaling::PutScalingPolicy - Arguments for method PutScalingPolicy on Paws::ApplicationAutoScaling

DESCRIPTION

This class represents the parameters used for calling the method PutScalingPolicy on the Application Auto Scaling service. Use the attributes of this class as arguments to method PutScalingPolicy.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScalingPolicy.

SYNOPSIS

    my $application-autoscaling = Paws->service('ApplicationAutoScaling');
 # To apply a scaling policy to an Amazon ECS service
 # This example applies a scaling policy to an Amazon ECS service called web-app
 # in the default cluster. The policy increases the desired count of the service
 # by 200%, with a cool down period of 60 seconds.
    my $PutScalingPolicyResponse = $application -autoscaling->PutScalingPolicy(
      'PolicyName'                     => 'web-app-cpu-gt-75',
      'PolicyType'                     => 'StepScaling',
      'ResourceId'                     => 'service/default/web-app',
      'ScalableDimension'              => 'ecs:service:DesiredCount',
      'ServiceNamespace'               => 'ecs',
      'StepScalingPolicyConfiguration' => {
        'AdjustmentType'  => 'PercentChangeInCapacity',
        'Cooldown'        => 60,
        'StepAdjustments' => [
          {
            'MetricIntervalLowerBound' => 0,
            'ScalingAdjustment'        => 200
          }
        ]
      }
    );
    # Results:
    my $PolicyARN = $PutScalingPolicyResponse->PolicyARN;
 # Returns a L<Paws::ApplicationAutoScaling::PutScalingPolicyResponse> object.
 # To apply a scaling policy to an Amazon EC2 Spot fleet
 # This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy
 # increases the target capacity of the spot fleet by 200%, with a cool down
 # period of 180 seconds.",
    my $PutScalingPolicyResponse = $application -autoscaling->PutScalingPolicy(
      'PolicyName' => 'fleet-cpu-gt-75',
      'PolicyType' => 'StepScaling',
      'ResourceId' =>
        'spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3',
      'ScalableDimension' => 'ec2:spot-fleet-request:TargetCapacity',
      'ServiceNamespace'  => 'ec2',
      'StepScalingPolicyConfiguration' => {
        'AdjustmentType'  => 'PercentChangeInCapacity',
        'Cooldown'        => 180,
        'StepAdjustments' => [
          {
            'MetricIntervalLowerBound' => 0,
            'ScalingAdjustment'        => 200
          }
        ]
      }
    );
    # Results:
    my $PolicyARN = $PutScalingPolicyResponse->PolicyARN;
   # Returns a L<Paws::ApplicationAutoScaling::PutScalingPolicyResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling/PutScalingPolicy>

ATTRIBUTES

REQUIRED PolicyName => Str

The name of the scaling policy.

PolicyType => Str

The policy type. This parameter is required if you are creating a scaling policy.

The following policy types are supported:

"TargetTrackingScaling"—Not supported for Amazon EMR

"StepScaling"—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache Cassandra), or Amazon MSK.

For more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the Application Auto Scaling User Guide.

Valid values are: "StepScaling", "TargetTrackingScaling"

REQUIRED ResourceId => Str

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

ECS service - The resource type is "service" and the unique identifier is the cluster name and service name. Example: "service/default/sample-webapp".
Spot Fleet request - The resource type is "spot-fleet-request" and the unique identifier is the Spot Fleet request ID. Example: "spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE".
EMR cluster - The resource type is "instancegroup" and the unique identifier is the cluster ID and instance group ID. Example: "instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0".
AppStream 2.0 fleet - The resource type is "fleet" and the unique identifier is the fleet name. Example: "fleet/sample-fleet".
DynamoDB table - The resource type is "table" and the unique identifier is the table name. Example: "table/my-table".
DynamoDB global secondary index - The resource type is "index" and the unique identifier is the index name. Example: "table/my-table/index/my-table-index".
Aurora DB cluster - The resource type is "cluster" and the unique identifier is the cluster name. Example: "cluster:my-db-cluster".
Amazon SageMaker endpoint variant - The resource type is "variant" and the unique identifier is the resource ID. Example: "endpoint/my-end-point/variant/KMeansClustering".
Custom resources are not supported with a resource type. This parameter must specify the "OutputValue" from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: "arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE".
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: "arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE".
Lambda provisioned concurrency - The resource type is "function" and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: "function:my-function:prod" or "function:my-function:1".
Amazon Keyspaces table - The resource type is "table" and the unique identifier is the table name. Example: "keyspace/mykeyspace/table/mytable".
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: "arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5".

REQUIRED ScalableDimension => Str

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

"ecs:service:DesiredCount" - The desired task count of an ECS service.
"ec2:spot-fleet-request:TargetCapacity" - The target capacity of a Spot Fleet request.
"elasticmapreduce:instancegroup:InstanceCount" - The instance count of an EMR Instance Group.
"appstream:fleet:DesiredCapacity" - The desired capacity of an AppStream 2.0 fleet.
"dynamodb:table:ReadCapacityUnits" - The provisioned read capacity for a DynamoDB table.
"dynamodb:table:WriteCapacityUnits" - The provisioned write capacity for a DynamoDB table.
"dynamodb:index:ReadCapacityUnits" - The provisioned read capacity for a DynamoDB global secondary index.
"dynamodb:index:WriteCapacityUnits" - The provisioned write capacity for a DynamoDB global secondary index.
"rds:cluster:ReadReplicaCount" - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
"sagemaker:variant:DesiredInstanceCount" - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
"custom-resource:ResourceType:Property" - The scalable dimension for a custom resource provided by your own application or service.
"comprehend:document-classifier-endpoint:DesiredInferenceUnits" - The number of inference units for an Amazon Comprehend document classification endpoint.
"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits" - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
"lambda:function:ProvisionedConcurrency" - The provisioned concurrency for a Lambda function.
"cassandra:table:ReadCapacityUnits" - The provisioned read capacity for an Amazon Keyspaces table.
"cassandra:table:WriteCapacityUnits" - The provisioned write capacity for an Amazon Keyspaces table.
"kafka:broker-storage:VolumeSize" - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.

Valid values are: "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "elasticmapreduce:instancegroup:InstanceCount", "appstream:fleet:DesiredCapacity", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits", "rds:cluster:ReadReplicaCount", "sagemaker:variant:DesiredInstanceCount", "custom-resource:ResourceType:Property", "comprehend:document-classifier-endpoint:DesiredInferenceUnits", "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits", "lambda:function:ProvisionedConcurrency", "cassandra:table:ReadCapacityUnits", "cassandra:table:WriteCapacityUnits", "kafka:broker-storage:VolumeSize"

REQUIRED ServiceNamespace => Str

The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use "custom-resource" instead.

Valid values are: "ecs", "elasticmapreduce", "ec2", "appstream", "dynamodb", "rds", "sagemaker", "custom-resource", "comprehend", "lambda", "cassandra", "kafka"

StepScalingPolicyConfiguration => Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration

A step scaling policy.

This parameter is required if you are creating a policy and the policy type is "StepScaling".

TargetTrackingScalingPolicyConfiguration => Paws::ApplicationAutoScaling::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".

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>