File Coverage

blib/lib/Paws/ElasticBeanstalk/UpdateEnvironment.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::ElasticBeanstalk::UpdateEnvironment;
3	1	1	508	use Moose;
	1		5
	1		8
4				has ApplicationName => (is => 'ro', isa => 'Str');
5				has Description => (is => 'ro', isa => 'Str');
6				has EnvironmentId => (is => 'ro', isa => 'Str');
7				has EnvironmentName => (is => 'ro', isa => 'Str');
8				has GroupName => (is => 'ro', isa => 'Str');
9				has OptionSettings => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::ConfigurationOptionSetting]');
10				has OptionsToRemove => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::OptionSpecification]');
11				has PlatformArn => (is => 'ro', isa => 'Str');
12				has SolutionStackName => (is => 'ro', isa => 'Str');
13				has TemplateName => (is => 'ro', isa => 'Str');
14				has Tier => (is => 'ro', isa => 'Paws::ElasticBeanstalk::EnvironmentTier');
15				has VersionLabel => (is => 'ro', isa => 'Str');
16
17	1	1	6312	use MooseX::ClassAttribute;
	1		3
	1		10
18
19				class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnvironment');
20				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ElasticBeanstalk::EnvironmentDescription');
21				class_has _result_key => (isa => 'Str', is => 'ro', default => 'UpdateEnvironmentResult');
22				1;
23
24				### main pod documentation begin ###
25
26				=head1 NAME
27
28				Paws::ElasticBeanstalk::UpdateEnvironment - Arguments for method UpdateEnvironment on Paws::ElasticBeanstalk
29
30				=head1 DESCRIPTION
31
32				This class represents the parameters used for calling the method UpdateEnvironment on the
33				AWS Elastic Beanstalk service. Use the attributes of this class
34				as arguments to method UpdateEnvironment.
35
36				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnvironment.
37
38				As an example:
39
40				$service_obj->UpdateEnvironment(Att1 => $value1, Att2 => $value2, ...);
41
42				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.
43
44				=head1 ATTRIBUTES
45
46
47				=head2 ApplicationName => Str
48
49				The name of the application with which the environment is associated.
50
51
52
53				=head2 Description => Str
54
55				If this parameter is specified, AWS Elastic Beanstalk updates the
56				description of this environment.
57
58
59
60				=head2 EnvironmentId => Str
61
62				The ID of the environment to update.
63
64				If no environment with this ID exists, AWS Elastic Beanstalk returns an
65				C<InvalidParameterValue> error.
66
67				Condition: You must specify either this or an EnvironmentName, or both.
68				If you do not specify either, AWS Elastic Beanstalk returns
69				C<MissingRequiredParameter> error.
70
71
72
73				=head2 EnvironmentName => Str
74
75				The name of the environment to update. If no environment with this name
76				exists, AWS Elastic Beanstalk returns an C<InvalidParameterValue>
77				error.
78
79				Condition: You must specify either this or an EnvironmentId, or both.
80				If you do not specify either, AWS Elastic Beanstalk returns
81				C<MissingRequiredParameter> error.
82
83
84
85				=head2 GroupName => Str
86
87				The name of the group to which the target environment belongs. Specify
88				a group name only if the environment's name is specified in an
89				environment manifest and not with the environment name or environment
90				ID parameters. See Environment Manifest (env.yaml) for details.
91
92
93
94				=head2 OptionSettings => ArrayRef[L<Paws::ElasticBeanstalk::ConfigurationOptionSetting>]
95
96				If specified, AWS Elastic Beanstalk updates the configuration set
97				associated with the running environment and sets the specified
98				configuration options to the requested value.
99
100
101
102				=head2 OptionsToRemove => ArrayRef[L<Paws::ElasticBeanstalk::OptionSpecification>]
103
104				A list of custom user-defined configuration options to remove from the
105				configuration set for this environment.
106
107
108
109				=head2 PlatformArn => Str
110
111				The ARN of the platform, if used.
112
113
114
115				=head2 SolutionStackName => Str
116
117				This specifies the platform version that the environment will run after
118				the environment is updated.
119
120
121
122				=head2 TemplateName => Str
123
124				If this parameter is specified, AWS Elastic Beanstalk deploys this
125				configuration template to the environment. If no such configuration
126				template is found, AWS Elastic Beanstalk returns an
127				C<InvalidParameterValue> error.
128
129
130
131				=head2 Tier => L<Paws::ElasticBeanstalk::EnvironmentTier>
132
133				This specifies the tier to use to update the environment.
134
135				Condition: At this time, if you change the tier version, name, or type,
136				AWS Elastic Beanstalk returns C<InvalidParameterValue> error.
137
138
139
140				=head2 VersionLabel => Str
141
142				If this parameter is specified, AWS Elastic Beanstalk deploys the named
143				application version to the environment. If no such application version
144				is found, returns an C<InvalidParameterValue> error.
145
146
147
148
149				=head1 SEE ALSO
150
151				This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment in L<Paws::ElasticBeanstalk>
152
153				=head1 BUGS and CONTRIBUTIONS
154
155				The source code is located here: https://github.com/pplu/aws-sdk-perl
156
157				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
158
159				=cut
160