« blib/lib/Paws/AutoScalingPlans/ApplicationSource.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/CreateScalingPlanResponse.pm »
| 1 | |||
| 2 | package Paws::AutoScalingPlans::CreateScalingPlan; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationSource => (is => 'ro', isa => 'Paws::AutoScalingPlans::ApplicationSource', required => 1); | ||
| 5 | has ScalingInstructions => (is => 'ro', isa => 'ArrayRef[Paws::AutoScalingPlans::ScalingInstruction]', required => 1); | ||
| 6 | has ScalingPlanName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateScalingPlan'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScalingPlans::CreateScalingPlanResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::AutoScalingPlans::CreateScalingPlan - Arguments for method CreateScalingPlan on L<Paws::AutoScalingPlans> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateScalingPlan on the | ||
| 24 | L<AWS Auto Scaling Plans|Paws::AutoScalingPlans> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateScalingPlan. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateScalingPlan. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $autoscaling-plans = Paws->service('AutoScalingPlans'); | ||
| 32 | my $CreateScalingPlanResponse = $autoscaling -plans->CreateScalingPlan( | ||
| 33 | ApplicationSource => { | ||
| 34 | CloudFormationStackARN => 'MyXmlString', # OPTIONAL | ||
| 35 | TagFilters => [ | ||
| 36 | { | ||
| 37 | Key => 'MyXmlStringMaxLen128', # min: 1, max: 128; OPTIONAL | ||
| 38 | Values => [ | ||
| 39 | 'MyXmlStringMaxLen256', ... # min: 1, max: 256 | ||
| 40 | ], # OPTIONAL | ||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], # OPTIONAL | ||
| 44 | }, | ||
| 45 | ScalingInstructions => [ | ||
| 46 | { | ||
| 47 | MaxCapacity => 1, | ||
| 48 | MinCapacity => 1, | ||
| 49 | ResourceId => 'MyResourceIdMaxLen1600', # min: 1, max: 1600 | ||
| 50 | ScalableDimension => 'autoscaling:autoScalingGroup:DesiredCapacity' | ||
| 51 | , # values: autoscaling:autoScalingGroup:DesiredCapacity, ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, rds:cluster:ReadReplicaCount, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits | ||
| 52 | ServiceNamespace => | ||
| 53 | 'autoscaling', # values: autoscaling, ecs, ec2, rds, dynamodb | ||
| 54 | TargetTrackingConfigurations => [ | ||
| 55 | { | ||
| 56 | TargetValue => 1, | ||
| 57 | CustomizedScalingMetricSpecification => { | ||
| 58 | MetricName => 'MyMetricName', | ||
| 59 | Namespace => 'MyMetricNamespace', | ||
| 60 | Statistic => 'Average' | ||
| 61 | , # values: Average, Minimum, Maximum, SampleCount, Sum | ||
| 62 | Dimensions => [ | ||
| 63 | { | ||
| 64 | Name => 'MyMetricDimensionName', | ||
| 65 | Value => 'MyMetricDimensionValue', | ||
| 66 | |||
| 67 | }, | ||
| 68 | ... | ||
| 69 | ], # OPTIONAL | ||
| 70 | Unit => 'MyMetricUnit', # OPTIONAL | ||
| 71 | }, # OPTIONAL | ||
| 72 | DisableScaleIn => 1, # OPTIONAL | ||
| 73 | EstimatedInstanceWarmup => 1, # OPTIONAL | ||
| 74 | PredefinedScalingMetricSpecification => { | ||
| 75 | PredefinedScalingMetricType => 'ASGAverageCPUUtilization' | ||
| 76 | , # values: ASGAverageCPUUtilization, ASGAverageNetworkIn, ASGAverageNetworkOut, DynamoDBReadCapacityUtilization, DynamoDBWriteCapacityUtilization, ECSServiceAverageCPUUtilization, ECSServiceAverageMemoryUtilization, ALBRequestCountPerTarget, RDSReaderAverageCPUUtilization, RDSReaderAverageDatabaseConnections, EC2SpotFleetRequestAverageCPUUtilization, EC2SpotFleetRequestAverageNetworkIn, EC2SpotFleetRequestAverageNetworkOut | ||
| 77 | ResourceLabel => | ||
| 78 | 'MyResourceLabel', # min: 1, max: 1023; OPTIONAL | ||
| 79 | }, # OPTIONAL | ||
| 80 | ScaleInCooldown => 1, # OPTIONAL | ||
| 81 | ScaleOutCooldown => 1, # OPTIONAL | ||
| 82 | }, | ||
| 83 | ... | ||
| 84 | ], | ||
| 85 | CustomizedLoadMetricSpecification => { | ||
| 86 | MetricName => 'MyMetricName', | ||
| 87 | Namespace => 'MyMetricNamespace', | ||
| 88 | Statistic => | ||
| 89 | 'Average', # values: Average, Minimum, Maximum, SampleCount, Sum | ||
| 90 | Dimensions => [ | ||
| 91 | { | ||
| 92 | Name => 'MyMetricDimensionName', | ||
| 93 | Value => 'MyMetricDimensionValue', | ||
| 94 | |||
| 95 | }, | ||
| 96 | ... | ||
| 97 | ], # OPTIONAL | ||
| 98 | Unit => 'MyMetricUnit', # OPTIONAL | ||
| 99 | }, # OPTIONAL | ||
| 100 | DisableDynamicScaling => 1, # OPTIONAL | ||
| 101 | PredefinedLoadMetricSpecification => { | ||
| 102 | PredefinedLoadMetricType => 'ASGTotalCPUUtilization' | ||
| 103 | , # values: ASGTotalCPUUtilization, ASGTotalNetworkIn, ASGTotalNetworkOut, ALBTargetGroupRequestCount | ||
| 104 | ResourceLabel => 'MyResourceLabel', # min: 1, max: 1023; OPTIONAL | ||
| 105 | }, # OPTIONAL | ||
| 106 | PredictiveScalingMaxCapacityBehavior => | ||
| 107 | 'SetForecastCapacityToMaxCapacity' | ||
| 108 | , # values: SetForecastCapacityToMaxCapacity, SetMaxCapacityToForecastCapacity, SetMaxCapacityAboveForecastCapacity; OPTIONAL | ||
| 109 | PredictiveScalingMaxCapacityBuffer => 1, | ||
| 110 | PredictiveScalingMode => 'ForecastAndScale' | ||
| 111 | , # values: ForecastAndScale, ForecastOnly; OPTIONAL | ||
| 112 | ScalingPolicyUpdateBehavior => 'KeepExternalPolicies' | ||
| 113 | , # values: KeepExternalPolicies, ReplaceExternalPolicies; OPTIONAL | ||
| 114 | ScheduledActionBufferTime => 1, # OPTIONAL | ||
| 115 | }, | ||
| 116 | ... | ||
| 117 | ], | ||
| 118 | ScalingPlanName => 'MyScalingPlanName', | ||
| 119 | |||
| 120 | ); | ||
| 121 | |||
| 122 | # Results: | ||
| 123 | my $ScalingPlanVersion = $CreateScalingPlanResponse->ScalingPlanVersion; | ||
| 124 | |||
| 125 | # Returns a L<Paws::AutoScalingPlans::CreateScalingPlanResponse> object. | ||
| 126 | |||
| 127 | 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. | ||
| 128 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans/CreateScalingPlan> | ||
| 129 | |||
| 130 | =head1 ATTRIBUTES | ||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> ApplicationSource => L<Paws::AutoScalingPlans::ApplicationSource> | ||
| 134 | |||
| 135 | A CloudFormation stack or set of tags. You can create one scaling plan | ||
| 136 | per application source. | ||
| 137 | |||
| 138 | For more information, see ApplicationSource | ||
| 139 | (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html) | ||
| 140 | in the I<AWS Auto Scaling API Reference>. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head2 B<REQUIRED> ScalingInstructions => ArrayRef[L<Paws::AutoScalingPlans::ScalingInstruction>] | ||
| 145 | |||
| 146 | The scaling instructions. | ||
| 147 | |||
| 148 | For more information, see ScalingInstruction | ||
| 149 | (https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html) | ||
| 150 | in the I<AWS Auto Scaling API Reference>. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 B<REQUIRED> ScalingPlanName => Str | ||
| 155 | |||
| 156 | The name of the scaling plan. Names cannot contain vertical bars, | ||
| 157 | colons, or forward slashes. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head1 SEE ALSO | ||
| 163 | |||
| 164 | This class forms part of L<Paws>, documenting arguments for method CreateScalingPlan in L<Paws::AutoScalingPlans> | ||
| 165 | |||
| 166 | =head1 BUGS and CONTRIBUTIONS | ||
| 167 | |||
| 168 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 169 | |||
| 170 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 171 | |||
| 172 | =cut | ||
| 173 |