Package software.amazon.awscdk.services.imagebuilder

Class CfnImage

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.imagebuilder.CfnImage
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.427Z") @Stability(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")
         .imageScanningConfiguration(ImageScanningConfigurationProperty.builder()
                 .ecrConfiguration(EcrConfigurationProperty.builder()
                         .containerTags(List.of("containerTags"))
                         .repositoryName("repositoryName")
                         .build())
                 .imageScanningEnabled(false)
                 .build())
         .imageTestsConfiguration(ImageTestsConfigurationProperty.builder()
                 .imageTestsEnabled(false)
                 .timeoutMinutes(123)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnImage

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

    • CfnImage

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

    • CfnImage

      @Stability(Stable) public CfnImage(@NotNull 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 Details

    • inspect

      @Stability(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(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(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(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(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(Stable) @NotNull public String getAttrName()
      Returns the name of the image.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags of the image.

    • getInfrastructureConfigurationArn

      @Stability(Stable) @NotNull public String getInfrastructureConfigurationArn()
      The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

    • setInfrastructureConfigurationArn

      @Stability(Stable) public void setInfrastructureConfigurationArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

    • getContainerRecipeArn

      @Stability(Stable) @Nullable public String getContainerRecipeArn()
      The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

    • setContainerRecipeArn

      @Stability(Stable) public void setContainerRecipeArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

    • getDistributionConfigurationArn

      @Stability(Stable) @Nullable public String getDistributionConfigurationArn()
      The Amazon Resource Name (ARN) of the distribution configuration.

    • setDistributionConfigurationArn

      @Stability(Stable) public void setDistributionConfigurationArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the distribution configuration.

    • getEnhancedImageMetadataEnabled

      @Stability(Stable) @Nullable public Object getEnhancedImageMetadataEnabled()
      Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

    • setEnhancedImageMetadataEnabled

      @Stability(Stable) public void setEnhancedImageMetadataEnabled(@Nullable Boolean value)
      Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

    • setEnhancedImageMetadataEnabled

      @Stability(Stable) public void setEnhancedImageMetadataEnabled(@Nullable IResolvable value)
      Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.

    • getImageRecipeArn

      @Stability(Stable) @Nullable public String getImageRecipeArn()
      The Amazon Resource Name (ARN) of the image recipe.

    • setImageRecipeArn

      @Stability(Stable) public void setImageRecipeArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the image recipe.

    • getImageScanningConfiguration

      @Stability(Stable) @Nullable public Object getImageScanningConfiguration()
      AWS::ImageBuilder::Image.ImageScanningConfiguration.

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable IResolvable value)
      AWS::ImageBuilder::Image.ImageScanningConfiguration.

    • setImageScanningConfiguration

      @Stability(Stable) public void setImageScanningConfiguration(@Nullable CfnImage.ImageScanningConfigurationProperty value)
      AWS::ImageBuilder::Image.ImageScanningConfiguration.

    • getImageTestsConfiguration

      @Stability(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(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.

    • setImageTestsConfiguration

      @Stability(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.