Class CfnImage
Creates a new image.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnImage : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnImage
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-image.html
CloudformationResource: AWS::ImageBuilder::Image
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,
ExecutionRole = "executionRole",
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" }
},
Workflows = new [] { new WorkflowConfigurationProperty {
OnFailure = "onFailure",
ParallelGroup = "parallelGroup",
Parameters = new [] { new WorkflowParameterProperty {
Name = "name",
Value = new [] { "value" }
} },
WorkflowArn = "workflowArn"
} }
});
Synopsis
Constructors
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 |
CfnImage(Construct, String, ICfnImageProps) |
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 the URI for a container image 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 defines how images are configured and tested. |
DistributionConfigurationArn | The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline. |
EnhancedImageMetadataEnabled | Collects additional information about the image being created, including the operating system (OS) version and package list. |
ExecutionRole | The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. |
ImageRecipeArn | The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. |
ImageScanningConfiguration | Contains settings for vulnerability scans. |
ImageTestsConfiguration | The image tests configuration of the image. |
InfrastructureConfigurationArn | The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags of the image. |
Workflows | Contains an array of workflow configuration objects. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
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
CfnImage(Construct, String, ICfnImageProps)
public CfnImage(Construct scope, string id, ICfnImageProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnImageProps
Resource properties.
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 the URI for a container image 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 defines how images are configured and tested.
public virtual string ContainerRecipeArn { get; set; }
Property Value
System.String
DistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
public virtual string DistributionConfigurationArn { get; set; }
Property Value
System.String
EnhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list.
public virtual object EnhancedImageMetadataEnabled { get; set; }
Property Value
System.Object
ExecutionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
public virtual string ExecutionRole { get; set; }
Property Value
System.String
ImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
public virtual string ImageRecipeArn { get; set; }
Property Value
System.String
ImageScanningConfiguration
Contains settings for vulnerability scans.
public virtual object ImageScanningConfiguration { get; set; }
Property Value
System.Object
ImageTestsConfiguration
The image tests configuration of the image.
public virtual object ImageTestsConfiguration { get; set; }
Property Value
System.Object
InfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
public virtual string InfrastructureConfigurationArn { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags of the image.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Workflows
Contains an array of workflow configuration objects.
public virtual object Workflows { get; set; }
Property Value
System.Object
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>