« blib/lib/Paws/ElasticBeanstalk/DescribeEvents.pm
↑ Summary
blib/lib/Paws/ElasticBeanstalk/EnvironmentDescriptionsMessage.pm »
| 1 | |||
| 2 | package Paws::ElasticBeanstalk::EnvironmentDescription; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AbortableOperationInProgress => (is => 'ro', isa => 'Bool'); | |
| 5 | 1 | has ApplicationName => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has CNAME => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has DateCreated => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has DateUpdated => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has Description => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has EndpointURL => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has EnvironmentArn => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has EnvironmentId => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has EnvironmentLinks => (is => 'ro', isa => 'ArrayRef[Paws::ElasticBeanstalk::EnvironmentLink]'); | |
| 14 | 1 | has EnvironmentName => (is => 'ro', isa => 'Str'); | |
| 15 | 1 | has Health => (is => 'ro', isa => 'Str'); | |
| 16 | 1 | has HealthStatus => (is => 'ro', isa => 'Str'); | |
| 17 | 1 | has OperationsRole => (is => 'ro', isa => 'Str'); | |
| 18 | 1 | has PlatformArn => (is => 'ro', isa => 'Str'); | |
| 19 | 1 | has Resources => (is => 'ro', isa => 'Paws::ElasticBeanstalk::EnvironmentResourcesDescription'); | |
| 20 | 1 | has SolutionStackName => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has Status => (is => 'ro', isa => 'Str'); | |
| 22 | 1 | has TemplateName => (is => 'ro', isa => 'Str'); | |
| 23 | 1 | has Tier => (is => 'ro', isa => 'Paws::ElasticBeanstalk::EnvironmentTier'); | |
| 24 | 1 | has VersionLabel => (is => 'ro', isa => 'Str'); | |
| 25 | |||
| 26 | 1 | has _request_id => (is => 'ro', isa => 'Str'); | |
| 27 | 1 | 1; | |
| 28 | |||
| 29 | ### main pod documentation begin ### | ||
| 30 | |||
| 31 | =head1 NAME | ||
| 32 | |||
| 33 | Paws::ElasticBeanstalk::EnvironmentDescription | ||
| 34 | |||
| 35 | =head1 ATTRIBUTES | ||
| 36 | |||
| 37 | |||
| 38 | =head2 AbortableOperationInProgress => Bool | ||
| 39 | |||
| 40 | Indicates if there is an in-progress environment configuration update | ||
| 41 | or application version deployment that you can cancel. | ||
| 42 | |||
| 43 | C<true:> There is an update in progress. | ||
| 44 | |||
| 45 | C<false:> There are no updates currently in progress. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ApplicationName => Str | ||
| 49 | |||
| 50 | The name of the application associated with this environment. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 CNAME => Str | ||
| 54 | |||
| 55 | The URL to the CNAME for this environment. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DateCreated => Str | ||
| 59 | |||
| 60 | The creation date for this environment. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 DateUpdated => Str | ||
| 64 | |||
| 65 | The last modified date for this environment. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Description => Str | ||
| 69 | |||
| 70 | Describes this environment. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 EndpointURL => Str | ||
| 74 | |||
| 75 | For load-balanced, autoscaling environments, the URL to the | ||
| 76 | LoadBalancer. For single-instance environments, the IP address of the | ||
| 77 | instance. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 EnvironmentArn => Str | ||
| 81 | |||
| 82 | The environment's Amazon Resource Name (ARN), which can be used in | ||
| 83 | other API requests that require an ARN. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 EnvironmentId => Str | ||
| 87 | |||
| 88 | The ID of this environment. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 EnvironmentLinks => ArrayRef[L<Paws::ElasticBeanstalk::EnvironmentLink>] | ||
| 92 | |||
| 93 | A list of links to other environments in the same group. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 EnvironmentName => Str | ||
| 97 | |||
| 98 | The name of this environment. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 Health => Str | ||
| 102 | |||
| 103 | Describes the health status of the environment. AWS Elastic Beanstalk | ||
| 104 | indicates the failure levels for a running environment: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<Red>: Indicates the environment is not responsive. Occurs when three | ||
| 111 | or more consecutive failures occur for an environment. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<Yellow>: Indicates that something is wrong. Occurs when two | ||
| 116 | consecutive failures occur for an environment. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<Green>: Indicates the environment is healthy and fully functional. | ||
| 121 | |||
| 122 | =item * | ||
| 123 | |||
| 124 | C<Grey>: Default health for a new environment. The environment is not | ||
| 125 | fully launched and health checks have not started or health checks are | ||
| 126 | suspended during an C<UpdateEnvironment> or C<RestartEnvironment> | ||
| 127 | request. | ||
| 128 | |||
| 129 | =back | ||
| 130 | |||
| 131 | Default: C<Grey> | ||
| 132 | |||
| 133 | Valid values are: C<"Green">, C<"Yellow">, C<"Red">, C<"Grey"> | ||
| 134 | =head2 HealthStatus => Str | ||
| 135 | |||
| 136 | Returns the health status of the application running in your | ||
| 137 | environment. For more information, see Health Colors and Statuses | ||
| 138 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html). | ||
| 139 | |||
| 140 | Valid values are: C<"NoData">, C<"Unknown">, C<"Pending">, C<"Ok">, C<"Info">, C<"Warning">, C<"Degraded">, C<"Severe">, C<"Suspended"> | ||
| 141 | =head2 OperationsRole => Str | ||
| 142 | |||
| 143 | The Amazon Resource Name (ARN) of the environment's operations role. | ||
| 144 | For more information, see Operations roles | ||
| 145 | (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/iam-operationsrole.html) | ||
| 146 | in the I<AWS Elastic Beanstalk Developer Guide>. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 PlatformArn => Str | ||
| 150 | |||
| 151 | The ARN of the platform version. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 Resources => L<Paws::ElasticBeanstalk::EnvironmentResourcesDescription> | ||
| 155 | |||
| 156 | The description of the AWS resources used by this environment. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 SolutionStackName => Str | ||
| 160 | |||
| 161 | The name of the C<SolutionStack> deployed with this environment. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 Status => Str | ||
| 165 | |||
| 166 | The current operational status of the environment: | ||
| 167 | |||
| 168 | =over | ||
| 169 | |||
| 170 | =item * | ||
| 171 | |||
| 172 | C<Launching>: Environment is in the process of initial deployment. | ||
| 173 | |||
| 174 | =item * | ||
| 175 | |||
| 176 | C<Updating>: Environment is in the process of updating its | ||
| 177 | configuration settings or application version. | ||
| 178 | |||
| 179 | =item * | ||
| 180 | |||
| 181 | C<Ready>: Environment is available to have an action performed on it, | ||
| 182 | such as update or terminate. | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<Terminating>: Environment is in the shut-down process. | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<Terminated>: Environment is not running. | ||
| 191 | |||
| 192 | =back | ||
| 193 | |||
| 194 | |||
| 195 | Valid values are: C<"Aborting">, C<"Launching">, C<"Updating">, C<"LinkingFrom">, C<"LinkingTo">, C<"Ready">, C<"Terminating">, C<"Terminated"> | ||
| 196 | =head2 TemplateName => Str | ||
| 197 | |||
| 198 | The name of the configuration template used to originally launch this | ||
| 199 | environment. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 Tier => L<Paws::ElasticBeanstalk::EnvironmentTier> | ||
| 203 | |||
| 204 | Describes the current tier of this environment. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 VersionLabel => Str | ||
| 208 | |||
| 209 | The application version deployed in this environment. | ||
| 210 | |||
| 211 | |||
| 212 | =head2 _request_id => Str | ||
| 213 | |||
| 214 | |||
| 215 | =cut | ||
| 216 | |||