@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.707Z") public class CfnImage extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnImage(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnImage(Construct scope, java.lang.String id, CfnImageProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example, arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1
.
public java.lang.String getAttrImageId()
Values are returned only for AMIs, and not for container images.
public java.lang.String getAttrImageUri()
Values are returned only for container images, and not for AMIs.
public java.lang.String getAttrName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getInfrastructureConfigurationArn()
public void setInfrastructureConfigurationArn(java.lang.String value)
public java.lang.String getContainerRecipeArn()
public void setContainerRecipeArn(java.lang.String value)
public java.lang.String getDistributionConfigurationArn()
public void setDistributionConfigurationArn(java.lang.String value)
public java.lang.Object getEnhancedImageMetadataEnabled()
public void setEnhancedImageMetadataEnabled(java.lang.Boolean value)
public void setEnhancedImageMetadataEnabled(IResolvable value)
public java.lang.String getImageRecipeArn()
public void setImageRecipeArn(java.lang.String value)
public java.lang.Object getImageScanningConfiguration()
public void setImageScanningConfiguration(IResolvable value)
public void setImageScanningConfiguration(CfnImage.ImageScanningConfigurationProperty value)
public java.lang.Object getImageTestsConfiguration()
public void setImageTestsConfiguration(IResolvable value)
public void setImageTestsConfiguration(CfnImage.ImageTestsConfigurationProperty value)