@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:39.824Z") @Stability(value=Stable) public interface CfnImageRecipeProps extends software.amazon.jsii.JsiiSerializable
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.*;
CfnImageRecipeProps cfnImageRecipeProps = CfnImageRecipeProps.builder()
.components(List.of(ComponentConfigurationProperty.builder()
.componentArn("componentArn")
.parameters(List.of(ComponentParameterProperty.builder()
.name("name")
.value(List.of("value"))
.build()))
.build()))
.name("name")
.parentImage("parentImage")
.version("version")
// the properties below are optional
.additionalInstanceConfiguration(AdditionalInstanceConfigurationProperty.builder()
.systemsManagerAgent(SystemsManagerAgentProperty.builder()
.uninstallAfterBuild(false)
.build())
.userDataOverride("userDataOverride")
.build())
.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()))
.description("description")
.tags(Map.of(
"tagsKey", "tags"))
.workingDirectory("workingDirectory")
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnImageRecipeProps.Builder
A builder for
CfnImageRecipeProps |
static class |
CfnImageRecipeProps.Jsii$Proxy
An implementation for
CfnImageRecipeProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnImageRecipeProps.Builder |
builder() |
default Object |
getAdditionalInstanceConfiguration()
Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
|
default Object |
getBlockDeviceMappings()
The block device mappings to apply when creating images from this recipe.
|
Object |
getComponents()
The components of the image recipe.
|
default String |
getDescription()
The description of the image recipe.
|
String |
getName()
The name of the image recipe.
|
String |
getParentImage()
The parent image of the image recipe.
|
default Map<String,String> |
getTags()
The tags of the image recipe.
|
String |
getVersion()
The semantic version of the image recipe.
|
default String |
getWorkingDirectory()
The working directory to be used during build and test workflows.
|
@Stability(value=Stable) @NotNull Object getComponents()
Components are orchestration documents that define a sequence of steps for downloading, installing, configuring, and testing software packages. They also define validation and security hardening steps. A component is defined using a YAML document format.
@Stability(value=Stable) @NotNull String getName()
@Stability(value=Stable) @NotNull String getParentImage()
The string must be either an Image ARN or an AMI ID.
@Stability(value=Stable) @NotNull String getVersion()
@Stability(value=Stable) @Nullable default Object getAdditionalInstanceConfiguration()
Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.
@Stability(value=Stable) @Nullable default Object getBlockDeviceMappings()
@Stability(value=Stable) @Nullable default String getDescription()
@Stability(value=Stable) @Nullable default Map<String,String> getTags()
@Stability(value=Stable) @Nullable default String getWorkingDirectory()
@Stability(value=Stable) static CfnImageRecipeProps.Builder builder()
CfnImageRecipeProps.Builder of CfnImageRecipePropsCopyright © 2022. All rights reserved.