AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

EnvironmentDescription

import "github.com/aws/aws-sdk-go/service/elasticbeanstalk"

type EnvironmentDescription struct { AbortableOperationInProgress *bool `type:"boolean"` ApplicationName *string `min:"1" type:"string"` CNAME *string `min:"1" type:"string"` DateCreated *time.Time `type:"timestamp"` DateUpdated *time.Time `type:"timestamp"` Description *string `type:"string"` EndpointURL *string `type:"string"` EnvironmentArn *string `type:"string"` EnvironmentId *string `type:"string"` EnvironmentLinks []*EnvironmentLink `type:"list"` EnvironmentName *string `min:"4" type:"string"` Health *string `type:"string" enum:"EnvironmentHealth"` HealthStatus *string `type:"string" enum:"EnvironmentHealthStatus"` PlatformArn *string `type:"string"` Resources *EnvironmentResourcesDescription `type:"structure"` SolutionStackName *string `type:"string"` Status *string `type:"string" enum:"EnvironmentStatus"` TemplateName *string `min:"1" type:"string"` Tier *EnvironmentTier `type:"structure"` VersionLabel *string `min:"1" type:"string"` }

Describes the properties of an environment.

AbortableOperationInProgress

Type: *bool

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.

ApplicationName

Type: *string

The name of the application associated with this environment.

CNAME

Type: *string

The URL to the CNAME for this environment.

DateCreated

Type: *time.Time

The creation date for this environment.

DateUpdated

Type: *time.Time

The last modified date for this environment.

Description

Type: *string

Describes this environment.

EndpointURL

Type: *string

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

EnvironmentArn

Type: *string

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

EnvironmentId

Type: *string

The ID of this environment.

EnvironmentLinks

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/environment-cfg-manifest.html) for details.

EnvironmentName

Type: *string

The name of this environment.

Health

Type: *string

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

HealthStatus

Type: *string

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses (https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced-status.html).

PlatformArn

Type: *string

The ARN of the platform.

Resources

Describes the AWS resources in use by this environment. This data is not live data.

SolutionStackName

Type: *string

The name of the SolutionStack deployed with this environment.

Status

Type: *string

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.

TemplateName

Type: *string

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

Tier

Describes the properties of an environment tier

VersionLabel

Type: *string

The application version deployed in this environment.

Method

GoString

func (s EnvironmentDescription) GoString() string

GoString returns the string representation

SetAbortableOperationInProgress

func (s *EnvironmentDescription) SetAbortableOperationInProgress(v bool) *EnvironmentDescription

SetAbortableOperationInProgress sets the AbortableOperationInProgress field's value.

SetApplicationName

func (s *EnvironmentDescription) SetApplicationName(v string) *EnvironmentDescription

SetApplicationName sets the ApplicationName field's value.

SetCNAME

func (s *EnvironmentDescription) SetCNAME(v string) *EnvironmentDescription

SetCNAME sets the CNAME field's value.

SetDateCreated

func (s *EnvironmentDescription) SetDateCreated(v time.Time) *EnvironmentDescription

SetDateCreated sets the DateCreated field's value.

SetDateUpdated

func (s *EnvironmentDescription) SetDateUpdated(v time.Time) *EnvironmentDescription

SetDateUpdated sets the DateUpdated field's value.

SetDescription

func (s *EnvironmentDescription) SetDescription(v string) *EnvironmentDescription

SetDescription sets the Description field's value.

SetEndpointURL

func (s *EnvironmentDescription) SetEndpointURL(v string) *EnvironmentDescription

SetEndpointURL sets the EndpointURL field's value.

SetEnvironmentArn

func (s *EnvironmentDescription) SetEnvironmentArn(v string) *EnvironmentDescription

SetEnvironmentArn sets the EnvironmentArn field's value.

SetEnvironmentId

func (s *EnvironmentDescription) SetEnvironmentId(v string) *EnvironmentDescription

SetEnvironmentId sets the EnvironmentId field's value.

func (s *EnvironmentDescription) SetEnvironmentLinks(v []*EnvironmentLink) *EnvironmentDescription

SetEnvironmentLinks sets the EnvironmentLinks field's value.

SetEnvironmentName

func (s *EnvironmentDescription) SetEnvironmentName(v string) *EnvironmentDescription

SetEnvironmentName sets the EnvironmentName field's value.

SetHealth

func (s *EnvironmentDescription) SetHealth(v string) *EnvironmentDescription

SetHealth sets the Health field's value.

SetHealthStatus

func (s *EnvironmentDescription) SetHealthStatus(v string) *EnvironmentDescription

SetHealthStatus sets the HealthStatus field's value.

SetPlatformArn

func (s *EnvironmentDescription) SetPlatformArn(v string) *EnvironmentDescription

SetPlatformArn sets the PlatformArn field's value.

SetResources

func (s *EnvironmentDescription) SetResources(v *EnvironmentResourcesDescription) *EnvironmentDescription

SetResources sets the Resources field's value.

SetSolutionStackName

func (s *EnvironmentDescription) SetSolutionStackName(v string) *EnvironmentDescription

SetSolutionStackName sets the SolutionStackName field's value.

SetStatus

func (s *EnvironmentDescription) SetStatus(v string) *EnvironmentDescription

SetStatus sets the Status field's value.

SetTemplateName

func (s *EnvironmentDescription) SetTemplateName(v string) *EnvironmentDescription

SetTemplateName sets the TemplateName field's value.

SetTier

func (s *EnvironmentDescription) SetTier(v *EnvironmentTier) *EnvironmentDescription

SetTier sets the Tier field's value.

SetVersionLabel

func (s *EnvironmentDescription) SetVersionLabel(v string) *EnvironmentDescription

SetVersionLabel sets the VersionLabel field's value.

String

func (s EnvironmentDescription) String() string

String returns the string representation

On this page: