software.amazon.awscdk.services.imagebuilder

Class CfnImageRecipe

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.CfnImageRecipe

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.953Z")
 @Stability(value=Stable)
public class CfnImageRecipe
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::ImageRecipe`.

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.*;
 CfnImageRecipe cfnImageRecipe = CfnImageRecipe.Builder.create(this, "MyCfnImageRecipe")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnImageRecipe.AdditionalInstanceConfigurationProperty Example:
static class	CfnImageRecipe.Builder A fluent builder for CfnImageRecipe.
static interface	CfnImageRecipe.ComponentConfigurationProperty Example:
static interface	CfnImageRecipe.ComponentParameterProperty Example:
static interface	CfnImageRecipe.EbsInstanceBlockDeviceSpecificationProperty Example:
static interface	CfnImageRecipe.InstanceBlockDeviceMappingProperty Example:
static interface	CfnImageRecipe.SystemsManagerAgentProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnImageRecipe(software.constructs.Construct scope, String id, CfnImageRecipeProps props) Create a new `AWS::ImageBuilder::ImageRecipe`.
protected	CfnImageRecipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnImageRecipe(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdditionalInstanceConfiguration() `AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.
String	getAttrArn()
String	getAttrName()
Object	getBlockDeviceMappings() `AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.
protected Map<String,Object>	getCfnProperties()
Object	getComponents() `AWS::ImageBuilder::ImageRecipe.Components`.
String	getDescription() `AWS::ImageBuilder::ImageRecipe.Description`.
String	getName() `AWS::ImageBuilder::ImageRecipe.Name`.
String	getParentImage() `AWS::ImageBuilder::ImageRecipe.ParentImage`.
TagManager	getTags() `AWS::ImageBuilder::ImageRecipe.Tags`.
String	getVersion() `AWS::ImageBuilder::ImageRecipe.Version`.
String	getWorkingDirectory() `AWS::ImageBuilder::ImageRecipe.WorkingDirectory`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalInstanceConfiguration(CfnImageRecipe.AdditionalInstanceConfigurationProperty value) `AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.
void	setAdditionalInstanceConfiguration(IResolvable value) `AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.
void	setBlockDeviceMappings(IResolvable value) `AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.
void	setBlockDeviceMappings(List<Object> value) `AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.
void	setComponents(IResolvable value) `AWS::ImageBuilder::ImageRecipe.Components`.
void	setComponents(List<Object> value) `AWS::ImageBuilder::ImageRecipe.Components`.
void	setDescription(String value) `AWS::ImageBuilder::ImageRecipe.Description`.
void	setName(String value) `AWS::ImageBuilder::ImageRecipe.Name`.
void	setParentImage(String value) `AWS::ImageBuilder::ImageRecipe.ParentImage`.
void	setVersion(String value) `AWS::ImageBuilder::ImageRecipe.Version`.
void	setWorkingDirectory(String value) `AWS::ImageBuilder::ImageRecipe.WorkingDirectory`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnImageRecipe

protected CfnImageRecipe(software.amazon.jsii.JsiiObjectRef objRef)

CfnImageRecipe

protected CfnImageRecipe(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnImageRecipe

@Stability(value=Stable)
public CfnImageRecipe(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               CfnImageRecipeProps props)

Create a new `AWS::ImageBuilder::ImageRecipe`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAdditionalInstanceConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAdditionalInstanceConfiguration()

`AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.

setAdditionalInstanceConfiguration

@Stability(value=Stable)
public void setAdditionalInstanceConfiguration(@Nullable
                                                                        CfnImageRecipe.AdditionalInstanceConfigurationProperty value)

`AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.

setAdditionalInstanceConfiguration

@Stability(value=Stable)
public void setAdditionalInstanceConfiguration(@Nullable
                                                                        IResolvable value)

`AWS::ImageBuilder::ImageRecipe.AdditionalInstanceConfiguration`.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getBlockDeviceMappings

@Stability(value=Stable)
 @Nullable
public Object getBlockDeviceMappings()

`AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.

setBlockDeviceMappings

@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
                                                            IResolvable value)

`AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.

setBlockDeviceMappings

@Stability(value=Stable)
public void setBlockDeviceMappings(@Nullable
                                                            List<Object> value)

`AWS::ImageBuilder::ImageRecipe.BlockDeviceMappings`.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getComponents

@Stability(value=Stable)
 @NotNull
public Object getComponents()

`AWS::ImageBuilder::ImageRecipe.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@NotNull
                                                   IResolvable value)

`AWS::ImageBuilder::ImageRecipe.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@NotNull
                                                   List<Object> value)

`AWS::ImageBuilder::ImageRecipe.Components`.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

`AWS::ImageBuilder::ImageRecipe.Description`.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

`AWS::ImageBuilder::ImageRecipe.Description`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::ImageBuilder::ImageRecipe.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::ImageBuilder::ImageRecipe.Name`.

getParentImage

@Stability(value=Stable)
 @NotNull
public String getParentImage()

`AWS::ImageBuilder::ImageRecipe.ParentImage`.

setParentImage

@Stability(value=Stable)
public void setParentImage(@NotNull
                                                    String value)

`AWS::ImageBuilder::ImageRecipe.ParentImage`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::ImageBuilder::ImageRecipe.Tags`.

getVersion

@Stability(value=Stable)
 @NotNull
public String getVersion()

`AWS::ImageBuilder::ImageRecipe.Version`.

setVersion

@Stability(value=Stable)
public void setVersion(@NotNull
                                                String value)

`AWS::ImageBuilder::ImageRecipe.Version`.

getWorkingDirectory

@Stability(value=Stable)
 @Nullable
public String getWorkingDirectory()

`AWS::ImageBuilder::ImageRecipe.WorkingDirectory`.

setWorkingDirectory

@Stability(value=Stable)
public void setWorkingDirectory(@Nullable
                                                         String value)

`AWS::ImageBuilder::ImageRecipe.WorkingDirectory`.