Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateLaunchConfigurationTemplateCommand

Updates an existing Launch Configuration Template by ID.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MgnClient, UpdateLaunchConfigurationTemplateCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, UpdateLaunchConfigurationTemplateCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // UpdateLaunchConfigurationTemplateRequest
  launchConfigurationTemplateID: "STRING_VALUE", // required
  postLaunchActions: { // PostLaunchActions
    deployment: "STRING_VALUE",
    s3LogBucket: "STRING_VALUE",
    s3OutputKeyPrefix: "STRING_VALUE",
    cloudWatchLogGroupName: "STRING_VALUE",
    ssmDocuments: [ // SsmDocuments
      { // SsmDocument
        actionName: "STRING_VALUE", // required
        ssmDocumentName: "STRING_VALUE", // required
        timeoutSeconds: Number("int"),
        mustSucceedForCutover: true || false,
        parameters: { // SsmDocumentParameters
          "<keys>": [ // SsmParameterStoreParameters
            { // SsmParameterStoreParameter
              parameterType: "STRING_VALUE", // required
              parameterName: "STRING_VALUE", // required
            },
          ],
        },
        externalParameters: { // SsmDocumentExternalParameters
          "<keys>": { // SsmExternalParameter Union: only one key present
            dynamicPath: "STRING_VALUE",
          },
        },
      },
    ],
  },
  enableMapAutoTagging: true || false,
  mapAutoTaggingMpeID: "STRING_VALUE",
  launchDisposition: "STRING_VALUE",
  targetInstanceTypeRightSizingMethod: "STRING_VALUE",
  copyPrivateIp: true || false,
  associatePublicIpAddress: true || false,
  copyTags: true || false,
  licensing: { // Licensing
    osByol: true || false,
  },
  bootMode: "STRING_VALUE",
  smallVolumeMaxSize: Number("long"),
  smallVolumeConf: { // LaunchTemplateDiskConf
    volumeType: "STRING_VALUE",
    iops: Number("long"),
    throughput: Number("long"),
  },
  largeVolumeConf: {
    volumeType: "STRING_VALUE",
    iops: Number("long"),
    throughput: Number("long"),
  },
};
const command = new UpdateLaunchConfigurationTemplateCommand(input);
const response = await client.send(command);
// { // LaunchConfigurationTemplate
//   launchConfigurationTemplateID: "STRING_VALUE", // required
//   arn: "STRING_VALUE",
//   postLaunchActions: { // PostLaunchActions
//     deployment: "STRING_VALUE",
//     s3LogBucket: "STRING_VALUE",
//     s3OutputKeyPrefix: "STRING_VALUE",
//     cloudWatchLogGroupName: "STRING_VALUE",
//     ssmDocuments: [ // SsmDocuments
//       { // SsmDocument
//         actionName: "STRING_VALUE", // required
//         ssmDocumentName: "STRING_VALUE", // required
//         timeoutSeconds: Number("int"),
//         mustSucceedForCutover: true || false,
//         parameters: { // SsmDocumentParameters
//           "<keys>": [ // SsmParameterStoreParameters
//             { // SsmParameterStoreParameter
//               parameterType: "STRING_VALUE", // required
//               parameterName: "STRING_VALUE", // required
//             },
//           ],
//         },
//         externalParameters: { // SsmDocumentExternalParameters
//           "<keys>": { // SsmExternalParameter Union: only one key present
//             dynamicPath: "STRING_VALUE",
//           },
//         },
//       },
//     ],
//   },
//   enableMapAutoTagging: true || false,
//   mapAutoTaggingMpeID: "STRING_VALUE",
//   tags: { // TagsMap
//     "<keys>": "STRING_VALUE",
//   },
//   ec2LaunchTemplateID: "STRING_VALUE",
//   launchDisposition: "STRING_VALUE",
//   targetInstanceTypeRightSizingMethod: "STRING_VALUE",
//   copyPrivateIp: true || false,
//   associatePublicIpAddress: true || false,
//   copyTags: true || false,
//   licensing: { // Licensing
//     osByol: true || false,
//   },
//   bootMode: "STRING_VALUE",
//   smallVolumeMaxSize: Number("long"),
//   smallVolumeConf: { // LaunchTemplateDiskConf
//     volumeType: "STRING_VALUE",
//     iops: Number("long"),
//     throughput: Number("long"),
//   },
//   largeVolumeConf: {
//     volumeType: "STRING_VALUE",
//     iops: Number("long"),
//     throughput: Number("long"),
//   },
// };

