EnvironmentDescription

public struct EnvironmentDescription : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let abortableOperationInProgress: Bool?

  • The name of the application associated with this environment.

    Declaration

    Swift

    public let applicationName: String?

  • The URL to the CNAME for this environment.

    Declaration

    Swift

    public let cname: String?

  • The creation date for this environment.

    Declaration

    Swift

    public let dateCreated: TimeStamp?

  • The last modified date for this environment.

    Declaration

    Swift

    public let dateUpdated: TimeStamp?

  • Describes this environment.

    Declaration

    Swift

    public let description: String?

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

    Declaration

    Swift

    public let endpointURL: String?

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

    Declaration

    Swift

    public let environmentArn: String?

  • The ID of this environment.

    Declaration

    Swift

    public let environmentId: String?

  • A list of links to other environments in the same group.

    Declaration

    Swift

    public let environmentLinks: [EnvironmentLink]?

  • The name of this environment.

    Declaration

    Swift

    public let environmentName: 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

    Declaration

    Swift

    public let health: EnvironmentHealth?

  • Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

    Declaration

    Swift

    public let healthStatus: EnvironmentHealthStatus?

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

    Declaration

    Swift

    public let operationsRole: String?

  • The ARN of the platform version.

    Declaration

    Swift

    public let platformArn: String?

  • The description of the AWS resources used by this environment.

    Declaration

    Swift

    public let resources: EnvironmentResourcesDescription?

  • The name of the SolutionStack deployed with this environment.

    Declaration

    Swift

    public let solutionStackName: 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.

    Declaration

    Swift

    public let status: EnvironmentStatus?

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

    Declaration

    Swift

    public let templateName: String?

  • Describes the current tier of this environment.

    Declaration

    Swift

    public let tier: EnvironmentTier?

  • The application version deployed in this environment.

    Declaration

    Swift

    public let versionLabel: String?

  • Undocumented

    Declaration

    Swift

    public init(abortableOperationInProgress: Bool? = nil, applicationName: String? = nil, cname: String? = nil, dateCreated: TimeStamp? = nil, dateUpdated: TimeStamp? = nil, description: String? = nil, endpointURL: String? = nil, environmentArn: String? = nil, environmentId: String? = nil, environmentLinks: [EnvironmentLink]? = nil, environmentName: String? = nil, health: EnvironmentHealth? = nil, healthStatus: EnvironmentHealthStatus? = nil, operationsRole: String? = nil, platformArn: String? = nil, resources: EnvironmentResourcesDescription? = nil, solutionStackName: String? = nil, status: EnvironmentStatus? = nil, templateName: String? = nil, tier: EnvironmentTier? = nil, versionLabel: String? = nil)