Class: AWSCDK::Lightsail::CfnInstance::StateProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Lightsail::CfnInstance::StateProperty

Defined in:

lightsail/cfn_instance.rb

Overview

State is a property of the AWS::Lightsail::Instance resource. It describes the status code and the state (for example, running ) of an instance.

See Also:

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

Instance Attribute Summary

• #code ⇒ Numeric^? readonly

  The status code of the instance.

• #name ⇒ String^? readonly

  The state of the instance (for example, running or pending ).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(code: nil, name: nil) ⇒ StateProperty constructor

  A new instance of StateProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(code: nil, name: nil) ⇒ StateProperty

Returns a new instance of StateProperty.

Parameters:

• code (Numeric, nil) (defaults to: nil) —

  The status code of the instance.

• name (String, nil) (defaults to: nil) —

  The state of the instance (for example, running or pending ).

# File 'lightsail/cfn_instance.rb', line 1315

def initialize(code: nil, name: nil)
  @code = code
  Jsii::Type.check_type(@code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "code") unless @code.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#code ⇒ Numeric^? (readonly)

The status code of the instance.

Returns:

• (Numeric, nil)

See Also:

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

# File 'lightsail/cfn_instance.rb', line 1326

def code
  @code
end

#name ⇒ String^? (readonly)

The state of the instance (for example, running or pending ).

Returns:

• (String, nil)

See Also:

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

# File 'lightsail/cfn_instance.rb', line 1331

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'lightsail/cfn_instance.rb', line 1333

def self.jsii_properties
  {
    :code => "code",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'lightsail/cfn_instance.rb', line 1340

def to_jsii
  result = {}
  result.merge!({
    "code" => @code,
    "name" => @name,
  })
  result.compact
end