Package software.amazon.awscdk.services.ec2

Interface CfnInstance.StateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstance.StateProperty.Jsii$Proxy

Enclosing class:

CfnInstance

@Stability(Stable)
public static interface CfnInstance.StateProperty
extends software.amazon.jsii.JsiiSerializable

Describes the current state of an instance.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 StateProperty stateProperty = StateProperty.builder()
         .code("code")
         .name("name")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInstance.StateProperty.Builder	A builder for CfnInstance.StateProperty
static final class	CfnInstance.StateProperty.Jsii$Proxy	An implementation for CfnInstance.StateProperty

Method Summary

Modifier and Type	Method	Description
static CfnInstance.StateProperty.Builder	builder()
default String	getCode()	The state of the instance as a 16-bit unsigned integer.
default String	getName()	The current state of the instance.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCode

@Stability(Stable)
@Nullable
default String getCode()

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

• 0 : pending
• 16 : running
• 32 : shutting-down
• 48 : terminated
• 64 : stopping
• 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-code

getName

@Stability(Stable)
@Nullable
default String getName()

The current state of the instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance-state.html#cfn-ec2-instance-state-name

builder

@Stability(Stable)
static CfnInstance.StateProperty.Builder builder()

Returns:

a CfnInstance.StateProperty.Builder of CfnInstance.StateProperty