Class CfnContainerRecipe

Creates a new container recipe.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnContainerRecipe

Implements

IInspectable

IContainerRecipeRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnContainerRecipe : CfnResource, IInspectable, IContainerRecipeRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnContainerRecipe Inherits CfnResource Implements IInspectable, IContainerRecipeRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

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 {
                 ContainerType = "containerType",
                 Name = "name",
                 ParentImage = "parentImage",
                 TargetRepository = new TargetContainerRepositoryProperty {
                     RepositoryName = "repositoryName",
                     Service = "service"
                 },
                 Version = "version",

                 // the properties below are optional
                 Components = new [] { new ComponentConfigurationProperty {
                     ComponentArn = "componentArn",
                     Parameters = new [] { new ComponentParameterProperty {
                         Name = "name",
                         Value = new [] { "value" }
                     } }
                 } },
                 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(Construct, string, ICfnContainerRecipeProps)

Create a new AWS::ImageBuilder::ContainerRecipe.

Properties

AttrArn	Returns the Amazon Resource Name (ARN) of the container recipe.
AttrLatestVersion	The latest version references of the container recipe.
AttrLatestVersionArn	The Amazon Resource Name (ARN) of the container recipe.
AttrLatestVersionMajor	The latest version ARN of the created container recipe, with the same major version.
AttrLatestVersionMinor	The latest version ARN of the created container recipe, with the same minor version.
AttrLatestVersionPatch	The latest version ARN of the created container recipe, with the same patch version.
AttrName	Returns the name of the container recipe.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a new container recipe.
Components	Build and test components that are included in the container recipe.
ContainerRecipeRef	A reference to a ContainerRecipe resource.
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	The Amazon Resource Name (ARN) that uniquely 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 customizations specified in 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

ArnForContainerRecipe(IContainerRecipeRef)	Creates a new container recipe.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a new container recipe.

Constructors

CfnContainerRecipe(Construct, string, ICfnContainerRecipeProps)

Create a new AWS::ImageBuilder::ContainerRecipe.

public CfnContainerRecipe(Construct scope, string id, ICfnContainerRecipeProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnContainerRecipeProps

Resource properties.

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Properties

AttrArn

Returns the Amazon Resource Name (ARN) of the container recipe.

public virtual string AttrArn { get; }

Property Value

string

Remarks

For example, arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17 .

CloudformationAttribute: Arn

AttrLatestVersion

The latest version references of the container recipe.

public virtual IResolvable AttrLatestVersion { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: LatestVersion

AttrLatestVersionArn

The Amazon Resource Name (ARN) of the container recipe.

public virtual string AttrLatestVersionArn { get; }

Property Value

string

Remarks

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

CloudformationAttribute: LatestVersion.Arn

AttrLatestVersionMajor

The latest version ARN of the created container recipe, with the same major version.

public virtual string AttrLatestVersionMajor { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Major

AttrLatestVersionMinor

The latest version ARN of the created container recipe, with the same minor version.

public virtual string AttrLatestVersionMinor { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Minor

AttrLatestVersionPatch

The latest version ARN of the created container recipe, with the same patch version.

public virtual string AttrLatestVersionPatch { get; }

Property Value

string

Remarks

CloudformationAttribute: LatestVersion.Patch

AttrName

Returns the name of the container recipe.

public virtual string AttrName { get; }

Property Value

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

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

CfnProperties

Creates a new container recipe.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Components

Build and test components that are included in the container recipe.

public virtual object? Components { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnContainerRecipe.IComponentConfigurationProperty)[]

ContainerRecipeRef

A reference to a ContainerRecipe resource.

public virtual IContainerRecipeReference ContainerRecipeRef { get; }

Property Value

IContainerRecipeReference

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

ContainerType

Specifies the type of container, such as Docker.

public virtual string ContainerType { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Description

The description of the container recipe.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

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

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

DockerfileTemplateUri

The S3 URI for the Dockerfile that will be used to build your container image.

public virtual string? DockerfileTemplateUri { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

ImageOsVersionOverride

Specifies the operating system version for the base image.

public virtual string? ImageOsVersionOverride { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or CfnContainerRecipe.IInstanceConfigurationProperty

KmsKeyId

The Amazon Resource Name (ARN) that uniquely 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

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Name

The name of the container recipe.

public virtual string Name { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

ParentImage

The base image for customizations specified in the container recipe.

public virtual string ParentImage { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

PlatformOverride

Specifies the operating system platform when you use a custom base image.

public virtual string? PlatformOverride { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

TagsRaw

Tags that are attached to the container recipe.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

TargetRepository

The destination repository for the container image.

public virtual object TargetRepository { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnContainerRecipe.ITargetContainerRepositoryProperty

Version

The semantic version of the container recipe.

public virtual string Version { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

WorkingDirectory

The working directory for use during build and test workflows.

public virtual string? WorkingDirectory { get; set; }

Property Value

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Methods

ArnForContainerRecipe(IContainerRecipeRef)

Creates a new container recipe.

public static string ArnForContainerRecipe(IContainerRecipeRef resource)

Parameters

resource IContainerRecipeRef

Returns

string

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

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 {
                 ContainerType = "containerType",
                 Name = "name",
                 ParentImage = "parentImage",
                 TargetRepository = new TargetContainerRepositoryProperty {
                     RepositoryName = "repositoryName",
                     Service = "service"
                 },
                 Version = "version",

                 // the properties below are optional
                 Components = new [] { new ComponentConfigurationProperty {
                     ComponentArn = "componentArn",
                     Parameters = new [] { new ComponentParameterProperty {
                         Name = "name",
                         Value = new [] { "value" }
                     } }
                 } },
                 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"
             });

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.

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a new container recipe.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

Container recipes define how images are configured, tested, and assessed.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html

CloudformationResource: AWS::ImageBuilder::ContainerRecipe

ExampleMetadata: fixture=_generated

Implements

IInspectable

IContainerRecipeRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable