Package software.amazon.awscdk.services.imagebuilder

Interface CfnImage.ImageTestsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnImage.ImageTestsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnImage

@Stability(Stable)
public static interface CfnImage.ImageTestsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

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.imagebuilder.*;
 ImageTestsConfigurationProperty imageTestsConfigurationProperty = ImageTestsConfigurationProperty.builder()
         .imageTestsEnabled(false)
         .timeoutMinutes(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnImage.ImageTestsConfigurationProperty.Builder	builder()
default Object	getImageTestsEnabled()	Determines if tests should run after building the image.
default Number	getTimeoutMinutes()	The maximum time in minutes that tests are permitted to run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getImageTestsEnabled

@Stability(Stable)
@Nullable
default Object getImageTestsEnabled()

Determines if tests should run after building the image.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html#cfn-imagebuilder-image-imagetestsconfiguration-imagetestsenabled

getTimeoutMinutes

@Stability(Stable)
@Nullable
default Number getTimeoutMinutes()

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

The timeoutMinutes attribute is not currently active. This value is ignored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagetestsconfiguration.html#cfn-imagebuilder-image-imagetestsconfiguration-timeoutminutes

builder

@Stability(Stable)
static CfnImage.ImageTestsConfigurationProperty.Builder builder()

Returns:

a CfnImage.ImageTestsConfigurationProperty.Builder of CfnImage.ImageTestsConfigurationProperty