Package software.amazon.awscdk.services.mgn

Class CfnLaunchConfigurationTemplate

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.mgn.CfnLaunchConfigurationTemplate
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ILaunchConfigurationTemplateRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:56.184Z") @Stability(Stable) public class CfnLaunchConfigurationTemplate extends CfnResource implements IInspectable, ILaunchConfigurationTemplateRef, ITaggableV2
Account level Launch Configuration Template for AWS Application Migration Service.

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.mgn.*;
 CfnLaunchConfigurationTemplate cfnLaunchConfigurationTemplate = CfnLaunchConfigurationTemplate.Builder.create(this, "MyCfnLaunchConfigurationTemplate")
         .associatePublicIpAddress(false)
         .bootMode("bootMode")
         .copyPrivateIp(false)
         .copyTags(false)
         .enableMapAutoTagging(false)
         .enableParametersEncryption(false)
         .largeVolumeConf(LaunchTemplateDiskConfProperty.builder()
                 .iops(123)
                 .throughput(123)
                 .volumeType("volumeType")
                 .build())
         .launchDisposition("launchDisposition")
         .licensing(LicensingProperty.builder()
                 .osByol(false)
                 .build())
         .mapAutoTaggingMpeId("mapAutoTaggingMpeId")
         .parametersEncryptionKey("parametersEncryptionKey")
         .postLaunchActions(PostLaunchActionsProperty.builder()
                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                 .deployment("deployment")
                 .s3LogBucket("s3LogBucket")
                 .s3OutputKeyPrefix("s3OutputKeyPrefix")
                 .ssmDocuments(List.of(SsmDocumentProperty.builder()
                         .actionName("actionName")
                         .ssmDocumentName("ssmDocumentName")
                         // the properties below are optional
                         .externalParameters(Map.of(
                                 "externalParametersKey", SsmExternalParameterProperty.builder()
                                         .dynamicPath("dynamicPath")
                                         .build()))
                         .mustSucceedForCutover(false)
                         .parameters(Map.of(
                                 "parametersKey", List.of(SsmParameterStoreParameterProperty.builder()
                                         .parameterName("parameterName")
                                         .parameterType("parameterType")
                                         .build())))
                         .timeoutSeconds(123)
                         .build()))
                 .build())
         .smallVolumeConf(LaunchTemplateDiskConfProperty.builder()
                 .iops(123)
                 .throughput(123)
                 .volumeType("volumeType")
                 .build())
         .smallVolumeMaxSize(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetInstanceTypeRightSizingMethod("targetInstanceTypeRightSizingMethod")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLaunchConfigurationTemplate

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

    • CfnLaunchConfigurationTemplate

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

    • CfnLaunchConfigurationTemplate

      @Stability(Stable) public CfnLaunchConfigurationTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnLaunchConfigurationTemplateProps props)
      Create a new AWS::MGN::LaunchConfigurationTemplate.

      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.

    • CfnLaunchConfigurationTemplate

      @Stability(Stable) public CfnLaunchConfigurationTemplate(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::MGN::LaunchConfigurationTemplate.

      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.

  • Method Details

    • arnForLaunchConfigurationTemplate

      @Stability(Stable) @NotNull public static String arnForLaunchConfigurationTemplate(@NotNull ILaunchConfigurationTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnLaunchConfigurationTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnLaunchConfigurationTemplate(@NotNull Object x)
      Checks whether the given object is a CfnLaunchConfigurationTemplate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      ARN of the Launch Configuration Template.

    • getAttrEc2LaunchTemplateId

      @Stability(Stable) @NotNull public String getAttrEc2LaunchTemplateId()
      ID of the EC2 launch template backing the Launch Configuration Template.

    • getAttrLaunchConfigurationTemplateId

      @Stability(Stable) @NotNull public String getAttrLaunchConfigurationTemplateId()
      ID of the Launch Configuration Template.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getLaunchConfigurationTemplateRef

      @Stability(Stable) @NotNull public LaunchConfigurationTemplateReference getLaunchConfigurationTemplateRef()
      A reference to a LaunchConfigurationTemplate resource.
      Specified by:
      getLaunchConfigurationTemplateRef in interface ILaunchConfigurationTemplateRef

    • getAssociatePublicIpAddress

      @Stability(Stable) @Nullable public Object getAssociatePublicIpAddress()
      Whether to associate a public IP address with the launched instance.

      Returns union: either Boolean or IResolvable

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable Boolean value)
      Whether to associate a public IP address with the launched instance.

    • setAssociatePublicIpAddress

      @Stability(Stable) public void setAssociatePublicIpAddress(@Nullable IResolvable value)
      Whether to associate a public IP address with the launched instance.

    • getBootMode

      @Stability(Stable) @Nullable public String getBootMode()
      Launch configuration template boot mode.

    • setBootMode

      @Stability(Stable) public void setBootMode(@Nullable String value)
      Launch configuration template boot mode.

    • getCopyPrivateIp

      @Stability(Stable) @Nullable public Object getCopyPrivateIp()
      Whether to copy the private IP of the source server.

      Returns union: either Boolean or IResolvable

    • setCopyPrivateIp

      @Stability(Stable) public void setCopyPrivateIp(@Nullable Boolean value)
      Whether to copy the private IP of the source server.

    • setCopyPrivateIp

      @Stability(Stable) public void setCopyPrivateIp(@Nullable IResolvable value)
      Whether to copy the private IP of the source server.

    • getCopyTags

      @Stability(Stable) @Nullable public Object getCopyTags()
      Whether to copy the tags of the source server.

      Returns union: either Boolean or IResolvable

    • setCopyTags

      @Stability(Stable) public void setCopyTags(@Nullable Boolean value)
      Whether to copy the tags of the source server.

    • setCopyTags

      @Stability(Stable) public void setCopyTags(@Nullable IResolvable value)
      Whether to copy the tags of the source server.

    • getEnableMapAutoTagging

      @Stability(Stable) @Nullable public Object getEnableMapAutoTagging()
      Whether to enable map auto tagging.

      Returns union: either Boolean or IResolvable

    • setEnableMapAutoTagging

      @Stability(Stable) public void setEnableMapAutoTagging(@Nullable Boolean value)
      Whether to enable map auto tagging.

    • setEnableMapAutoTagging

      @Stability(Stable) public void setEnableMapAutoTagging(@Nullable IResolvable value)
      Whether to enable map auto tagging.

    • getEnableParametersEncryption

      @Stability(Stable) @Nullable public Object getEnableParametersEncryption()
      Whether to enable encryption of the AWS Systems Manager parameters used by post launch actions.

      Returns union: either Boolean or IResolvable

    • setEnableParametersEncryption

      @Stability(Stable) public void setEnableParametersEncryption(@Nullable Boolean value)
      Whether to enable encryption of the AWS Systems Manager parameters used by post launch actions.

    • setEnableParametersEncryption

      @Stability(Stable) public void setEnableParametersEncryption(@Nullable IResolvable value)
      Whether to enable encryption of the AWS Systems Manager parameters used by post launch actions.

    • getLargeVolumeConf

      @Stability(Stable) @Nullable public Object getLargeVolumeConf()
      Launch template disk configuration.

      Returns union: either IResolvable or CfnLaunchConfigurationTemplate.LaunchTemplateDiskConfProperty

    • setLargeVolumeConf

      @Stability(Stable) public void setLargeVolumeConf(@Nullable IResolvable value)
      Launch template disk configuration.

    • setLargeVolumeConf

      @Stability(Stable) public void setLargeVolumeConf(@Nullable CfnLaunchConfigurationTemplate.LaunchTemplateDiskConfProperty value)
      Launch template disk configuration.

    • getLaunchDisposition

      @Stability(Stable) @Nullable public String getLaunchDisposition()
      Launch disposition.

    • setLaunchDisposition

      @Stability(Stable) public void setLaunchDisposition(@Nullable String value)
      Launch disposition.

    • getLicensing

      @Stability(Stable) @Nullable public Object getLicensing()
      Configuration of a machine's license.

      Returns union: either IResolvable or CfnLaunchConfigurationTemplate.LicensingProperty

    • setLicensing

      @Stability(Stable) public void setLicensing(@Nullable IResolvable value)
      Configuration of a machine's license.

    • setLicensing

      @Stability(Stable) public void setLicensing(@Nullable CfnLaunchConfigurationTemplate.LicensingProperty value)
      Configuration of a machine's license.

    • getMapAutoTaggingMpeId

      @Stability(Stable) @Nullable public String getMapAutoTaggingMpeId()
      Launch configuration template map auto tagging MPE ID.

    • setMapAutoTaggingMpeId

      @Stability(Stable) public void setMapAutoTaggingMpeId(@Nullable String value)
      Launch configuration template map auto tagging MPE ID.

    • getParametersEncryptionKey

      @Stability(Stable) @Nullable public String getParametersEncryptionKey()
      ARN of the KMS key used to encrypt the AWS Systems Manager parameters used by post launch actions.

    • setParametersEncryptionKey

      @Stability(Stable) public void setParametersEncryptionKey(@Nullable String value)
      ARN of the KMS key used to encrypt the AWS Systems Manager parameters used by post launch actions.

    • getPostLaunchActions

      @Stability(Stable) @Nullable public Object getPostLaunchActions()
      Post launch actions to execute on the Test or Cutover instance.

      Returns union: either IResolvable or CfnLaunchConfigurationTemplate.PostLaunchActionsProperty

    • setPostLaunchActions

      @Stability(Stable) public void setPostLaunchActions(@Nullable IResolvable value)
      Post launch actions to execute on the Test or Cutover instance.

    • setPostLaunchActions

      @Stability(Stable) public void setPostLaunchActions(@Nullable CfnLaunchConfigurationTemplate.PostLaunchActionsProperty value)
      Post launch actions to execute on the Test or Cutover instance.

    • getSmallVolumeConf

      @Stability(Stable) @Nullable public Object getSmallVolumeConf()
      Launch template disk configuration.

      Returns union: either IResolvable or CfnLaunchConfigurationTemplate.LaunchTemplateDiskConfProperty

    • setSmallVolumeConf

      @Stability(Stable) public void setSmallVolumeConf(@Nullable IResolvable value)
      Launch template disk configuration.

    • setSmallVolumeConf

      @Stability(Stable) public void setSmallVolumeConf(@Nullable CfnLaunchConfigurationTemplate.LaunchTemplateDiskConfProperty value)
      Launch template disk configuration.

    • getSmallVolumeMaxSize

      @Stability(Stable) @Nullable public Number getSmallVolumeMaxSize()
      Small volume maximum size, in GiB.

    • setSmallVolumeMaxSize

      @Stability(Stable) public void setSmallVolumeMaxSize(@Nullable Number value)
      Small volume maximum size, in GiB.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A set of tags to be associated with the Launch Configuration Template.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A set of tags to be associated with the Launch Configuration Template.

    • getTargetInstanceTypeRightSizingMethod

      @Stability(Stable) @Nullable public String getTargetInstanceTypeRightSizingMethod()
      Target instance type right-sizing method.

    • setTargetInstanceTypeRightSizingMethod

      @Stability(Stable) public void setTargetInstanceTypeRightSizingMethod(@Nullable String value)
      Target instance type right-sizing method.