EnvironmentDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class EnvironmentDescription
extends Object
implements Serializable, Cloneable

Describes the properties of an environment.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EnvironmentDescription()

Constructors
Constructor and Description
`EnvironmentDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnvironmentDescription`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAbortableOperationInProgress()` Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
`String`	`getApplicationName()` The name of the application associated with this environment.
`String`	`getCNAME()` The URL to the CNAME for this environment.
`Date`	`getDateCreated()` The creation date for this environment.
`Date`	`getDateUpdated()` The last modified date for this environment.
`String`	`getDescription()` Describes this environment.
`String`	`getEndpointURL()` For load-balanced, autoscaling environments, the URL to the LoadBalancer.
`String`	`getEnvironmentArn()` The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
`String`	`getEnvironmentId()` The ID of this environment.
`List<EnvironmentLink>`	`getEnvironmentLinks()` A list of links to other environments in the same group.
`String`	`getEnvironmentName()` The name of this environment.
`String`	`getHealth()` Describes the health status of the environment.
`String`	`getHealthStatus()` Returns the health status of the application running in your environment.
`String`	`getPlatformArn()` The ARN of the platform.
`EnvironmentResourcesDescription`	`getResources()` The description of the AWS resources used by this environment.
`String`	`getSolutionStackName()` The name of the `SolutionStack` deployed with this environment.
`String`	`getStatus()` The current operational status of the environment:
`String`	`getTemplateName()` The name of the configuration template used to originally launch this environment.
`EnvironmentTier`	`getTier()` Describes the current tier of this environment.
`String`	`getVersionLabel()` The application version deployed in this environment.
`int`	`hashCode()`
`Boolean`	`isAbortableOperationInProgress()` Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
`void`	`setAbortableOperationInProgress(Boolean abortableOperationInProgress)` Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
`void`	`setApplicationName(String applicationName)` The name of the application associated with this environment.
`void`	`setCNAME(String cNAME)` The URL to the CNAME for this environment.
`void`	`setDateCreated(Date dateCreated)` The creation date for this environment.
`void`	`setDateUpdated(Date dateUpdated)` The last modified date for this environment.
`void`	`setDescription(String description)` Describes this environment.
`void`	`setEndpointURL(String endpointURL)` For load-balanced, autoscaling environments, the URL to the LoadBalancer.
`void`	`setEnvironmentArn(String environmentArn)` The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
`void`	`setEnvironmentId(String environmentId)` The ID of this environment.
`void`	`setEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)` A list of links to other environments in the same group.
`void`	`setEnvironmentName(String environmentName)` The name of this environment.
`void`	`setHealth(EnvironmentHealth health)` Describes the health status of the environment.
`void`	`setHealth(String health)` Describes the health status of the environment.
`void`	`setHealthStatus(EnvironmentHealthStatus healthStatus)` Returns the health status of the application running in your environment.
`void`	`setHealthStatus(String healthStatus)` Returns the health status of the application running in your environment.
`void`	`setPlatformArn(String platformArn)` The ARN of the platform.
`void`	`setResources(EnvironmentResourcesDescription resources)` The description of the AWS resources used by this environment.
`void`	`setSolutionStackName(String solutionStackName)` The name of the `SolutionStack` deployed with this environment.
`void`	`setStatus(EnvironmentStatus status)` The current operational status of the environment:
`void`	`setStatus(String status)` The current operational status of the environment:
`void`	`setTemplateName(String templateName)` The name of the configuration template used to originally launch this environment.
`void`	`setTier(EnvironmentTier tier)` Describes the current tier of this environment.
`void`	`setVersionLabel(String versionLabel)` The application version deployed in this environment.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`EnvironmentDescription`	`withAbortableOperationInProgress(Boolean abortableOperationInProgress)` Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
`EnvironmentDescription`	`withApplicationName(String applicationName)` The name of the application associated with this environment.
`EnvironmentDescription`	`withCNAME(String cNAME)` The URL to the CNAME for this environment.
`EnvironmentDescription`	`withDateCreated(Date dateCreated)` The creation date for this environment.
`EnvironmentDescription`	`withDateUpdated(Date dateUpdated)` The last modified date for this environment.
`EnvironmentDescription`	`withDescription(String description)` Describes this environment.
`EnvironmentDescription`	`withEndpointURL(String endpointURL)` For load-balanced, autoscaling environments, the URL to the LoadBalancer.
`EnvironmentDescription`	`withEnvironmentArn(String environmentArn)` The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
`EnvironmentDescription`	`withEnvironmentId(String environmentId)` The ID of this environment.
`EnvironmentDescription`	`withEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)` A list of links to other environments in the same group.
`EnvironmentDescription`	`withEnvironmentLinks(EnvironmentLink... environmentLinks)` A list of links to other environments in the same group.
`EnvironmentDescription`	`withEnvironmentName(String environmentName)` The name of this environment.
`EnvironmentDescription`	`withHealth(EnvironmentHealth health)` Describes the health status of the environment.
`EnvironmentDescription`	`withHealth(String health)` Describes the health status of the environment.
`EnvironmentDescription`	`withHealthStatus(EnvironmentHealthStatus healthStatus)` Returns the health status of the application running in your environment.
`EnvironmentDescription`	`withHealthStatus(String healthStatus)` Returns the health status of the application running in your environment.
`EnvironmentDescription`	`withPlatformArn(String platformArn)` The ARN of the platform.
`EnvironmentDescription`	`withResources(EnvironmentResourcesDescription resources)` The description of the AWS resources used by this environment.
`EnvironmentDescription`	`withSolutionStackName(String solutionStackName)` The name of the `SolutionStack` deployed with this environment.
`EnvironmentDescription`	`withStatus(EnvironmentStatus status)` The current operational status of the environment:
`EnvironmentDescription`	`withStatus(String status)` The current operational status of the environment:
`EnvironmentDescription`	`withTemplateName(String templateName)` The name of the configuration template used to originally launch this environment.
`EnvironmentDescription`	`withTier(EnvironmentTier tier)` Describes the current tier of this environment.
`EnvironmentDescription`	`withVersionLabel(String versionLabel)` The application version deployed in this environment.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnvironmentDescription
```
public EnvironmentDescription()
```
- Method Detail
  - setEnvironmentName
```
public void setEnvironmentName(String environmentName)
```
    The name of this environment.
    
    Parameters:
    
    environmentName - The name of this environment.
  - getEnvironmentName
```
public String getEnvironmentName()
```
    The name of this environment.
    
    Returns:
    
    The name of this environment.
  - withEnvironmentName
```
public EnvironmentDescription withEnvironmentName(String environmentName)
```
    The name of this environment.
    
    Parameters:
    
    environmentName - The name of this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentId
```
public void setEnvironmentId(String environmentId)
```
    The ID of this environment.
    
    Parameters:
    
    environmentId - The ID of this environment.
  - getEnvironmentId
```
public String getEnvironmentId()
```
    The ID of this environment.
    
    Returns:
    
    The ID of this environment.
  - withEnvironmentId
```
public EnvironmentDescription withEnvironmentId(String environmentId)
```
    The ID of this environment.
    
    Parameters:
    
    environmentId - The ID of this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApplicationName
```
public void setApplicationName(String applicationName)
```
    The name of the application associated with this environment.
    
    Parameters:
    
    applicationName - The name of the application associated with this environment.
  - getApplicationName
```
public String getApplicationName()
```
    The name of the application associated with this environment.
    
    Returns:
    
    The name of the application associated with this environment.
  - withApplicationName
```
public EnvironmentDescription withApplicationName(String applicationName)
```
    The name of the application associated with this environment.
    
    Parameters:
    
    applicationName - The name of the application associated with this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionLabel
```
public void setVersionLabel(String versionLabel)
```
    The application version deployed in this environment.
    
    Parameters:
    
    versionLabel - The application version deployed in this environment.
  - getVersionLabel
```
public String getVersionLabel()
```
    The application version deployed in this environment.
    
    Returns:
    
    The application version deployed in this environment.
  - withVersionLabel
```
public EnvironmentDescription withVersionLabel(String versionLabel)
```
    The application version deployed in this environment.
    
    Parameters:
    
    versionLabel - The application version deployed in this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSolutionStackName
```
public void setSolutionStackName(String solutionStackName)
```
    The name of the SolutionStack deployed with this environment.
    
    Parameters:
    
    solutionStackName - The name of the SolutionStack deployed with this environment.
  - getSolutionStackName
```
public String getSolutionStackName()
```
    The name of the SolutionStack deployed with this environment.
    
    Returns:
    
    The name of the SolutionStack deployed with this environment.
  - withSolutionStackName
```
public EnvironmentDescription withSolutionStackName(String solutionStackName)
```
    The name of the SolutionStack deployed with this environment.
    
    Parameters:
    
    solutionStackName - The name of the SolutionStack deployed with this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatformArn
```
public void setPlatformArn(String platformArn)
```
    The ARN of the platform.
    
    Parameters:
    
    platformArn - The ARN of the platform.
  - getPlatformArn
```
public String getPlatformArn()
```
    The ARN of the platform.
    
    Returns:
    
    The ARN of the platform.
  - withPlatformArn
```
public EnvironmentDescription withPlatformArn(String platformArn)
```
    The ARN of the platform.
    
    Parameters:
    
    platformArn - The ARN of the platform.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the configuration template used to originally launch this environment.
    
    Parameters:
    
    templateName - The name of the configuration template used to originally launch this environment.
  - getTemplateName
```
public String getTemplateName()
```
    The name of the configuration template used to originally launch this environment.
    
    Returns:
    
    The name of the configuration template used to originally launch this environment.
  - withTemplateName
```
public EnvironmentDescription withTemplateName(String templateName)
```
    The name of the configuration template used to originally launch this environment.
    
    Parameters:
    
    templateName - The name of the configuration template used to originally launch this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    Describes this environment.
    
    Parameters:
    
    description - Describes this environment.
  - getDescription
```
public String getDescription()
```
    Describes this environment.
    
    Returns:
    
    Describes this environment.
  - withDescription
```
public EnvironmentDescription withDescription(String description)
```
    Describes this environment.
    
    Parameters:
    
    description - Describes this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointURL
```
public void setEndpointURL(String endpointURL)
```
    For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    
    Parameters:
    
    endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
  - getEndpointURL
```
public String getEndpointURL()
```
    For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    
    Returns:
    
    For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
  - withEndpointURL
```
public EnvironmentDescription withEndpointURL(String endpointURL)
```
    For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    
    Parameters:
    
    endpointURL - For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCNAME
```
public void setCNAME(String cNAME)
```
    The URL to the CNAME for this environment.
    
    Parameters:
    
    cNAME - The URL to the CNAME for this environment.
  - getCNAME
```
public String getCNAME()
```
    The URL to the CNAME for this environment.
    
    Returns:
    
    The URL to the CNAME for this environment.
  - withCNAME
```
public EnvironmentDescription withCNAME(String cNAME)
```
    The URL to the CNAME for this environment.
    
    Parameters:
    
    cNAME - The URL to the CNAME for this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateCreated
```
public void setDateCreated(Date dateCreated)
```
    The creation date for this environment.
    
    Parameters:
    
    dateCreated - The creation date for this environment.
  - getDateCreated
```
public Date getDateCreated()
```
    The creation date for this environment.
    
    Returns:
    
    The creation date for this environment.
  - withDateCreated
```
public EnvironmentDescription withDateCreated(Date dateCreated)
```
    The creation date for this environment.
    
    Parameters:
    
    dateCreated - The creation date for this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDateUpdated
```
public void setDateUpdated(Date dateUpdated)
```
    The last modified date for this environment.
    
    Parameters:
    
    dateUpdated - The last modified date for this environment.
  - getDateUpdated
```
public Date getDateUpdated()
```
    The last modified date for this environment.
    
    Returns:
    
    The last modified date for this environment.
  - withDateUpdated
```
public EnvironmentDescription withDateUpdated(Date dateUpdated)
```
    The last modified date for this environment.
    
    Parameters:
    
    dateUpdated - The last modified date for this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current operational status of the environment:
    - Launching: Environment is in the process of initial deployment.
    - Updating: Environment is in the process of updating its configuration settings or application version.
    - Ready: Environment is available to have an action performed on it, such as update or terminate.
    - Terminating: Environment is in the shut-down process.
    - Terminated: Environment is not running.
    Parameters:
    status - The current operational status of the environment:
    
    Launching: Environment is in the process of initial deployment.
    
    Updating: Environment is in the process of updating its configuration settings or application version.
    
    Ready: Environment is available to have an action performed on it, such as update or terminate.
    
    Terminating: Environment is in the shut-down process.
    
    Terminated: Environment is not running.
    See Also:
    
    EnvironmentStatus
  - getStatus
```
public String getStatus()
```
    The current operational status of the environment:
    - Launching: Environment is in the process of initial deployment.
    - Updating: Environment is in the process of updating its configuration settings or application version.
    - Ready: Environment is available to have an action performed on it, such as update or terminate.
    - Terminating: Environment is in the shut-down process.
    - Terminated: Environment is not running.
    Returns:
    The current operational status of the environment:
    
    Launching: Environment is in the process of initial deployment.
    
    Updating: Environment is in the process of updating its configuration settings or application version.
    
    Ready: Environment is available to have an action performed on it, such as update or terminate.
    
    Terminating: Environment is in the shut-down process.
    
    Terminated: Environment is not running.
    See Also:
    
    EnvironmentStatus
  - withStatus
```
public EnvironmentDescription withStatus(String status)
```
    The current operational status of the environment:
    - Launching: Environment is in the process of initial deployment.
    - Updating: Environment is in the process of updating its configuration settings or application version.
    - Ready: Environment is available to have an action performed on it, such as update or terminate.
    - Terminating: Environment is in the shut-down process.
    - Terminated: Environment is not running.
    Parameters:
    status - The current operational status of the environment:
    
    Launching: Environment is in the process of initial deployment.
    
    Updating: Environment is in the process of updating its configuration settings or application version.
    
    Ready: Environment is available to have an action performed on it, such as update or terminate.
    
    Terminating: Environment is in the shut-down process.
    
    Terminated: Environment is not running.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentStatus
  - setStatus
```
public void setStatus(EnvironmentStatus status)
```
    The current operational status of the environment:
    - Launching: Environment is in the process of initial deployment.
    - Updating: Environment is in the process of updating its configuration settings or application version.
    - Ready: Environment is available to have an action performed on it, such as update or terminate.
    - Terminating: Environment is in the shut-down process.
    - Terminated: Environment is not running.
    Parameters:
    status - The current operational status of the environment:
    
    Launching: Environment is in the process of initial deployment.
    
    Updating: Environment is in the process of updating its configuration settings or application version.
    
    Ready: Environment is available to have an action performed on it, such as update or terminate.
    
    Terminating: Environment is in the shut-down process.
    
    Terminated: Environment is not running.
    See Also:
    
    EnvironmentStatus
  - withStatus
```
public EnvironmentDescription withStatus(EnvironmentStatus status)
```
    The current operational status of the environment:
    - Launching: Environment is in the process of initial deployment.
    - Updating: Environment is in the process of updating its configuration settings or application version.
    - Ready: Environment is available to have an action performed on it, such as update or terminate.
    - Terminating: Environment is in the shut-down process.
    - Terminated: Environment is not running.
    Parameters:
    status - The current operational status of the environment:
    
    Launching: Environment is in the process of initial deployment.
    
    Updating: Environment is in the process of updating its configuration settings or application version.
    
    Ready: Environment is available to have an action performed on it, such as update or terminate.
    
    Terminating: Environment is in the shut-down process.
    
    Terminated: Environment is not running.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentStatus
  - setAbortableOperationInProgress
```
public void setAbortableOperationInProgress(Boolean abortableOperationInProgress)
```
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
    
    Parameters:
    
    abortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
  - getAbortableOperationInProgress
```
public Boolean getAbortableOperationInProgress()
```
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
    
    Returns:
    
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
  - withAbortableOperationInProgress
```
public EnvironmentDescription withAbortableOperationInProgress(Boolean abortableOperationInProgress)
```
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
    
    Parameters:
    
    abortableOperationInProgress - Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAbortableOperationInProgress
```
public Boolean isAbortableOperationInProgress()
```
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
    
    Returns:
    
    Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.
    
    true: There is an update in progress.
    
    false: There are no updates currently in progress.
  - setHealth
```
public void setHealth(String health)
```
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    - Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    - Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    - Green: Indicates the environment is healthy and fully functional.
    - Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    Default: Grey
    Parameters:
    health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    
    Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    
    Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    
    Green: Indicates the environment is healthy and fully functional.
    
    Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    
    Default: Grey
    See Also:
    
    EnvironmentHealth
  - getHealth
```
public String getHealth()
```
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    - Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    - Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    - Green: Indicates the environment is healthy and fully functional.
    - Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    Default: Grey
    Returns:
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    
    Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    
    Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    
    Green: Indicates the environment is healthy and fully functional.
    
    Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    
    Default: Grey
    See Also:
    
    EnvironmentHealth
  - withHealth
```
public EnvironmentDescription withHealth(String health)
```
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    - Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    - Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    - Green: Indicates the environment is healthy and fully functional.
    - Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    Default: Grey
    Parameters:
    health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    
    Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    
    Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    
    Green: Indicates the environment is healthy and fully functional.
    
    Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    
    Default: Grey
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealth
  - setHealth
```
public void setHealth(EnvironmentHealth health)
```
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    - Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    - Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    - Green: Indicates the environment is healthy and fully functional.
    - Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    Default: Grey
    Parameters:
    health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    
    Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    
    Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    
    Green: Indicates the environment is healthy and fully functional.
    
    Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    
    Default: Grey
    See Also:
    
    EnvironmentHealth
  - withHealth
```
public EnvironmentDescription withHealth(EnvironmentHealth health)
```
    Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    - Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    - Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    - Green: Indicates the environment is healthy and fully functional.
    - Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    Default: Grey
    Parameters:
    health - Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
    
    Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.
    
    Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.
    
    Green: Indicates the environment is healthy and fully functional.
    
    Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.
    
    Default: Grey
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealth
  - setHealthStatus
```
public void setHealthStatus(String healthStatus)
```
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Parameters:
    
    healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    See Also:
    
    EnvironmentHealthStatus
  - getHealthStatus
```
public String getHealthStatus()
```
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Returns:
    
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    See Also:
    
    EnvironmentHealthStatus
  - withHealthStatus
```
public EnvironmentDescription withHealthStatus(String healthStatus)
```
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Parameters:
    
    healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealthStatus
  - setHealthStatus
```
public void setHealthStatus(EnvironmentHealthStatus healthStatus)
```
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Parameters:
    
    healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    See Also:
    
    EnvironmentHealthStatus
  - withHealthStatus
```
public EnvironmentDescription withHealthStatus(EnvironmentHealthStatus healthStatus)
```
    Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Parameters:
    
    healthStatus - Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EnvironmentHealthStatus
  - setResources
```
public void setResources(EnvironmentResourcesDescription resources)
```
    The description of the AWS resources used by this environment.
    
    Parameters:
    
    resources - The description of the AWS resources used by this environment.
  - getResources
```
public EnvironmentResourcesDescription getResources()
```
    The description of the AWS resources used by this environment.
    
    Returns:
    
    The description of the AWS resources used by this environment.
  - withResources
```
public EnvironmentDescription withResources(EnvironmentResourcesDescription resources)
```
    The description of the AWS resources used by this environment.
    
    Parameters:
    
    resources - The description of the AWS resources used by this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTier
```
public void setTier(EnvironmentTier tier)
```
    Describes the current tier of this environment.
    
    Parameters:
    
    tier - Describes the current tier of this environment.
  - getTier
```
public EnvironmentTier getTier()
```
    Describes the current tier of this environment.
    
    Returns:
    
    Describes the current tier of this environment.
  - withTier
```
public EnvironmentDescription withTier(EnvironmentTier tier)
```
    Describes the current tier of this environment.
    
    Parameters:
    
    tier - Describes the current tier of this environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEnvironmentLinks
```
public List<EnvironmentLink> getEnvironmentLinks()
```
    A list of links to other environments in the same group.
    
    Returns:
    
    A list of links to other environments in the same group.
  - setEnvironmentLinks
```
public void setEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)
```
    A list of links to other environments in the same group.
    
    Parameters:
    
    environmentLinks - A list of links to other environments in the same group.
  - withEnvironmentLinks
```
public EnvironmentDescription withEnvironmentLinks(EnvironmentLink... environmentLinks)
```
    A list of links to other environments in the same group.
    
    NOTE: This method appends the values to the existing list (if any). Use setEnvironmentLinks(java.util.Collection) or withEnvironmentLinks(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    environmentLinks - A list of links to other environments in the same group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withEnvironmentLinks
```
public EnvironmentDescription withEnvironmentLinks(Collection<EnvironmentLink> environmentLinks)
```
    A list of links to other environments in the same group.
    
    Parameters:
    
    environmentLinks - A list of links to other environments in the same group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentArn
```
public void setEnvironmentArn(String environmentArn)
```
    The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
    
    Parameters:
    
    environmentArn - The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
  - getEnvironmentArn
```
public String getEnvironmentArn()
```
    The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
    
    Returns:
    
    The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
  - withEnvironmentArn
```
public EnvironmentDescription withEnvironmentArn(String environmentArn)
```
    The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
    
    Parameters:
    
    environmentArn - The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public EnvironmentDescription clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class EnvironmentDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentDescription

Method Detail

setEnvironmentName

getEnvironmentName

withEnvironmentName

setEnvironmentId

getEnvironmentId

withEnvironmentId

setApplicationName

getApplicationName

withApplicationName

setVersionLabel

getVersionLabel

withVersionLabel

setSolutionStackName

getSolutionStackName

withSolutionStackName

setPlatformArn

getPlatformArn

withPlatformArn

setTemplateName

getTemplateName

withTemplateName

setDescription

getDescription

withDescription

setEndpointURL

getEndpointURL

withEndpointURL

setCNAME

getCNAME

withCNAME

setDateCreated

getDateCreated

withDateCreated

setDateUpdated

getDateUpdated

withDateUpdated

setStatus

getStatus

withStatus

setStatus

withStatus

setAbortableOperationInProgress

getAbortableOperationInProgress

withAbortableOperationInProgress

isAbortableOperationInProgress

setHealth

getHealth

withHealth

setHealth

withHealth

setHealthStatus

getHealthStatus

withHealthStatus

setHealthStatus

withHealthStatus

setResources

getResources

withResources

setTier

getTier

withTier

getEnvironmentLinks

setEnvironmentLinks

withEnvironmentLinks

withEnvironmentLinks

setEnvironmentArn

getEnvironmentArn

withEnvironmentArn

toString

equals

hashCode

clone