Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.elasticbeanstalk.model
Class CreateEnvironmentResult

java.lang.Object
  extended by com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentResult
All Implemented Interfaces:
Serializable

public class CreateEnvironmentResult
extends Object
implements Serializable

Describes the properties of an environment.

See Also:
Serialized Form

Constructor Summary
CreateEnvironmentResult()
           
 
Method Summary
 boolean equals(Object obj)
           
 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()
          The URL to the LoadBalancer for this environment.
 String getEnvironmentId()
          The ID of this environment.
 String getEnvironmentName()
          The name of this environment.
 String getHealth()
          Describes the health status of the environment.
 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: Launching: Environment is in the process of initial deployment.
 String getTemplateName()
          The name of the configuration template used to originally launch this environment.
 String getVersionLabel()
          The application version deployed in this environment.
 int hashCode()
           
 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)
          The URL to the LoadBalancer for this environment.
 void setEnvironmentId(String environmentId)
          The ID of this environment.
 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 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: Launching: Environment is in the process of initial deployment.
 void setStatus(String status)
          The current operational status of the environment: Launching: Environment is in the process of initial deployment.
 void setTemplateName(String templateName)
          The name of the configuration template used to originally launch 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.
 CreateEnvironmentResult withApplicationName(String applicationName)
          The name of the application associated with this environment.
 CreateEnvironmentResult withCNAME(String cNAME)
          The URL to the CNAME for this environment.
 CreateEnvironmentResult withDateCreated(Date dateCreated)
          The creation date for this environment.
 CreateEnvironmentResult withDateUpdated(Date dateUpdated)
          The last modified date for this environment.
 CreateEnvironmentResult withDescription(String description)
          Describes this environment.
 CreateEnvironmentResult withEndpointURL(String endpointURL)
          The URL to the LoadBalancer for this environment.
 CreateEnvironmentResult withEnvironmentId(String environmentId)
          The ID of this environment.
 CreateEnvironmentResult withEnvironmentName(String environmentName)
          The name of this environment.
 CreateEnvironmentResult withHealth(EnvironmentHealth health)
          Describes the health status of the environment.
 CreateEnvironmentResult withHealth(String health)
          Describes the health status of the environment.
 CreateEnvironmentResult withResources(EnvironmentResourcesDescription resources)
          The description of the AWS resources used by this environment.
 CreateEnvironmentResult withSolutionStackName(String solutionStackName)
          The name of the SolutionStack deployed with this environment.
 CreateEnvironmentResult withStatus(EnvironmentStatus status)
          The current operational status of the environment: Launching: Environment is in the process of initial deployment.
 CreateEnvironmentResult withStatus(String status)
          The current operational status of the environment: Launching: Environment is in the process of initial deployment.
 CreateEnvironmentResult withTemplateName(String templateName)
          The name of the configuration template used to originally launch this environment.
 CreateEnvironmentResult 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

CreateEnvironmentResult

public CreateEnvironmentResult()
Method Detail

getEnvironmentName

public String getEnvironmentName()
The name of this environment.

Constraints:
Length: 4 - 23

Returns:
The name of this environment.

setEnvironmentName

public void setEnvironmentName(String environmentName)
The name of this environment.

Constraints:
Length: 4 - 23

Parameters:
environmentName - The name of this environment.

withEnvironmentName

public CreateEnvironmentResult withEnvironmentName(String environmentName)
The name of this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 23

Parameters:
environmentName - The name of this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getEnvironmentId

public String getEnvironmentId()
The ID of this environment.

Returns:
The ID of this environment.

setEnvironmentId

public void setEnvironmentId(String environmentId)
The ID of this environment.

Parameters:
environmentId - The ID of this environment.

withEnvironmentId

public CreateEnvironmentResult withEnvironmentId(String environmentId)
The ID of this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:
environmentId - The ID of this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getApplicationName

public String getApplicationName()
The name of the application associated with this environment.

Constraints:
Length: 1 - 100

Returns:
The name of the application associated with this environment.

setApplicationName

public void setApplicationName(String applicationName)
The name of the application associated with this environment.

Constraints:
Length: 1 - 100

Parameters:
applicationName - The name of the application associated with this environment.

withApplicationName

public CreateEnvironmentResult withApplicationName(String applicationName)
The name of the application associated with this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:
applicationName - The name of the application associated with this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getVersionLabel

public String getVersionLabel()
The application version deployed in this environment.

Constraints:
Length: 1 - 100

Returns:
The application version deployed in this environment.

setVersionLabel

public void setVersionLabel(String versionLabel)
The application version deployed in this environment.

Constraints:
Length: 1 - 100

Parameters:
versionLabel - The application version deployed in this environment.

withVersionLabel

