Class CfnImage
A CloudFormation AWS::ImageBuilder::Image
.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.AWS.ImageBuilder.dll
Syntax (csharp)
public class CfnImage : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnImage
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::ImageBuilder::Image
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ImageBuilder;
var cfnImage = new CfnImage(this, "MyCfnImage", new CfnImageProps {
InfrastructureConfigurationArn = "infrastructureConfigurationArn",
// the properties below are optional
ContainerRecipeArn = "containerRecipeArn",
DistributionConfigurationArn = "distributionConfigurationArn",
EnhancedImageMetadataEnabled = false,
ImageRecipeArn = "imageRecipeArn",
ImageScanningConfiguration = new ImageScanningConfigurationProperty {
EcrConfiguration = new EcrConfigurationProperty {
ContainerTags = new [] { "containerTags" },
RepositoryName = "repositoryName"
},
ImageScanningEnabled = false
},
ImageTestsConfiguration = new ImageTestsConfigurationProperty {
ImageTestsEnabled = false,
TimeoutMinutes = 123
},
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnImage(Construct, String, ICfnImageProps) | Create a new |
CfnImage(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnImage(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the image. |
AttrImageId | Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder. |
AttrImageUri | Returns a list of URIs for container images created in the context Region. |
AttrName | Returns the name of the image. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContainerRecipeArn | The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline. |
DistributionConfigurationArn | The Amazon Resource Name (ARN) of the distribution configuration. |
EnhancedImageMetadataEnabled | Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list. |
ImageRecipeArn | The Amazon Resource Name (ARN) of the image recipe. |
ImageScanningConfiguration |
|
ImageTestsConfiguration | The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting. |
InfrastructureConfigurationArn | The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline. |
Tags | The tags of the image. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnImage(Construct, String, ICfnImageProps)
Create a new AWS::ImageBuilder::Image
.
public CfnImage(Construct scope, string id, ICfnImageProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnImageProps
- resource properties.
CfnImage(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnImage(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnImage(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnImage(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the image.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1
.
CloudformationAttribute: Arn
AttrImageId
Returns the AMI ID of the Amazon EC2 AMI in the Region in which you are using Image Builder.
public virtual string AttrImageId { get; }
Property Value
System.String
Remarks
Values are returned only for AMIs, and not for container images.
CloudformationAttribute: ImageId
AttrImageUri
Returns a list of URIs for container images created in the context Region.
public virtual string AttrImageUri { get; }
Property Value
System.String
Remarks
Values are returned only for container images, and not for AMIs.
CloudformationAttribute: ImageUri
AttrName
Returns the name of the image.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContainerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
public virtual string ContainerRecipeArn { get; set; }
Property Value
System.String
Remarks
DistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration.
public virtual string DistributionConfigurationArn { get; set; }
Property Value
System.String
Remarks
EnhancedImageMetadataEnabled
Indicates whether Image Builder collects additional information about the image, such as the operating system (OS) version and package list.
public virtual object EnhancedImageMetadataEnabled { get; set; }
Property Value
System.Object
Remarks
ImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe.
public virtual string ImageRecipeArn { get; set; }
Property Value
System.String
Remarks
ImageScanningConfiguration
AWS::ImageBuilder::Image.ImageScanningConfiguration
.
public virtual object ImageScanningConfiguration { get; set; }
Property Value
System.Object
Remarks
ImageTestsConfiguration
The configuration settings for your image test components, which includes a toggle that allows you to turn off tests, and a timeout setting.
public virtual object ImageTestsConfiguration { get; set; }
Property Value
System.Object
Remarks
InfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
public virtual string InfrastructureConfigurationArn { get; set; }
Property Value
System.String
Remarks
Tags
The tags of the image.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>