ImageRecipeArgs class

The set of arguments for ImageRecipe. The set of arguments for ImageRecipe.

Constructors

ImageRecipeArgs({Input<Map<String, String>?>? amiTags, Input<List<ImageRecipeBlockDeviceMapping>?>? blockDeviceMappings, required Input<List<ImageRecipeComponent>> components, Input<String?>? description, Input<String?>? name, required Input<String> parentImage, Input<String?>? region, Input<ImageRecipeSystemsManagerAgent?>? systemsManagerAgent, Input<Map<String, String>?>? tags, Input<String?>? userDataBase64, required Input<String> version, Input<String?>? workingDirectory})
Creates a new ImageRecipeArgs. amiTags Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution. Maximum of 50 tags. blockDeviceMappings Configuration block(s) with block device mappings for the image recipe. Detailed below. components Ordered configuration block(s) with components for the image recipe. Detailed below. description Description of the image recipe. name Name of the image recipe. parentImage The image recipe uses this image as a base from which to build your customized image. The value can be the base image ARN, an AMI ID, or an SSM Parameter referencing the AMI. For an SSM Parameter, enter the prefix ssm:, followed by the parameter name or ARN. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. systemsManagerAgent Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below. tags Key-value map of resource tags for the image recipe. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. userDataBase64 Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance. version The semantic version of the image recipe, which specifies the version in the following format, with numeric values in each position to indicate a specific version: major.minor.patch. For example: 1.0.0. workingDirectory The working directory to be used during build and test workflows.
const
ImageRecipeArgs.fromMap(Map<String, dynamic> map)
factory

Properties

amiTags → Input<Map<String, String>?>?
Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution. Maximum of 50 tags.
final
blockDeviceMappings → Input<List<ImageRecipeBlockDeviceMapping>?>?
Configuration block(s) with block device mappings for the image recipe. Detailed below.
final
components → Input<List<ImageRecipeComponent>>
Ordered configuration block(s) with components for the image recipe. Detailed below.
final
description → Input<String?>?
Description of the image recipe.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
Name of the image recipe.
final
parentImage → Input<String>
The image recipe uses this image as a base from which to build your customized image. The value can be the base image ARN, an AMI ID, or an SSM Parameter referencing the AMI. For an SSM Parameter, enter the prefix ssm:, followed by the parameter name or ARN.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
systemsManagerAgent → Input<ImageRecipeSystemsManagerAgent?>?
Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags for the image recipe. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
userDataBase64 → Input<String?>?
Base64 encoded user data. Use this to provide commands or a command script to run when you launch your build instance.
final
version → Input<String>
The semantic version of the image recipe, which specifies the version in the following format, with numeric values in each position to indicate a specific version: major.minor.patch. For example: 1.0.0.
final
workingDirectory → Input<String?>?
The working directory to be used during build and test workflows.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited