Class: Aws::EC2::Types::StopInstancesRequest
- Inherits:
 - 
      Struct
      
        
- Object
 - Struct
 - Aws::EC2::Types::StopInstancesRequest
 
 
- Includes:
 - Structure
 
- Defined in:
 - lib/aws-sdk-ec2/types.rb
 
Overview
Constant Summary collapse
- SENSITIVE =
 []
Instance Attribute Summary collapse
- 
  
    
      #dry_run  ⇒ Boolean 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response.
 - 
  
    
      #force  ⇒ Boolean 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Forces the instances to stop.
 - 
  
    
      #hibernate  ⇒ Boolean 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Hibernates the instance if the instance was enabled for hibernation at launch.
 - 
  
    
      #instance_ids  ⇒ Array<String> 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The IDs of the instances.
 
Instance Attribute Details
#dry_run ⇒ Boolean
Checks whether you have the required permissions for the operation, 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`.
      67882 67883 67884 67885 67886 67887 67888 67889  | 
    
      # File 'lib/aws-sdk-ec2/types.rb', line 67882 class StopInstancesRequest < Struct.new( :instance_ids, :hibernate, :dry_run, :force) SENSITIVE = [] include Aws::Structure end  | 
  
#force ⇒ Boolean
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`
      67882 67883 67884 67885 67886 67887 67888 67889  | 
    
      # File 'lib/aws-sdk-ec2/types.rb', line 67882 class StopInstancesRequest < Struct.new( :instance_ids, :hibernate, :dry_run, :force) SENSITIVE = [] include Aws::Structure end  | 
  
#hibernate ⇒ Boolean
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`
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html
      67882 67883 67884 67885 67886 67887 67888 67889  | 
    
      # File 'lib/aws-sdk-ec2/types.rb', line 67882 class StopInstancesRequest < Struct.new( :instance_ids, :hibernate, :dry_run, :force) SENSITIVE = [] include Aws::Structure end  | 
  
#instance_ids ⇒ Array<String>
The IDs of the instances.
      67882 67883 67884 67885 67886 67887 67888 67889  | 
    
      # File 'lib/aws-sdk-ec2/types.rb', line 67882 class StopInstancesRequest < Struct.new( :instance_ids, :hibernate, :dry_run, :force) SENSITIVE = [] include Aws::Structure end  |