UpdateLaunchConfigurationTemplateCommand Input

See UpdateLaunchConfigurationTemplateCommandInput for more details

Parameter	Type	Description
`launchConfigurationTemplateID` Required	`string \| undefined`	Launch Configuration Template ID.
`associatePublicIpAddress`	`boolean \| undefined`	Associate public Ip address.
`bootMode`	`BootMode \| undefined`	Launch configuration template boot mode.
`copyPrivateIp`	`boolean \| undefined`	Copy private Ip.
`copyTags`	`boolean \| undefined`	Copy tags.
`enableMapAutoTagging`	`boolean \| undefined`	Enable map auto tagging.
`largeVolumeConf`	`LaunchTemplateDiskConf \| undefined`	Large volume config.
`launchDisposition`	`LaunchDisposition \| undefined`	Launch disposition.
`licensing`	`Licensing \| undefined`	Configure Licensing.
`mapAutoTaggingMpeID`	`string \| undefined`	Launch configuration template map auto tagging MPE ID.
`postLaunchActions`	`PostLaunchActions \| undefined`	Post Launch Action to execute on the Test or Cutover instance.
`smallVolumeConf`	`LaunchTemplateDiskConf \| undefined`	Small volume config.
`smallVolumeMaxSize`	`number \| undefined`	Small volume maximum size.
`targetInstanceTypeRightSizingMethod`	`TargetInstanceTypeRightSizingMethod \| undefined`	Target instance type right-sizing method.

UpdateLaunchConfigurationTemplateCommand Output

See UpdateLaunchConfigurationTemplateCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`launchConfigurationTemplateID` Required	`string \| undefined`	ID of the Launch Configuration Template.
`arn`	`string \| undefined`	ARN of the Launch Configuration Template.
`associatePublicIpAddress`	`boolean \| undefined`	Associate public Ip address.
`bootMode`	`BootMode \| undefined`	Launch configuration template boot mode.
`copyPrivateIp`	`boolean \| undefined`	Copy private Ip.
`copyTags`	`boolean \| undefined`	Copy tags.
`ec2LaunchTemplateID`	`string \| undefined`	EC2 launch template ID.
`enableMapAutoTagging`	`boolean \| undefined`	Enable map auto tagging.
`largeVolumeConf`	`LaunchTemplateDiskConf \| undefined`	Large volume config.
`launchDisposition`	`LaunchDisposition \| undefined`	Launch disposition.
`licensing`	`Licensing \| undefined`	Configure Licensing.
`mapAutoTaggingMpeID`	`string \| undefined`	Launch configuration template map auto tagging MPE ID.
`postLaunchActions`	`PostLaunchActions \| undefined`	Post Launch Actions of the Launch Configuration Template.
`smallVolumeConf`	`LaunchTemplateDiskConf \| undefined`	Small volume config.
`smallVolumeMaxSize`	`number \| undefined`	Small volume maximum size.
`tags`	`Record<string, string> \| undefined`	Tags of the Launch Configuration Template.
`targetInstanceTypeRightSizingMethod`	`TargetInstanceTypeRightSizingMethod \| undefined`	Target instance type right-sizing method.

Throws

Name	Fault	Details
AccessDeniedException	client	Operating denied due to a file permission or access check error.
ResourceNotFoundException	client	Resource not found exception.
UninitializedAccountException	client	Uninitialized account exception.
ValidationException	client	Validate exception.
MgnServiceException		Base exception class for all service exceptions from Mgn service.

Getting Started

References

UpdateLaunchConfigurationTemplateCommand

Example Syntax

UpdateLaunchConfigurationTemplateCommand Input

UpdateLaunchConfigurationTemplateCommand Output

Throws

Table of Contents

Search