AWS CDK Reference

Appearance

v2.273.0

HibernationOptionsProperty Struct ​

Specifies the hibernation options for the instance.

HibernationOptions is a property of the AWS::EC2::Instance resource.

Source
Generated code
Type last changed
v2.134.0 · 26 Mar 2024

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const hibernationOptionsProperty: ec2.CfnInstance.HibernationOptionsProperty = {
  configured: false,
};

Properties ​

configuredboolean | IResolvableconfiguredtyping.Union[bool, IResolvable]configuredBooleanConfiguredboolConfiguredinterface{}= false#
Set to `true` to enable your instance for hibernation.
notes

For Spot Instances, if you set Configured to true , either omit the InstanceInterruptionBehavior parameter (for SpotMarketOptions ), or set it to hibernate . When Configured is true:

  • If you omit InstanceInterruptionBehavior , it defaults to hibernate .
  • If you set InstanceInterruptionBehavior to a value other than hibernate , you'll get an error.

Default: false