« blib/lib/Paws/ElasticBeanstalk/UpdateConfigurationTemplate.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/UpdateTagsForResource.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::UpdateEnvironment; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::ElasticBeanstalk> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method UpdateEnvironment on the | ||
| 33 | L<AWS Elastic Beanstalk|Paws::ElasticBeanstalk> 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 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $elasticbeanstalk = Paws->service('ElasticBeanstalk'); | ||
| 41 | # To update an environment to a new version | ||
| 42 | # The following operation updates an environment named "my-env" to version "v2" | ||
| 43 | # of the application to which it belongs: | ||
| 44 | my $EnvironmentDescription = $elasticbeanstalk->UpdateEnvironment( | ||
| 45 | 'EnvironmentName' => 'my-env', | ||
| 46 | 'VersionLabel' => 'v2' | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $ApplicationName = $EnvironmentDescription->ApplicationName; | ||
| 51 | my $CNAME = $EnvironmentDescription->CNAME; | ||
| 52 | my $DateCreated = $EnvironmentDescription->DateCreated; | ||
| 53 | my $DateUpdated = $EnvironmentDescription->DateUpdated; | ||
| 54 | my $EndpointURL = $EnvironmentDescription->EndpointURL; | ||
| 55 | my $EnvironmentId = $EnvironmentDescription->EnvironmentId; | ||
| 56 | my $EnvironmentName = $EnvironmentDescription->EnvironmentName; | ||
| 57 | my $Health = $EnvironmentDescription->Health; | ||
| 58 | my $SolutionStackName = $EnvironmentDescription->SolutionStackName; | ||
| 59 | my $Status = $EnvironmentDescription->Status; | ||
| 60 | my $Tier = $EnvironmentDescription->Tier; | ||
| 61 | my $VersionLabel = $EnvironmentDescription->VersionLabel; | ||
| 62 | |||
| 63 | # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object. | ||
| 64 | # To configure option settings | ||
| 65 | # The following operation configures several options in the aws:elb:loadbalancer | ||
| 66 | # namespace: | ||
| 67 | my $EnvironmentDescription = $elasticbeanstalk->UpdateEnvironment( | ||
| 68 | 'EnvironmentName' => 'my-env', | ||
| 69 | 'OptionSettings' => [ | ||
| 70 | |||
| 71 | { | ||
| 72 | 'Namespace' => 'aws:elb:healthcheck', | ||
| 73 | 'OptionName' => 'Interval', | ||
| 74 | 'Value' => 15 | ||
| 75 | }, | ||
| 76 | |||
| 77 | { | ||
| 78 | 'Namespace' => 'aws:elb:healthcheck', | ||
| 79 | 'OptionName' => 'Timeout', | ||
| 80 | 'Value' => 8 | ||
| 81 | }, | ||
| 82 | |||
| 83 | { | ||
| 84 | 'Namespace' => 'aws:elb:healthcheck', | ||
| 85 | 'OptionName' => 'HealthyThreshold', | ||
| 86 | 'Value' => 2 | ||
| 87 | }, | ||
| 88 | |||
| 89 | { | ||
| 90 | 'Namespace' => 'aws:elb:healthcheck', | ||
| 91 | 'OptionName' => 'UnhealthyThreshold', | ||
| 92 | 'Value' => 3 | ||
| 93 | } | ||
| 94 | ] | ||
| 95 | ); | ||
| 96 | |||
| 97 | # Results: | ||
| 98 | my $AbortableOperationInProgress = | ||
| 99 | $EnvironmentDescription->AbortableOperationInProgress; | ||
| 100 | my $ApplicationName = $EnvironmentDescription->ApplicationName; | ||
| 101 | my $CNAME = $EnvironmentDescription->CNAME; | ||
| 102 | my $DateCreated = $EnvironmentDescription->DateCreated; | ||
| 103 | my $DateUpdated = $EnvironmentDescription->DateUpdated; | ||
| 104 | my $EndpointURL = $EnvironmentDescription->EndpointURL; | ||
| 105 | my $EnvironmentId = $EnvironmentDescription->EnvironmentId; | ||
| 106 | my $EnvironmentName = $EnvironmentDescription->EnvironmentName; | ||
| 107 | my $Health = $EnvironmentDescription->Health; | ||
| 108 | my $SolutionStackName = $EnvironmentDescription->SolutionStackName; | ||
| 109 | my $Status = $EnvironmentDescription->Status; | ||
| 110 | my $Tier = $EnvironmentDescription->Tier; | ||
| 111 | my $VersionLabel = $EnvironmentDescription->VersionLabel; | ||
| 112 | |||
| 113 | # Returns a L<Paws::ElasticBeanstalk::EnvironmentDescription> object. | ||
| 114 | |||
| 115 | 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. | ||
| 116 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticbeanstalk/UpdateEnvironment> | ||
| 117 | |||
| 118 | =head1 ATTRIBUTES | ||
| 119 | |||
| 120 | |||
| 121 | =head2 ApplicationName => Str | ||
| 122 | |||
| 123 | The name of the application with which the environment is associated. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 Description => Str | ||
| 128 | |||
| 129 | If this parameter is specified, AWS Elastic Beanstalk updates the | ||
| 130 | description of this environment. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 EnvironmentId => Str | ||
| 135 | |||
| 136 | The ID of the environment to update. | ||
| 137 | |||
| 138 | If no environment with this ID exists, AWS Elastic Beanstalk returns an | ||
| 139 | C<InvalidParameterValue> error. | ||
| 140 | |||
| 141 | Condition: You must specify either this or an EnvironmentName, or both. | ||
| 142 | If you do not specify either, AWS Elastic Beanstalk returns | ||
| 143 | C<MissingRequiredParameter> error. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 EnvironmentName => Str | ||
| 148 | |||
| 149 | The name of the environment to update. If no environment with this name | ||
| 150 | exists, AWS Elastic Beanstalk returns an C<InvalidParameterValue> | ||
| 151 | error. | ||
| 152 | |||
| 153 | Condition: You must specify either this or an EnvironmentId, or both. | ||
| 154 | If you do not specify either, AWS Elastic Beanstalk returns | ||
| 155 | C<MissingRequiredParameter> error. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 GroupName => Str | ||
| 160 | |||
| 161 | The name of the group to which the target environment belongs. Specify | ||
| 162 | a group name only if the environment's name is specified in an | ||
| 163 | environment manifest and not with the environment name or environment | ||
| 164 | ID parameters. See Environment Manifest (env.yaml) | ||
| 165 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) | ||
| 166 | for details. | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 OptionSettings => ArrayRef[L<Paws::ElasticBeanstalk::ConfigurationOptionSetting>] | ||
| 171 | |||
| 172 | If specified, AWS Elastic Beanstalk updates the configuration set | ||
| 173 | associated with the running environment and sets the specified | ||
| 174 | configuration options to the requested value. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 OptionsToRemove => ArrayRef[L<Paws::ElasticBeanstalk::OptionSpecification>] | ||
| 179 | |||
| 180 | A list of custom user-defined configuration options to remove from the | ||
| 181 | configuration set for this environment. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 PlatformArn => Str | ||
| 186 | |||
| 187 | The ARN of the platform, if used. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 SolutionStackName => Str | ||
| 192 | |||
| 193 | This specifies the platform version that the environment will run after | ||
| 194 | the environment is updated. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head2 TemplateName => Str | ||
| 199 | |||
| 200 | If this parameter is specified, AWS Elastic Beanstalk deploys this | ||
| 201 | configuration template to the environment. If no such configuration | ||
| 202 | template is found, AWS Elastic Beanstalk returns an | ||
| 203 | C<InvalidParameterValue> error. | ||
| 204 | |||
| 205 | |||
| 206 | |||
| 207 | =head2 Tier => L<Paws::ElasticBeanstalk::EnvironmentTier> | ||
| 208 | |||
| 209 | This specifies the tier to use to update the environment. | ||
| 210 | |||
| 211 | Condition: At this time, if you change the tier version, name, or type, | ||
| 212 | AWS Elastic Beanstalk returns C<InvalidParameterValue> error. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head2 VersionLabel => Str | ||
| 217 | |||
| 218 | If this parameter is specified, AWS Elastic Beanstalk deploys the named | ||
| 219 | application version to the environment. If no such application version | ||
| 220 | is found, returns an C<InvalidParameterValue> error. | ||
| 221 | |||
| 222 | |||
| 223 | |||
| 224 | |||
| 225 | =head1 SEE ALSO | ||
| 226 | |||
| 227 | This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment in L<Paws::ElasticBeanstalk> | ||
| 228 | |||
| 229 | =head1 BUGS and CONTRIBUTIONS | ||
| 230 | |||
| 231 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 232 | |||
| 233 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 234 | |||
| 235 | =cut | ||
| 236 |