Package software.amazon.awssdk.services.elasticbeanstalk.model

Interface EnvironmentDescription.Builder

    • Method Detail

      • environmentName

        EnvironmentDescription.Builder environmentName​(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.

      • environmentId

        EnvironmentDescription.Builder environmentId​(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.

      • applicationName

        EnvironmentDescription.Builder applicationName​(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.

      • versionLabel

        EnvironmentDescription.Builder versionLabel​(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.

      • solutionStackName

        EnvironmentDescription.Builder solutionStackName​(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.

      • platformArn

        EnvironmentDescription.Builder platformArn​(String platformArn)

        The ARN of the platform version.

        Parameters:
        platformArn - The ARN of the platform version.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • templateName

        EnvironmentDescription.Builder templateName​(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.

      • description

        EnvironmentDescription.Builder description​(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.

      • endpointURL

        EnvironmentDescription.Builder endpointURL​(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.

      • cname

        EnvironmentDescription.Builder cname​(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.

      • dateCreated

        EnvironmentDescription.Builder dateCreated​(Instant 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.

      • dateUpdated

        EnvironmentDescription.Builder dateUpdated​(Instant 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.

      • status

        EnvironmentDescription.Builder status​(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, EnvironmentStatus

      • status

        EnvironmentDescription.Builder status​(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, EnvironmentStatus

      • abortableOperationInProgress

        EnvironmentDescription.Builder abortableOperationInProgress​(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.

      • health

        EnvironmentDescription.Builder health​(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 RestartEnvironment 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 RestartEnvironment request.

        Default: Grey

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentHealth, EnvironmentHealth

      • health

        EnvironmentDescription.Builder health​(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 RestartEnvironment 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 RestartEnvironment request.

        Default: Grey

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EnvironmentHealth, EnvironmentHealth

      • resources

        EnvironmentDescription.Builder resources​(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.

      • tier

        EnvironmentDescription.Builder tier​(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.

      • environmentLinks

        EnvironmentDescription.Builder environmentLinks​(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.

      • environmentLinks

        EnvironmentDescription.Builder environmentLinks​(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.

      • environmentArn

        EnvironmentDescription.Builder environmentArn​(String environmentArn)

        The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

        Parameters:
        environmentArn - The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • operationsRole

        EnvironmentDescription.Builder operationsRole​(String operationsRole)

        The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

        Parameters:
        operationsRole - The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.