« blib/lib/Paws/ApplicationAutoScaling/ScalingActivity.pm
↑ Summary
blib/lib/Paws/ApplicationAutoScaling/ScheduledAction.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApplicationAutoScaling::ScalingPolicy; | ||
| 3 | use Moose; | ||
| 4 | has Alarms => (is => 'ro', isa => 'ArrayRef[Paws::ApplicationAutoScaling::Alarm]'); | ||
| 5 | has CreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has PolicyARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has PolicyName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has PolicyType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ScalableDimension => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | has StepScalingPolicyConfiguration => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration'); | ||
| 13 | has TargetTrackingScalingPolicyConfiguration => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ApplicationAutoScaling::ScalingPolicy | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::ScalingPolicy object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { Alarms => $value, ..., TargetTrackingScalingPolicyConfiguration => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::ScalingPolicy object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->Alarms | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Represents a scaling policy to use with Application Auto Scaling. | ||
| 46 | |||
| 47 | For more information about configuring scaling policies for a specific | ||
| 48 | service, see Getting started with Application Auto Scaling | ||
| 49 | (https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html) | ||
| 50 | in the I<Application Auto Scaling User Guide>. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Alarms => ArrayRef[L<Paws::ApplicationAutoScaling::Alarm>] | ||
| 56 | |||
| 57 | The CloudWatch alarms associated with the scaling policy. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> CreationTime => Str | ||
| 61 | |||
| 62 | The Unix timestamp for when the scaling policy was created. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> PolicyARN => Str | ||
| 66 | |||
| 67 | The Amazon Resource Name (ARN) of the scaling policy. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> PolicyName => Str | ||
| 71 | |||
| 72 | The name of the scaling policy. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> PolicyType => Str | ||
| 76 | |||
| 77 | The scaling policy type. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> ResourceId => Str | ||
| 81 | |||
| 82 | The identifier of the resource associated with the scaling policy. This | ||
| 83 | string consists of the resource type and unique identifier. | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | ECS service - The resource type is C<service> and the unique identifier | ||
| 90 | is the cluster name and service name. Example: | ||
| 91 | C<service/default/sample-webapp>. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | Spot Fleet request - The resource type is C<spot-fleet-request> and the | ||
| 96 | unique identifier is the Spot Fleet request ID. Example: | ||
| 97 | C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>. | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | EMR cluster - The resource type is C<instancegroup> and the unique | ||
| 102 | identifier is the cluster ID and instance group ID. Example: | ||
| 103 | C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | AppStream 2.0 fleet - The resource type is C<fleet> and the unique | ||
| 108 | identifier is the fleet name. Example: C<fleet/sample-fleet>. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | DynamoDB table - The resource type is C<table> and the unique | ||
| 113 | identifier is the table name. Example: C<table/my-table>. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | DynamoDB global secondary index - The resource type is C<index> and the | ||
| 118 | unique identifier is the index name. Example: | ||
| 119 | C<table/my-table/index/my-table-index>. | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | Aurora DB cluster - The resource type is C<cluster> and the unique | ||
| 124 | identifier is the cluster name. Example: C<cluster:my-db-cluster>. | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | Amazon SageMaker endpoint variant - The resource type is C<variant> and | ||
| 129 | the unique identifier is the resource ID. Example: | ||
| 130 | C<endpoint/my-end-point/variant/KMeansClustering>. | ||
| 131 | |||
| 132 | =item * | ||
| 133 | |||
| 134 | Custom resources are not supported with a resource type. This parameter | ||
| 135 | must specify the C<OutputValue> from the CloudFormation template stack | ||
| 136 | used to access the resources. The unique identifier is defined by the | ||
| 137 | service provider. More information is available in our GitHub | ||
| 138 | repository (https://github.com/aws/aws-auto-scaling-custom-resource). | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | Amazon Comprehend document classification endpoint - The resource type | ||
| 143 | and unique identifier are specified using the endpoint ARN. Example: | ||
| 144 | C<arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE>. | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | Amazon Comprehend entity recognizer endpoint - The resource type and | ||
| 149 | unique identifier are specified using the endpoint ARN. Example: | ||
| 150 | C<arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE>. | ||
| 151 | |||
| 152 | =item * | ||
| 153 | |||
| 154 | Lambda provisioned concurrency - The resource type is C<function> and | ||
| 155 | the unique identifier is the function name with a function version or | ||
| 156 | alias name suffix that is not C<$LATEST>. Example: | ||
| 157 | C<function:my-function:prod> or C<function:my-function:1>. | ||
| 158 | |||
| 159 | =item * | ||
| 160 | |||
| 161 | Amazon Keyspaces table - The resource type is C<table> and the unique | ||
| 162 | identifier is the table name. Example: | ||
| 163 | C<keyspace/mykeyspace/table/mytable>. | ||
| 164 | |||
| 165 | =item * | ||
| 166 | |||
| 167 | Amazon MSK cluster - The resource type and unique identifier are | ||
| 168 | specified using the cluster ARN. Example: | ||
| 169 | C<arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5>. | ||
| 170 | |||
| 171 | =back | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 B<REQUIRED> ScalableDimension => Str | ||
| 176 | |||
| 177 | The scalable dimension. This string consists of the service namespace, | ||
| 178 | resource type, and scaling property. | ||
| 179 | |||
| 180 | =over | ||
| 181 | |||
| 182 | =item * | ||
| 183 | |||
| 184 | C<ecs:service:DesiredCount> - The desired task count of an ECS service. | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a | ||
| 189 | Spot Fleet request. | ||
| 190 | |||
| 191 | =item * | ||
| 192 | |||
| 193 | C<elasticmapreduce:instancegroup:InstanceCount> - The instance count of | ||
| 194 | an EMR Instance Group. | ||
| 195 | |||
| 196 | =item * | ||
| 197 | |||
| 198 | C<appstream:fleet:DesiredCapacity> - The desired capacity of an | ||
| 199 | AppStream 2.0 fleet. | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for | ||
| 204 | a DynamoDB table. | ||
| 205 | |||
| 206 | =item * | ||
| 207 | |||
| 208 | C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity | ||
| 209 | for a DynamoDB table. | ||
| 210 | |||
| 211 | =item * | ||
| 212 | |||
| 213 | C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for | ||
| 214 | a DynamoDB global secondary index. | ||
| 215 | |||
| 216 | =item * | ||
| 217 | |||
| 218 | C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity | ||
| 219 | for a DynamoDB global secondary index. | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | C<rds:cluster:ReadReplicaCount> - The count of Aurora Replicas in an | ||
| 224 | Aurora DB cluster. Available for Aurora MySQL-compatible edition and | ||
| 225 | Aurora PostgreSQL-compatible edition. | ||
| 226 | |||
| 227 | =item * | ||
| 228 | |||
| 229 | C<sagemaker:variant:DesiredInstanceCount> - The number of EC2 instances | ||
| 230 | for an Amazon SageMaker model endpoint variant. | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | C<custom-resource:ResourceType:Property> - The scalable dimension for a | ||
| 235 | custom resource provided by your own application or service. | ||
| 236 | |||
| 237 | =item * | ||
| 238 | |||
| 239 | C<comprehend:document-classifier-endpoint:DesiredInferenceUnits> - The | ||
| 240 | number of inference units for an Amazon Comprehend document | ||
| 241 | classification endpoint. | ||
| 242 | |||
| 243 | =item * | ||
| 244 | |||
| 245 | C<comprehend:entity-recognizer-endpoint:DesiredInferenceUnits> - The | ||
| 246 | number of inference units for an Amazon Comprehend entity recognizer | ||
| 247 | endpoint. | ||
| 248 | |||
| 249 | =item * | ||
| 250 | |||
| 251 | C<lambda:function:ProvisionedConcurrency> - The provisioned concurrency | ||
| 252 | for a Lambda function. | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | C<cassandra:table:ReadCapacityUnits> - The provisioned read capacity | ||
| 257 | for an Amazon Keyspaces table. | ||
| 258 | |||
| 259 | =item * | ||
| 260 | |||
| 261 | C<cassandra:table:WriteCapacityUnits> - The provisioned write capacity | ||
| 262 | for an Amazon Keyspaces table. | ||
| 263 | |||
| 264 | =item * | ||
| 265 | |||
| 266 | C<kafka:broker-storage:VolumeSize> - The provisioned volume size (in | ||
| 267 | GiB) for brokers in an Amazon MSK cluster. | ||
| 268 | |||
| 269 | =back | ||
| 270 | |||
| 271 | |||
| 272 | |||
| 273 | =head2 B<REQUIRED> ServiceNamespace => Str | ||
| 274 | |||
| 275 | The namespace of the AWS service that provides the resource, or a | ||
| 276 | C<custom-resource>. | ||
| 277 | |||
| 278 | |||
| 279 | =head2 StepScalingPolicyConfiguration => L<Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration> | ||
| 280 | |||
| 281 | A step scaling policy. | ||
| 282 | |||
| 283 | |||
| 284 | =head2 TargetTrackingScalingPolicyConfiguration => L<Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration> | ||
| 285 | |||
| 286 | A target tracking scaling policy. | ||
| 287 | |||
| 288 | |||
| 289 | |||
| 290 | =head1 SEE ALSO | ||
| 291 | |||
| 292 | This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling> | ||
| 293 | |||
| 294 | =head1 BUGS and CONTRIBUTIONS | ||
| 295 | |||
| 296 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 297 | |||
| 298 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 299 | |||
| 300 | =cut | ||
| 301 |