Class: AWSCDK::ImageBuilder::CfnImage::ImageTestsConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
image_builder/cfn_image.rb

Overview

When you create an image or container recipe with Image Builder , you can add the build or test components that are used to create the final image.

You must have at least one build component to create a recipe, but test components are not required. If you have added tests, they run after the image is created, to ensure that the target image is functional and can be used reliably for launching Amazon EC2 instances.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(image_tests_enabled: nil, timeout_minutes: nil) ⇒ ImageTestsConfigurationProperty

Returns a new instance of ImageTestsConfigurationProperty.

Parameters:

  • image_tests_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Determines if tests should run after building the image.

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

    The maximum time in minutes that tests are permitted to run.



959
960
961
962
963
964
 
# File 'image_builder/cfn_image.rb', line 959

def initialize(image_tests_enabled: nil, timeout_minutes: nil)
  @image_tests_enabled = image_tests_enabled
  Jsii::Type.check_type(@image_tests_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "imageTestsEnabled") unless @image_tests_enabled.nil?
  @timeout_minutes = timeout_minutes
  Jsii::Type.check_type(@timeout_minutes, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutMinutes") unless @timeout_minutes.nil?
end

Instance Attribute Details

#image_tests_enabled ⇒ Boolean, ... (readonly)

Determines if tests should run after building the image.

Image Builder defaults to enable tests to run following the image build, before image distribution.

Returns:

See Also:



972
973
974
 
# File 'image_builder/cfn_image.rb', line 972

def image_tests_enabled
  @image_tests_enabled
end

#timeout_minutes ⇒ Numeric? (readonly)

The maximum time in minutes that tests are permitted to run.

The timeout property is not currently active. This value is ignored.

Returns:

  • (Numeric, nil)

See Also:



979
980
981
 
# File 'image_builder/cfn_image.rb', line 979

def timeout_minutes
  @timeout_minutes
end

Class Method Details

.jsii_properties ⇒ Object 



981
982
983
984
985
986
 
# File 'image_builder/cfn_image.rb', line 981

def self.jsii_properties
  {
    :image_tests_enabled => "imageTestsEnabled",
    :timeout_minutes => "timeoutMinutes",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



988
989
990
991
992
993
994
995
 
# File 'image_builder/cfn_image.rb', line 988

def to_jsii
  result = {}
  result.merge!({
    "imageTestsEnabled" => @image_tests_enabled,
    "timeoutMinutes" => @timeout_minutes,
  })
  result.compact
end