UpdateLaunchConfigurationTemplate
Updates an existing Launch Configuration Template by ID.
Request Syntax
POST /UpdateLaunchConfigurationTemplate HTTP/1.1
Content-type: application/json
{
"associatePublicIpAddress": boolean,
"bootMode": "string",
"copyPrivateIp": boolean,
"copyTags": boolean,
"enableMapAutoTagging": boolean,
"enableParametersEncryption": boolean,
"largeVolumeConf": {
"iops": number,
"throughput": number,
"volumeType": "string"
},
"launchConfigurationTemplateID": "string",
"launchDisposition": "string",
"licensing": {
"osByol": boolean
},
"mapAutoTaggingMpeID": "string",
"parametersEncryptionKey": "string",
"postLaunchActions": {
"cloudWatchLogGroupName": "string",
"deployment": "string",
"s3LogBucket": "string",
"s3OutputKeyPrefix": "string",
"ssmDocuments": [
{
"actionName": "string",
"externalParameters": {
"string" : { ... }
},
"mustSucceedForCutover": boolean,
"parameters": {
"string" : [
{
"parameterName": "string",
"parameterType": "string"
}
]
},
"ssmDocumentName": "string",
"timeoutSeconds": number
}
]
},
"smallVolumeConf": {
"iops": number,
"throughput": number,
"volumeType": "string"
},
"smallVolumeMaxSize": number,
"targetInstanceTypeRightSizingMethod": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- associatePublicIpAddress
-
Associate public Ip address.
Type: Boolean
Required: No
- bootMode
-
Launch configuration template boot mode.
Type: String
Valid Values:
LEGACY_BIOS | UEFI | USE_SOURCERequired: No
- copyPrivateIp
-
Copy private Ip.
Type: Boolean
Required: No
- copyTags
-
Copy tags.
Type: Boolean
Required: No
- enableMapAutoTagging
-
Enable map auto tagging.
Type: Boolean
Required: No
- enableParametersEncryption
-
Enable parameters encryption.
Type: Boolean
Required: No
- largeVolumeConf
-
Large volume config.
Type: LaunchTemplateDiskConf object
Required: No
- launchConfigurationTemplateID
-
Launch Configuration Template ID.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
lct-[0-9a-zA-Z]{17}Required: Yes
- launchDisposition
-
Launch disposition.
Type: String
Valid Values:
STOPPED | STARTEDRequired: No
- licensing
-
Configure Licensing.
Type: Licensing object
Required: No
- mapAutoTaggingMpeID
-
Launch configuration template map auto tagging MPE ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- parametersEncryptionKey
-
Parameters encryption key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: No
- postLaunchActions
-
Post Launch Action to execute on the Test or Cutover instance.
Type: PostLaunchActions object
Required: No
- smallVolumeConf
-
Small volume config.
Type: LaunchTemplateDiskConf object
Required: No
- smallVolumeMaxSize
-
Small volume maximum size.
Type: Long
Valid Range: Minimum value of 0.
Required: No
- targetInstanceTypeRightSizingMethod
-
Target instance type right-sizing method.
Type: String
Valid Values:
NONE | BASICRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"associatePublicIpAddress": boolean,
"bootMode": "string",
"copyPrivateIp": boolean,
"copyTags": boolean,
"ec2LaunchTemplateID": "string",
"enableMapAutoTagging": boolean,
"enableParametersEncryption": boolean,
"largeVolumeConf": {
"iops": number,
"throughput": number,
"volumeType": "string"
},
"launchConfigurationTemplateID": "string",
"launchDisposition": "string",
"licensing": {
"osByol": boolean
},
"mapAutoTaggingMpeID": "string",
"parametersEncryptionKey": "string",
"postLaunchActions": {
"cloudWatchLogGroupName": "string",
"deployment": "string",
"s3LogBucket": "string",
"s3OutputKeyPrefix": "string",
"ssmDocuments": [
{
"actionName": "string",
"externalParameters": {
"string" : { ... }
},
"mustSucceedForCutover": boolean,
"parameters": {
"string" : [
{
"parameterName": "string",
"parameterType": "string"
}
]
},
"ssmDocumentName": "string",
"timeoutSeconds": number
}
]
},
"smallVolumeConf": {
"iops": number,
"throughput": number,
"volumeType": "string"
},
"smallVolumeMaxSize": number,
"tags": {
"string" : "string"
},
"targetInstanceTypeRightSizingMethod": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
ARN of the Launch Configuration Template.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- associatePublicIpAddress
-
Associate public Ip address.
Type: Boolean
- bootMode
-
Launch configuration template boot mode.
Type: String
Valid Values:
LEGACY_BIOS | UEFI | USE_SOURCE - copyPrivateIp
-
Copy private Ip.
Type: Boolean
- copyTags
-
Copy tags.
Type: Boolean
- ec2LaunchTemplateID
-
EC2 launch template ID.
Type: String
Length Constraints: Fixed length of 20.
Pattern:
lt-[0-9a-z]{17} - enableMapAutoTagging
-
Enable map auto tagging.
Type: Boolean
- enableParametersEncryption
-
Enable parameters encryption.
Type: Boolean
- largeVolumeConf
-
Large volume config.
Type: LaunchTemplateDiskConf object
- launchConfigurationTemplateID
-
ID of the Launch Configuration Template.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
lct-[0-9a-zA-Z]{17} - launchDisposition
-
Launch disposition.
Type: String
Valid Values:
STOPPED | STARTED - licensing
-
Configure Licensing.
Type: Licensing object
- mapAutoTaggingMpeID
-
Launch configuration template map auto tagging MPE ID.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
- parametersEncryptionKey
-
Parameters encryption key.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- postLaunchActions
-
Post Launch Actions of the Launch Configuration Template.
Type: PostLaunchActions object
- smallVolumeConf
-
Small volume config.
Type: LaunchTemplateDiskConf object
- smallVolumeMaxSize
-
Small volume maximum size.
Type: Long
Valid Range: Minimum value of 0.
-
Tags of the Launch Configuration Template.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 0. Maximum length of 256.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
- targetInstanceTypeRightSizingMethod
-
Target instance type right-sizing method.
Type: String
Valid Values:
NONE | BASIC
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Operating denied due to a file permission or access check error.
HTTP Status Code: 403
- ResourceNotFoundException
-
Resource not found exception.
- resourceId
-
Resource ID not found error.
- resourceType
-
Resource type not found error.
HTTP Status Code: 404
- UninitializedAccountException
-
Uninitialized account exception.
HTTP Status Code: 400
- ValidationException
-
Validate exception.
- fieldList
-
Validate exception field list.
- reason
-
Validate exception reason.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
