Class CfnContainerRecipe
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.imagebuilder.CfnContainerRecipe
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:11.088Z")
@Stability(Stable)
public class CfnContainerRecipe
extends CfnResource
implements IInspectable, ITaggable
Creates a new container recipe.
Container recipes define how images are configured, tested, and assessed.
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.*; CfnContainerRecipe cfnContainerRecipe = CfnContainerRecipe.Builder.create(this, "MyCfnContainerRecipe") .components(List.of(ComponentConfigurationProperty.builder() .componentArn("componentArn") .parameters(List.of(ComponentParameterProperty.builder() .name("name") .value(List.of("value")) .build())) .build())) .containerType("containerType") .name("name") .parentImage("parentImage") .targetRepository(TargetContainerRepositoryProperty.builder() .repositoryName("repositoryName") .service("service") .build()) .version("version") // the properties below are optional .description("description") .dockerfileTemplateData("dockerfileTemplateData") .dockerfileTemplateUri("dockerfileTemplateUri") .imageOsVersionOverride("imageOsVersionOverride") .instanceConfiguration(InstanceConfigurationProperty.builder() .blockDeviceMappings(List.of(InstanceBlockDeviceMappingProperty.builder() .deviceName("deviceName") .ebs(EbsInstanceBlockDeviceSpecificationProperty.builder() .deleteOnTermination(false) .encrypted(false) .iops(123) .kmsKeyId("kmsKeyId") .snapshotId("snapshotId") .throughput(123) .volumeSize(123) .volumeType("volumeType") .build()) .noDevice("noDevice") .virtualName("virtualName") .build())) .image("image") .build()) .kmsKeyId("kmsKeyId") .platformOverride("platformOverride") .tags(Map.of( "tagsKey", "tags")) .workingDirectory("workingDirectory") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnContainerRecipe
.static interface
Configuration details of the component.static interface
Contains a key/value pair that sets the named component parameter.static interface
Amazon EBS-specific block device mapping specifications.static interface
Defines block device mappings for the instance used to configure your image.static interface
Defines a custom base AMI and block device mapping configurations of an instance used for building and testing container images.static interface
The container repository where the output container image is stored.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnContainerRecipe
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnContainerRecipe
(software.amazon.jsii.JsiiObjectRef objRef) CfnContainerRecipe
(software.constructs.Construct scope, String id, CfnContainerRecipeProps props) -
Method Summary
Modifier and TypeMethodDescriptionReturns the Amazon Resource Name (ARN) of the container recipe.Returns the name of the container recipe.Build and test components that are included in the container recipe.Specifies the type of container, such as Docker.The description of the container recipe.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.The S3 URI for the Dockerfile that will be used to build your container image.Specifies the operating system version for the base image.A group of options that can be used to configure an instance for building and testing container images.Identifies which KMS key is used to encrypt the container image for distribution to the target Region.getName()
The name of the container recipe.The base image for the container recipe.Specifies the operating system platform when you use a custom base image.getTags()
Tag Manager which manages the tags for this resource.Tags that are attached to the container recipe.The destination repository for the container image.The semantic version of the container recipe.The working directory for use during build and test workflows.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setComponents
(List<Object> value) Build and test components that are included in the container recipe.void
setComponents
(IResolvable value) Build and test components that are included in the container recipe.void
setContainerType
(String value) Specifies the type of container, such as Docker.void
setDescription
(String value) The description of the container recipe.void
setDockerfileTemplateData
(String value) 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.void
setDockerfileTemplateUri
(String value) The S3 URI for the Dockerfile that will be used to build your container image.void
setImageOsVersionOverride
(String value) Specifies the operating system version for the base image.void
A group of options that can be used to configure an instance for building and testing container images.void
A group of options that can be used to configure an instance for building and testing container images.void
setKmsKeyId
(String value) Identifies which KMS key is used to encrypt the container image for distribution to the target Region.void
The name of the container recipe.void
setParentImage
(String value) The base image for the container recipe.void
setPlatformOverride
(String value) Specifies the operating system platform when you use a custom base image.void
setTagsRaw
(Map<String, String> value) Tags that are attached to the container recipe.void
setTargetRepository
(IResolvable value) The destination repository for the container image.void
The destination repository for the container image.void
setVersion
(String value) The semantic version of the container recipe.void
setWorkingDirectory
(String value) The working directory for use during build and test workflows.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnContainerRecipe
protected CfnContainerRecipe(software.amazon.jsii.JsiiObjectRef objRef) -
CfnContainerRecipe
protected CfnContainerRecipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnContainerRecipe
@Stability(Stable) public CfnContainerRecipe(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnContainerRecipeProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
Returns the Amazon Resource Name (ARN) of the container recipe.For example,
arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/mybasicrecipe/2020.12.17
. -
getAttrName
Returns the name of the container recipe. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getComponents
Build and test components that are included in the container recipe. -
setComponents
Build and test components that are included in the container recipe. -
setComponents
Build and test components that are included in the container recipe. -
getContainerType
Specifies the type of container, such as Docker. -
setContainerType
Specifies the type of container, such as Docker. -
getName
The name of the container recipe. -
setName
The name of the container recipe. -
getParentImage
The base image for the container recipe. -
setParentImage
The base image for the container recipe. -
getTargetRepository
The destination repository for the container image. -
setTargetRepository
The destination repository for the container image. -
setTargetRepository
@Stability(Stable) public void setTargetRepository(@NotNull CfnContainerRecipe.TargetContainerRepositoryProperty value) The destination repository for the container image. -
getVersion
The semantic version of the container recipe. -
setVersion
The semantic version of the container recipe. -
getDescription
The description of the container recipe. -
setDescription
The description of the container recipe. -
getDockerfileTemplateData
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. -
setDockerfileTemplateData
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. -
getDockerfileTemplateUri
The S3 URI for the Dockerfile that will be used to build your container image. -
setDockerfileTemplateUri
The S3 URI for the Dockerfile that will be used to build your container image. -
getImageOsVersionOverride
Specifies the operating system version for the base image. -
setImageOsVersionOverride
Specifies the operating system version for the base image. -
getInstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images. -
setInstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images. -
setInstanceConfiguration
@Stability(Stable) public void setInstanceConfiguration(@Nullable CfnContainerRecipe.InstanceConfigurationProperty value) A group of options that can be used to configure an instance for building and testing container images. -
getKmsKeyId
Identifies which KMS key is used to encrypt the container image for distribution to the target Region. -
setKmsKeyId
Identifies which KMS key is used to encrypt the container image for distribution to the target Region. -
getPlatformOverride
Specifies the operating system platform when you use a custom base image. -
setPlatformOverride
Specifies the operating system platform when you use a custom base image. -
getTagsRaw
Tags that are attached to the container recipe. -
setTagsRaw
Tags that are attached to the container recipe. -
getWorkingDirectory
The working directory for use during build and test workflows. -
setWorkingDirectory
The working directory for use during build and test workflows.
-