Package com.amazonaws.services.elasticbeanstalk.model

Class EnvironmentDescription

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

      • 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

      • 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​(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.

      • 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