ec2_stop_instances: Stops an Amazon EBS-backed instance

View source: R/ec2_operations.R

ec2_stop_instancesR Documentation

Stops an Amazon EBS-backed instance

Description

Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.

See https://www.paws-r-sdk.com/docs/ec2_stop_instances/ for full documentation.

Usage

ec2_stop_instances(InstanceIds, Hibernate = NULL, DryRun = NULL, Force = NULL)

Arguments

InstanceIds

[required] The IDs of the instances.

Hibernate

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Force

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false


paws.compute documentation built on Sept. 12, 2023, 1:28 a.m.