CfnImage

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:36.707Z")
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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnImage.Builder` A fluent builder for `CfnImage`.
`static interface`	`CfnImage.EcrConfigurationProperty` Example:
`static interface`	`CfnImage.ImageScanningConfigurationProperty` Example:
`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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnImage(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` Returns the Amazon Resource Name (ARN) of the image.
`java.lang.String`	`getAttrImageId()` Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.
`java.lang.String`	`getAttrImageUri()` Returns a list of URIs for container images created in the context Region.
`java.lang.String`	`getAttrName()` Returns the name of the image.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getContainerRecipeArn()` The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
`java.lang.String`	`getDistributionConfigurationArn()` The Amazon Resource Name (ARN) of the distribution configuration.
`java.lang.Object`	`getEnhancedImageMetadataEnabled()` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`java.lang.String`	`getImageRecipeArn()` The Amazon Resource Name (ARN) of the image recipe.
`java.lang.Object`	`getImageScanningConfiguration()` `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
`java.lang.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.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setContainerRecipeArn(java.lang.String value)` The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
`void`	`setDistributionConfigurationArn(java.lang.String value)` The Amazon Resource Name (ARN) of the distribution configuration.
`void`	`setEnhancedImageMetadataEnabled(java.lang.Boolean value)` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`void`	`setEnhancedImageMetadataEnabled(IResolvable value)` Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
`void`	`setImageRecipeArn(java.lang.String value)` The Amazon Resource Name (ARN) of the image recipe.
`void`	`setImageScanningConfiguration(CfnImage.ImageScanningConfigurationProperty value)` `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
`void`	`setImageScanningConfiguration(IResolvable value)` `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
`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(java.lang.String value)` The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnImage(Construct scope,
                java.lang.String id,
                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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.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
```
public java.lang.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
```
public java.lang.String getAttrName()
```
    Returns the name of the image.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags of the image.
  - getInfrastructureConfigurationArn
```
public java.lang.String getInfrastructureConfigurationArn()
```
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
  - setInfrastructureConfigurationArn
```
public void setInfrastructureConfigurationArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
  - getContainerRecipeArn
```
public java.lang.String getContainerRecipeArn()
```
    The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
  - setContainerRecipeArn
```
public void setContainerRecipeArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
  - getDistributionConfigurationArn
```
public java.lang.String getDistributionConfigurationArn()
```
    The Amazon Resource Name (ARN) of the distribution configuration.
  - setDistributionConfigurationArn
```
public void setDistributionConfigurationArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the distribution configuration.
  - getEnhancedImageMetadataEnabled
```
public java.lang.Object getEnhancedImageMetadataEnabled()
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - setEnhancedImageMetadataEnabled
```
public void setEnhancedImageMetadataEnabled(java.lang.Boolean value)
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - setEnhancedImageMetadataEnabled
```
public void setEnhancedImageMetadataEnabled(IResolvable value)
```
    Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
  - getImageRecipeArn
```
public java.lang.String getImageRecipeArn()
```
    The Amazon Resource Name (ARN) of the image recipe.
  - setImageRecipeArn
```
public void setImageRecipeArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the image recipe.
  - getImageScanningConfiguration
```
public java.lang.Object getImageScanningConfiguration()
```
    `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
  - setImageScanningConfiguration
```
public void setImageScanningConfiguration(IResolvable value)
```
    `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
  - setImageScanningConfiguration
```
public void setImageScanningConfiguration(CfnImage.ImageScanningConfigurationProperty value)
```
    `AWS::ImageBuilder::Image.ImageScanningConfiguration`.
  - getImageTestsConfiguration
```
public java.lang.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
```
public 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.
  - setImageTestsConfiguration
```
public 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.

Class CfnImage

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnImage

CfnImage

CfnImage

Method Detail

inspect

renderProperties

getAttrArn

getAttrImageId

getAttrImageUri

getAttrName

getCfnProperties

getTags

getInfrastructureConfigurationArn

setInfrastructureConfigurationArn

getContainerRecipeArn

setContainerRecipeArn

getDistributionConfigurationArn

setDistributionConfigurationArn

getEnhancedImageMetadataEnabled

setEnhancedImageMetadataEnabled

setEnhancedImageMetadataEnabled

getImageRecipeArn

setImageRecipeArn

getImageScanningConfiguration

setImageScanningConfiguration

setImageScanningConfiguration

getImageTestsConfiguration

setImageTestsConfiguration

setImageTestsConfiguration