software.amazon.awscdk.services.imagebuilder

Class CfnImage

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.imagebuilder.CfnImage

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.817Z")
 @Stability(value=Stable)
public class CfnImage
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::Image`.

An image build version. An image is a customized, secure, and up-to-date “golden” server image that is pre-installed and pre-configured with software and settings to meet specific IT standards.

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.*;
 CfnImage cfnImage = CfnImage.Builder.create(this, "MyCfnImage")
         .infrastructureConfigurationArn("infrastructureConfigurationArn")
         // the properties below are optional
         .containerRecipeArn("containerRecipeArn")
         .distributionConfigurationArn("distributionConfigurationArn")
         .enhancedImageMetadataEnabled(false)
         .imageRecipeArn("imageRecipeArn")
         .imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
                 .imageTestsEnabled(false)
                 .timeoutMinutes(123)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnImage.Builder A fluent builder for CfnImage.
static interface	CfnImage.ImageTestsConfigurationProperty 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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnImage(software.constructs.Construct scope, String id, CfnImageProps props) Create a new `AWS::ImageBuilder::Image`.
protected	CfnImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnImage(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Returns the Amazon Resource Name (ARN) of the image.
String	getAttrImageId() Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.
String	getAttrImageUri() Returns a list of URIs for container images created in the context Region.
String	getAttrName() Returns the name of the image.
protected Map<String,Object>	getCfnProperties()
String	getContainerRecipeArn() The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
String	getDistributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration.
Object	getEnhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
String	getImageRecipeArn() The Amazon Resource Name (ARN) of the image recipe.
Object	getImageTestsConfiguration() The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
String	getInfrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
TagManager	getTags() The tags of the image.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerRecipeArn(String value) The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
void	setDistributionConfigurationArn(String value) The Amazon Resource Name (ARN) of the distribution configuration.
void	setEnhancedImageMetadataEnabled(Boolean value) Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setEnhancedImageMetadataEnabled(IResolvable value) Collects additional information about the image being created, including the operating system (OS) version and package list.
void	setImageRecipeArn(String value) The Amazon Resource Name (ARN) of the image recipe.
void	setImageTestsConfiguration(CfnImage.ImageTestsConfigurationProperty value) The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
void	setImageTestsConfiguration(IResolvable value) The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
void	setInfrastructureConfigurationArn(String value) The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnImage

protected CfnImage(software.amazon.jsii.JsiiObjectRef objRef)

CfnImage

protected CfnImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnImage

@Stability(value=Stable)
public CfnImage(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnImageProps props)

Create a new `AWS::ImageBuilder::Image`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

Returns the Amazon Resource Name (ARN) of the image.

For example, arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1 .

getAttrImageId

@Stability(value=Stable)
 @NotNull
public String getAttrImageId()

Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.

Values are returned only for AMIs, and not for container images.

getAttrImageUri

@Stability(value=Stable)
 @NotNull
public String getAttrImageUri()

Returns a list of URIs for container images created in the context Region.

Values are returned only for container images, and not for AMIs.

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

Returns the name of the image.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags of the image.

getInfrastructureConfigurationArn

@Stability(value=Stable)
 @NotNull
public String getInfrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

setInfrastructureConfigurationArn

@Stability(value=Stable)
public void setInfrastructureConfigurationArn(@NotNull
                                                                       String value)

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

getContainerRecipeArn

@Stability(value=Stable)
 @Nullable
public String getContainerRecipeArn()

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

setContainerRecipeArn

@Stability(value=Stable)
public void setContainerRecipeArn(@Nullable
                                                           String value)

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

getDistributionConfigurationArn

@Stability(value=Stable)
 @Nullable
public String getDistributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration.

setDistributionConfigurationArn

@Stability(value=Stable)
public void setDistributionConfigurationArn(@Nullable
                                                                     String value)

The Amazon Resource Name (ARN) of the distribution configuration.

getEnhancedImageMetadataEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnhancedImageMetadataEnabled()

Collects additional information about the image being created, including the operating system (OS) version and package list.

This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

setEnhancedImageMetadataEnabled

@Stability(value=Stable)
public void setEnhancedImageMetadataEnabled(@Nullable
                                                                     Boolean value)

Collects additional information about the image being created, including the operating system (OS) version and package list.

This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

setEnhancedImageMetadataEnabled

@Stability(value=Stable)
public void setEnhancedImageMetadataEnabled(@Nullable
                                                                     IResolvable value)

Collects additional information about the image being created, including the operating system (OS) version and package list.

This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

getImageRecipeArn

@Stability(value=Stable)
 @Nullable
public String getImageRecipeArn()

The Amazon Resource Name (ARN) of the image recipe.

setImageRecipeArn

@Stability(value=Stable)
public void setImageRecipeArn(@Nullable
                                                       String value)

The Amazon Resource Name (ARN) of the image recipe.

getImageTestsConfiguration

@Stability(value=Stable)
 @Nullable
public Object getImageTestsConfiguration()

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

setImageTestsConfiguration

@Stability(value=Stable)
public void setImageTestsConfiguration(@Nullable
                                                                CfnImage.ImageTestsConfigurationProperty value)

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.

setImageTestsConfiguration

@Stability(value=Stable)
public void setImageTestsConfiguration(@Nullable
                                                                IResolvable value)

The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.