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 UpdateEnvironmentRequest

Hierarchy

Properties

applyDuringMaintenanceWindow? desiredCapacity? engineVersion? environmentId instanceType? preferredMaintenanceWindow?

Properties

Optional applyDuringMaintenanceWindow

applyDuringMaintenanceWindow?: boolean

Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Optional desiredCapacity

desiredCapacity?: number

The desired capacity for the runtime environment to update.

Optional engineVersion

engineVersion?: string

The version of the runtime engine for the runtime environment.

environmentId

environmentId: undefined | string

The unique identifier of the runtime environment that you want to update.

Optional instanceType

instanceType?: string

The instance type for the runtime environment to update.

Optional preferredMaintenanceWindow

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.

Settings

Member Visibility

Theme