EnvironmentDescription ¶

class EnvironmentDescription(TypedDict, closed=True):
    environment_name: NotRequired[
        "capo_elastic_beanstalk.types.environment_name.EnvironmentName"
    ]
    """<p>The name of this environment.</p>"""
    environment_id: NotRequired[
        "capo_elastic_beanstalk.types.environment_id.EnvironmentId"
    ]
    """<p>The ID of this environment.</p>"""
    application_name: NotRequired[
        "capo_elastic_beanstalk.types.application_name.ApplicationName"
    ]
    """<p>The name of the application associated with this environment.</p>"""
    version_label: NotRequired[
        "capo_elastic_beanstalk.types.version_label.VersionLabel"
    ]
    """<p>The application version deployed in this environment.</p>"""
    solution_stack_name: NotRequired[
        "capo_elastic_beanstalk.types.solution_stack_name.SolutionStackName"
    ]
    """<p> The name of the <code>SolutionStack</code> deployed with this environment. </p>"""
    platform_arn: NotRequired["capo_elastic_beanstalk.types.platform_arn.PlatformArn"]
    """<p>The ARN of the platform version.</p>"""
    template_name: NotRequired[
        "capo_elastic_beanstalk.types.configuration_template_name.ConfigurationTemplateName"
    ]
    """<p>The name of the configuration template used to originally launch this environment.</p>"""
    description: NotRequired["capo_elastic_beanstalk.types.description.Description"]
    """<p>Describes this environment.</p>"""
    endpoint_url: NotRequired["capo_elastic_beanstalk.types.endpoint_url.EndpointURL"]
    """<p>For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.</p>"""
    cname: NotRequired["capo_elastic_beanstalk.types.dns_cname.DNSCname"]
    """<p>The URL to the CNAME for this environment.</p>"""
    date_created: NotRequired["capo_elastic_beanstalk.types.creation_date.CreationDate"]
    """<p>The creation date for this environment.</p>"""
    date_updated: NotRequired["capo_elastic_beanstalk.types.update_date.UpdateDate"]
    """<p>The last modified date for this environment.</p>"""
    status: NotRequired[
        "capo_elastic_beanstalk.types.environment_status.EnvironmentStatus"
    ]
    """<p>The current operational status of the environment:</p> <ul> <li> <p> <code>Aborting</code>: Environment is in the process of aborting a deployment.</p> </li> <li> <p> <code>Launching</code>: Environment is in the process of initial deployment.</p> </li> <li> <p> <code>LinkingFrom</code>: Environment is in the process of being linked to by another environment. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html">Environment links</a> for details.</p> </li> <li> <p> <code>LinkingTo</code>: Environment is in the process of linking to another environment. See <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-links.html">Environment links</a> for details.</p> </li> <li> <p> <code>Updating</code>: Environment is in the process of updating its configuration settings or application version.</p> </li> <li> <p> <code>Ready</code>: Environment is available to have an action performed on it, such as update or terminate.</p> </li> <li> <p> <code>Terminating</code>: Environment is in the shut-down process.</p> </li> <li> <p> <code>Terminated</code>: Environment is not running.</p> </li> </ul>"""
    abortable_operation_in_progress: NotRequired[
        "capo_elastic_beanstalk.types.abortable_operation_in_progress.AbortableOperationInProgress"
    ]
    """<p>Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.</p> <p> <code>true:</code> There is an update in progress. </p> <p> <code>false:</code> There are no updates currently in progress. </p>"""
    health: NotRequired[
        "capo_elastic_beanstalk.types.environment_health.EnvironmentHealth"
    ]
    """<p>Describes the health status of the environment. Elastic Beanstalk indicates the failure levels for a running environment:</p> <ul> <li> <p> <code>Red</code>: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.</p> </li> <li> <p> <code>Yellow</code>: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.</p> </li> <li> <p> <code>Green</code>: Indicates the environment is healthy and fully functional.</p> </li> <li> <p> <code>Grey</code>: 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 <code>UpdateEnvironment</code> or <code>RestartEnvironment</code> request.</p> </li> </ul> <p> Default: <code>Grey</code> </p>"""
    health_status: NotRequired[
        "capo_elastic_beanstalk.types.environment_health_status.EnvironmentHealthStatus"
    ]
    """<p>Returns the health status of the application running in your environment. For more information, see <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html">Health Colors and Statuses</a>.</p>"""
    resources: NotRequired[
        "capo_elastic_beanstalk.types.environment_resources_description.EnvironmentResourcesDescription"
    ]
    """<p>The description of the Amazon Web Services resources used by this environment.</p>"""
    tier: NotRequired["capo_elastic_beanstalk.types.environment_tier.EnvironmentTier"]
    """<p>Describes the current tier of this environment.</p>"""
    environment_links: NotRequired[
        "capo_elastic_beanstalk.types.environment_links.EnvironmentLinks"
    ]
    """<p>A list of links to other environments in the same group.</p>"""
    environment_arn: NotRequired[
        "capo_elastic_beanstalk.types.environment_arn.EnvironmentArn"
    ]
    """<p>The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.</p>"""
    operations_role: NotRequired[
        "capo_elastic_beanstalk.types.operations_role.OperationsRole"
    ]
    """<important> <p>The operations role feature of Elastic Beanstalk is in beta release and is subject to change.</p> </important> <p>The Amazon Resource Name (ARN) of the environment's operations role.</p>"""