public CreateEnvironmentResult withVersionLabel(String versionLabel)
The application version deployed in this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:
versionLabel - The application version deployed in this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getSolutionStackName

public String getSolutionStackName()
The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

Returns:
The name of the SolutionStack deployed with this environment.

setSolutionStackName

public void setSolutionStackName(String solutionStackName)
The name of the SolutionStack deployed with this environment.

Constraints:
Length: 0 - 100

Parameters:
solutionStackName - The name of the SolutionStack deployed with this environment.

withSolutionStackName

public CreateEnvironmentResult withSolutionStackName(String solutionStackName)
The name of the SolutionStack deployed with this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 100

Parameters:
solutionStackName - The name of the SolutionStack deployed with this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()
The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

Returns:
The name of the configuration template used to originally launch this environment.

setTemplateName

public void setTemplateName(String templateName)
The name of the configuration template used to originally launch this environment.

Constraints:
Length: 1 - 100

Parameters:
templateName - The name of the configuration template used to originally launch this environment.

withTemplateName

public CreateEnvironmentResult withTemplateName(String templateName)
The name of the configuration template used to originally launch this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:
templateName - The name of the configuration template used to originally launch this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getDescription

public String getDescription()
Describes this environment.

Constraints:
Length: 0 - 200

Returns:
Describes this environment.

setDescription

public void setDescription(String description)
Describes this environment.

Constraints:
Length: 0 - 200

Parameters:
description - Describes this environment.

withDescription

public CreateEnvironmentResult withDescription(String description)
Describes this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 200

Parameters:
description - Describes this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getEndpointURL

public String getEndpointURL()
The URL to the LoadBalancer for this environment.

Returns:
The URL to the LoadBalancer for this environment.

setEndpointURL

public void setEndpointURL(String endpointURL)
The URL to the LoadBalancer for this environment.

Parameters:
endpointURL - The URL to the LoadBalancer for this environment.

withEndpointURL

public CreateEnvironmentResult withEndpointURL(String endpointURL)
The URL to the LoadBalancer for this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:
endpointURL - The URL to the LoadBalancer for this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getCNAME

public String getCNAME()
The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

Returns:
The URL to the CNAME for this environment.

setCNAME

public void setCNAME(String cNAME)
The URL to the CNAME for this environment.

Constraints:
Length: 1 - 255

Parameters:
cNAME - The URL to the CNAME for this environment.

withCNAME

public CreateEnvironmentResult withCNAME(String cNAME)
The URL to the CNAME for this environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:
cNAME - The URL to the CNAME for this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getDateCreated

public Date getDateCreated()
The creation date for this environment.

Returns:
The creation date for this environment.

setDateCreated

public void setDateCreated(Date dateCreated)
The creation date for this environment.

Parameters:
dateCreated - The creation date for this environment.

withDateCreated

public CreateEnvironmentResult withDateCreated(Date dateCreated)
The creation date for this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:
dateCreated - The creation date for this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getDateUpdated

public Date getDateUpdated()
The last modified date for this environment.

Returns:
The last modified date for this environment.

setDateUpdated

public void setDateUpdated(Date dateUpdated)
The last modified date for this environment.

Parameters:
dateUpdated - The last modified date for this environment.

withDateUpdated

public CreateEnvironmentResult withDateUpdated(Date dateUpdated)
The last modified date for this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:
dateUpdated - The last modified date for this environment.
Returns:
A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()
The current operational status of the environment:

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

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

setStatus

public void setStatus(String status)
The current operational status of the environment:

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

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 CreateEnvironmentResult withStatus(String status)
The current operational status of the environment:

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

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:
A reference to this updated 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:

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

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 CreateEnvironmentResult withStatus(EnvironmentStatus status)
The current operational status of the environment:

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Launching, Updating, Ready, Terminating, Terminated

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:
A reference to this updated object so that method calls can be chained together.
See Also:
EnvironmentStatus

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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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

Constraints:
Allowed Values: Green, Yellow, Red, 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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

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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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

Constraints:
Allowed Values: Green, Yellow, Red, 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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 CreateEnvironmentResult 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Green, Yellow, Red, 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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:
A reference to this updated 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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

Constraints:
Allowed Values: Green, Yellow, Red, 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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 CreateEnvironmentResult 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Green, Yellow, Red, 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 working.

Yellow: Indicates that something is wrong, the application might not be available, but the instances appear running.

Green: Indicates the environment is healthy and fully functional.

  • 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:
A reference to this updated object so that method calls can be chained together.
See Also:
EnvironmentHealth

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.

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.

withResources

public CreateEnvironmentResult withResources(EnvironmentResourcesDescription resources)
The description of the AWS resources used by this environment.

Returns a reference to this object so that method calls can be chained together.

Parameters:
resources - The description of the AWS resources used by this environment.
Returns:
A reference to this updated 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()

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.