« blib/lib/Paws/AppConfig/UpdateConfigurationProfile.pm
↑ Summary
blib/lib/Paws/AppConfig/UpdateEnvironment.pm »
| 1 | |||
| 2 | package Paws::AppConfig::UpdateDeploymentStrategy; | ||
| 3 | use Moose; | ||
| 4 | has DeploymentDurationInMinutes => (is => 'ro', isa => 'Int'); | ||
| 5 | has DeploymentStrategyId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DeploymentStrategyId', required => 1); | ||
| 6 | has Description => (is => 'ro', isa => 'Str'); | ||
| 7 | has FinalBakeTimeInMinutes => (is => 'ro', isa => 'Int'); | ||
| 8 | has GrowthFactor => (is => 'ro', isa => 'Num'); | ||
| 9 | has GrowthType => (is => 'ro', isa => 'Str'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDeploymentStrategy'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/deploymentstrategies/{DeploymentStrategyId}'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppConfig::DeploymentStrategy'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::AppConfig::UpdateDeploymentStrategy - Arguments for method UpdateDeploymentStrategy on L<Paws::AppConfig> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method UpdateDeploymentStrategy on the | ||
| 28 | L<Amazon AppConfig|Paws::AppConfig> service. Use the attributes of this class | ||
| 29 | as arguments to method UpdateDeploymentStrategy. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDeploymentStrategy. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $appconfig = Paws->service('AppConfig'); | ||
| 36 | my $DeploymentStrategy = $appconfig->UpdateDeploymentStrategy( | ||
| 37 | DeploymentStrategyId => 'MyDeploymentStrategyId', | ||
| 38 | DeploymentDurationInMinutes => 1, # OPTIONAL | ||
| 39 | Description => 'MyDescription', # OPTIONAL | ||
| 40 | FinalBakeTimeInMinutes => 1, # OPTIONAL | ||
| 41 | GrowthFactor => 1.0, # OPTIONAL | ||
| 42 | GrowthType => 'LINEAR', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $DeploymentDurationInMinutes = | ||
| 47 | $DeploymentStrategy->DeploymentDurationInMinutes; | ||
| 48 | my $Description = $DeploymentStrategy->Description; | ||
| 49 | my $FinalBakeTimeInMinutes = $DeploymentStrategy->FinalBakeTimeInMinutes; | ||
| 50 | my $GrowthFactor = $DeploymentStrategy->GrowthFactor; | ||
| 51 | my $GrowthType = $DeploymentStrategy->GrowthType; | ||
| 52 | my $Id = $DeploymentStrategy->Id; | ||
| 53 | my $Name = $DeploymentStrategy->Name; | ||
| 54 | my $ReplicateTo = $DeploymentStrategy->ReplicateTo; | ||
| 55 | |||
| 56 | # Returns a L<Paws::AppConfig::DeploymentStrategy> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appconfig/UpdateDeploymentStrategy> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 DeploymentDurationInMinutes => Int | ||
| 65 | |||
| 66 | Total amount of time for a deployment to last. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> DeploymentStrategyId => Str | ||
| 71 | |||
| 72 | The deployment strategy ID. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Description => Str | ||
| 77 | |||
| 78 | A description of the deployment strategy. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 FinalBakeTimeInMinutes => Int | ||
| 83 | |||
| 84 | The amount of time AppConfig monitors for alarms before considering the | ||
| 85 | deployment to be complete and no longer eligible for automatic roll | ||
| 86 | back. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 GrowthFactor => Num | ||
| 91 | |||
| 92 | The percentage of targets to receive a deployed configuration during | ||
| 93 | each interval. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 GrowthType => Str | ||
| 98 | |||
| 99 | The algorithm used to define how percentage grows over time. AWS | ||
| 100 | AppConfig supports the following growth types: | ||
| 101 | |||
| 102 | B<Linear>: For this type, AppConfig processes the deployment by | ||
| 103 | increments of the growth factor evenly distributed over the deployment | ||
| 104 | time. For example, a linear deployment that uses a growth factor of 20 | ||
| 105 | initially makes the configuration available to 20 percent of the | ||
| 106 | targets. After 1/5th of the deployment time has passed, the system | ||
| 107 | updates the percentage to 40 percent. This continues until 100% of the | ||
| 108 | targets are set to receive the deployed configuration. | ||
| 109 | |||
| 110 | B<Exponential>: For this type, AppConfig processes the deployment | ||
| 111 | exponentially using the following formula: C<G*(2^N)>. In this formula, | ||
| 112 | C<G> is the growth factor specified by the user and C<N> is the number | ||
| 113 | of steps until the configuration is deployed to all targets. For | ||
| 114 | example, if you specify a growth factor of 2, then the system rolls out | ||
| 115 | the configuration as follows: | ||
| 116 | |||
| 117 | C<2*(2^0)> | ||
| 118 | |||
| 119 | C<2*(2^1)> | ||
| 120 | |||
| 121 | C<2*(2^2)> | ||
| 122 | |||
| 123 | Expressed numerically, the deployment rolls out as follows: 2% of the | ||
| 124 | targets, 4% of the targets, 8% of the targets, and continues until the | ||
| 125 | configuration has been deployed to all targets. | ||
| 126 | |||
| 127 | Valid values are: C<"LINEAR">, C<"EXPONENTIAL"> | ||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method UpdateDeploymentStrategy in L<Paws::AppConfig> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |