Class CfnContainerRecipe
Creates a new container recipe.
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnContainerRecipe : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnContainerRecipe
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
Container recipes define how images are configured, tested, and assessed.
CloudformationResource: AWS::ImageBuilder::ContainerRecipe
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 cfnContainerRecipe = new CfnContainerRecipe(this, "MyCfnContainerRecipe", new CfnContainerRecipeProps {
Components = new [] { new ComponentConfigurationProperty {
ComponentArn = "componentArn",
Parameters = new [] { new ComponentParameterProperty {
Name = "name",
Value = new [] { "value" }
} }
} },
ContainerType = "containerType",
Name = "name",
ParentImage = "parentImage",
TargetRepository = new TargetContainerRepositoryProperty {
RepositoryName = "repositoryName",
Service = "service"
},
Version = "version",
// the properties below are optional
Description = "description",
DockerfileTemplateData = "dockerfileTemplateData",
DockerfileTemplateUri = "dockerfileTemplateUri",
ImageOsVersionOverride = "imageOsVersionOverride",
InstanceConfiguration = new InstanceConfigurationProperty {
BlockDeviceMappings = new [] { new InstanceBlockDeviceMappingProperty {
DeviceName = "deviceName",
Ebs = new EbsInstanceBlockDeviceSpecificationProperty {
DeleteOnTermination = false,
Encrypted = false,
Iops = 123,
KmsKeyId = "kmsKeyId",
SnapshotId = "snapshotId",
Throughput = 123,
VolumeSize = 123,
VolumeType = "volumeType"
},
NoDevice = "noDevice",
VirtualName = "virtualName"
} },
Image = "image"
},
KmsKeyId = "kmsKeyId",
PlatformOverride = "platformOverride",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
WorkingDirectory = "workingDirectory"
});
Synopsis
Constructors
CfnContainerRecipe(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnContainerRecipe(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnContainerRecipe(Construct, String, ICfnContainerRecipeProps) |
Properties
AttrArn | Returns the Amazon Resource Name (ARN) of the container recipe. |
AttrName | Returns the name of the container recipe. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Components | Build and test components that are included in the container recipe. |
ContainerType | Specifies the type of container, such as Docker. |
Description | The description of the container recipe. |
DockerfileTemplateData | Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. |
DockerfileTemplateUri | The S3 URI for the Dockerfile that will be used to build your container image. |
ImageOsVersionOverride | Specifies the operating system version for the base image. |
InstanceConfiguration | A group of options that can be used to configure an instance for building and testing container images. |
KmsKeyId | Identifies which KMS key is used to encrypt the container image for distribution to the target Region. |
Name | The name of the container recipe. |
ParentImage | The base image for the container recipe. |
PlatformOverride | Specifies the operating system platform when you use a custom base image. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Tags that are attached to the container recipe. |
TargetRepository | The destination repository for the container image. |
Version | The semantic version of the container recipe. |
WorkingDirectory | The working directory for use during build and test workflows. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnContainerRecipe(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnContainerRecipe(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnContainerRecipe(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnContainerRecipe(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnContainerRecipe(Construct, String, ICfnContainerRecipeProps)
public CfnContainerRecipe(Construct scope, string id, ICfnContainerRecipeProps 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 ICfnContainerRecipeProps
Resource properties.
Properties
AttrArn
Returns the Amazon Resource Name (ARN) of the container recipe.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17
.
CloudformationAttribute: Arn
AttrName
Returns the name of the container recipe.
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
Components
Build and test components that are included in the container recipe.
public virtual object Components { get; set; }
Property Value
System.Object
ContainerType
Specifies the type of container, such as Docker.
public virtual string ContainerType { get; set; }
Property Value
System.String
Description
The description of the container recipe.
public virtual string Description { get; set; }
Property Value
System.String
DockerfileTemplateData
Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
public virtual string DockerfileTemplateData { get; set; }
Property Value
System.String
DockerfileTemplateUri
The S3 URI for the Dockerfile that will be used to build your container image.
public virtual string DockerfileTemplateUri { get; set; }
Property Value
System.String
ImageOsVersionOverride
Specifies the operating system version for the base image.
public virtual string ImageOsVersionOverride { get; set; }
Property Value
System.String
InstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.
public virtual object InstanceConfiguration { get; set; }
Property Value
System.Object
KmsKeyId
Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Name
The name of the container recipe.
public virtual string Name { get; set; }
Property Value
System.String
ParentImage
The base image for the container recipe.
public virtual string ParentImage { get; set; }
Property Value
System.String
PlatformOverride
Specifies the operating system platform when you use a custom base image.
public virtual string PlatformOverride { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Tags that are attached to the container recipe.
public virtual IDictionary<string, string> TagsRaw { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
TargetRepository
The destination repository for the container image.
public virtual object TargetRepository { get; set; }
Property Value
System.Object
Version
The semantic version of the container recipe.
public virtual string Version { get; set; }
Property Value
System.String
WorkingDirectory
The working directory for use during build and test workflows.
public virtual string WorkingDirectory { get; set; }
Property Value
System.String
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>