Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface GetEnvironmentCommandOutputProtected

The output of GetEnvironmentCommand.



$metadata: ResponseMetadata

Metadata pertaining to this request.

actualCapacity?: number

The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

creationTime: undefined | Date

The timestamp when the runtime environment was created.

description?: string

The description of the runtime environment.

engineType: undefined | string

The target platform for the runtime environment.

engineVersion: undefined | string

The version of the runtime engine.

environmentArn: undefined | string

The Amazon Resource Name (ARN) of the runtime environment.

environmentId: undefined | string

The unique identifier of the runtime environment.

highAvailabilityConfig?: HighAvailabilityConfig

The desired capacity of the high availability configuration for the runtime environment.

instanceType: undefined | string

The type of instance underlying the runtime environment.

kmsKeyId?: string

The identifier of a customer managed key.

loadBalancerArn?: string

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

name: undefined | string

The name of the runtime environment. Must be unique within the account.

pendingMaintenance?: PendingMaintenance

Indicates the pending maintenance scheduled on this environment.

preferredMaintenanceWindow?: string

Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

publiclyAccessible?: boolean

Whether applications running in this runtime environment are publicly accessible.

securityGroupIds: undefined | string[]

The unique identifiers of the security groups assigned to this runtime environment.

status: undefined | string

The status of the runtime environment.

statusReason?: string

The reason for the reported status.

storageConfigurations?: StorageConfiguration[]

The storage configurations defined for the runtime environment.

subnetIds: undefined | string[]

The unique identifiers of the subnets assigned to this runtime environment.

tags?: Record<string, string>

The tags defined for this runtime environment.

vpcId: undefined | string

The unique identifier for the VPC used with this runtime environment.