« blib/lib/Paws/AutoScalingPlans/ScalingPlan.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/ScalingPolicy.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScalingPlans::ScalingPlanResource; | ||
| 3 | use Moose; | ||
| 4 | has ResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ScalableDimension => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ScalingPlanName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ScalingPlanVersion => (is => 'ro', isa => 'Int', required => 1); | ||
| 8 | has ScalingPolicies => (is => 'ro', isa => 'ArrayRef[Paws::AutoScalingPlans::ScalingPolicy]'); | ||
| 9 | has ScalingStatusCode => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ScalingStatusMessage => (is => 'ro', isa => 'Str'); | ||
| 11 | has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScalingPlans::ScalingPlanResource | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::AutoScalingPlans::ScalingPlanResource object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { ResourceId => $value, ..., ServiceNamespace => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScalingPlans::ScalingPlanResource object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->ResourceId | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Represents a scalable resource. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> ResourceId => Str | ||
| 49 | |||
| 50 | The ID of the resource. This string consists of the resource type and | ||
| 51 | unique identifier. | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | Auto Scaling group - The resource type is C<autoScalingGroup> and the | ||
| 58 | unique identifier is the name of the Auto Scaling group. Example: | ||
| 59 | C<autoScalingGroup/my-asg>. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | ECS service - The resource type is C<service> and the unique identifier | ||
| 64 | is the cluster name and service name. Example: | ||
| 65 | C<service/default/sample-webapp>. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | Spot Fleet request - The resource type is C<spot-fleet-request> and the | ||
| 70 | unique identifier is the Spot Fleet request ID. Example: | ||
| 71 | C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>. | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | DynamoDB table - The resource type is C<table> and the unique | ||
| 76 | identifier is the resource ID. Example: C<table/my-table>. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | DynamoDB global secondary index - The resource type is C<index> and the | ||
| 81 | unique identifier is the resource ID. Example: | ||
| 82 | C<table/my-table/index/my-table-index>. | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | Aurora DB cluster - The resource type is C<cluster> and the unique | ||
| 87 | identifier is the cluster name. Example: C<cluster:my-db-cluster>. | ||
| 88 | |||
| 89 | =back | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> ScalableDimension => Str | ||
| 94 | |||
| 95 | The scalable dimension for the resource. | ||
| 96 | |||
| 97 | =over | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | C<autoscaling:autoScalingGroup:DesiredCapacity> - The desired capacity | ||
| 102 | of an Auto Scaling group. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<ecs:service:DesiredCount> - The desired task count of an ECS service. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a | ||
| 111 | Spot Fleet request. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for | ||
| 116 | a DynamoDB table. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity | ||
| 121 | for a DynamoDB table. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for | ||
| 126 | a DynamoDB global secondary index. | ||
| 127 | |||
| 128 | =item * | ||
| 129 | |||
| 130 | C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity | ||
| 131 | for a DynamoDB global secondary index. | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | C<rds:cluster:ReadReplicaCount> - The count of Aurora Replicas in an | ||
| 136 | Aurora DB cluster. Available for Aurora MySQL-compatible edition and | ||
| 137 | Aurora PostgreSQL-compatible edition. | ||
| 138 | |||
| 139 | =back | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 B<REQUIRED> ScalingPlanName => Str | ||
| 144 | |||
| 145 | The name of the scaling plan. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 B<REQUIRED> ScalingPlanVersion => Int | ||
| 149 | |||
| 150 | The version number of the scaling plan. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 ScalingPolicies => ArrayRef[L<Paws::AutoScalingPlans::ScalingPolicy>] | ||
| 154 | |||
| 155 | The scaling policies. | ||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> ScalingStatusCode => Str | ||
| 159 | |||
| 160 | The scaling status of the resource. | ||
| 161 | |||
| 162 | =over | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | C<Active> - The scaling configuration is active. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | C<Inactive> - The scaling configuration is not active because the | ||
| 171 | scaling plan is being created or the scaling configuration could not be | ||
| 172 | applied. Check the status message for more information. | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | C<PartiallyActive> - The scaling configuration is partially active | ||
| 177 | because the scaling plan is being created or deleted or the scaling | ||
| 178 | configuration could not be fully applied. Check the status message for | ||
| 179 | more information. | ||
| 180 | |||
| 181 | =back | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 ScalingStatusMessage => Str | ||
| 186 | |||
| 187 | A simple message about the current scaling status of the resource. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 B<REQUIRED> ServiceNamespace => Str | ||
| 191 | |||
| 192 | The namespace of the AWS service. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | =head1 SEE ALSO | ||
| 197 | |||
| 198 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScalingPlans> | ||
| 199 | |||
| 200 | =head1 BUGS and CONTRIBUTIONS | ||
| 201 | |||
| 202 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 203 | |||
| 204 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 205 | |||
| 206 | =cut | ||
| 207 |