« blib/lib/Paws/AppConfig/UpdateDeploymentStrategy.pm
↑ Summary
blib/lib/Paws/AppConfig/ValidateConfiguration.pm »
| 1 | |||
| 2 | package Paws::AppConfig::UpdateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ApplicationId', required => 1); | ||
| 5 | has Description => (is => 'ro', isa => 'Str'); | ||
| 6 | has EnvironmentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'EnvironmentId', required => 1); | ||
| 7 | has Monitors => (is => 'ro', isa => 'ArrayRef[Paws::AppConfig::Monitor]'); | ||
| 8 | has Name => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnvironment'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/applications/{ApplicationId}/environments/{EnvironmentId}'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppConfig::Environment'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::AppConfig::UpdateEnvironment - Arguments for method UpdateEnvironment on L<Paws::AppConfig> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateEnvironment on the | ||
| 27 | L<Amazon AppConfig|Paws::AppConfig> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateEnvironment. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnvironment. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $appconfig = Paws->service('AppConfig'); | ||
| 35 | my $Environment = $appconfig->UpdateEnvironment( | ||
| 36 | ApplicationId => 'MyId', | ||
| 37 | EnvironmentId => 'MyId', | ||
| 38 | Description => 'MyDescription', # OPTIONAL | ||
| 39 | Monitors => [ | ||
| 40 | { | ||
| 41 | AlarmArn => 'MyArn', # min: 20, max: 2048; OPTIONAL | ||
| 42 | AlarmRoleArn => 'MyRoleArn', # min: 20, max: 2048; OPTIONAL | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | Name => 'MyName', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $ApplicationId = $Environment->ApplicationId; | ||
| 51 | my $Description = $Environment->Description; | ||
| 52 | my $Id = $Environment->Id; | ||
| 53 | my $Monitors = $Environment->Monitors; | ||
| 54 | my $Name = $Environment->Name; | ||
| 55 | my $State = $Environment->State; | ||
| 56 | |||
| 57 | # Returns a L<Paws::AppConfig::Environment> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/appconfig/UpdateEnvironment> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 66 | |||
| 67 | The application ID. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Description => Str | ||
| 72 | |||
| 73 | A description of the environment. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> EnvironmentId => Str | ||
| 78 | |||
| 79 | The environment ID. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 Monitors => ArrayRef[L<Paws::AppConfig::Monitor>] | ||
| 84 | |||
| 85 | Amazon CloudWatch alarms to monitor during the deployment process. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 Name => Str | ||
| 90 | |||
| 91 | The name of the environment. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment in L<Paws::AppConfig> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |