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