launch_configuration_templates

Creates, updates, deletes, gets or lists a launch_configuration_templates resource.

Overview

Name	`launch_configuration_templates`
Type	Resource
Id	`aws.mgn.launch_configuration_templates`

Fields

The following fields are returned by SELECT queries:

describe_launch_configuration_templates

Name	Datatype	Description
`arn`	`string`	ARN of the Launch Configuration Template.
`associate_public_ip_address`	`boolean`	Associate public Ip address.
`boot_mode`	`string`	Launch configuration template boot mode. (LEGACY_BIOS, UEFI, USE_SOURCE)
`copy_private_ip`	`boolean`	Copy private Ip.
`copy_tags`	`boolean`	Copy tags.
`ec_2_launch_template_id`	`string`	EC2 launch template ID. (pattern: <code>lt-[0-9a-z]{17}</code>)
`enable_map_auto_tagging`	`boolean`	Enable map auto tagging.
`enable_parameters_encryption`	`boolean`	Enable parameters encryption.
`large_volume_conf`	`object`	Launch template disk configuration.
`launch_configuration_template_id`	`string`	ID of the Launch Configuration Template. (pattern: <code>lct-[0-9a-zA-Z]{17}</code>)
`launch_disposition`	`string`	Launch disposition. (STOPPED, STARTED)
`licensing`	`object`	Configure Licensing.
`map_auto_tagging_mpe_id`	`string`	Launch configuration template map auto tagging MPE ID.
`parameters_encryption_key`	`string`	Parameters encryption key.
`post_launch_actions`	`object`	Post Launch Actions to executed on the Test or Cutover instance.
`small_volume_conf`	`object`	Launch template disk configuration.
`small_volume_max_size`	`integer (int64)`	Small volume maximum size.
`tags`	`object`	Tags of the Launch Configuration Template.
`target_instance_type_right_sizing_method`	`string`	Target instance type right-sizing method. (NONE, BASIC)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_launch_configuration_templates`	`select`	`region`	Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
`create_launch_configuration_template`	`insert`	`region`	Creates a new Launch Configuration Template.
`update_launch_configuration_template`	`update`	`region`, `launchConfigurationTemplateID`	Updates an existing Launch Configuration Template by ID.
`delete_launch_configuration_template`	`delete`	`region`	Deletes a single Launch Configuration Template by ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_launch_configuration_templates

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

SELECT
arn,
associate_public_ip_address,
boot_mode,
copy_private_ip,
copy_tags,
ec_2_launch_template_id,
enable_map_auto_tagging,
enable_parameters_encryption,
large_volume_conf,
launch_configuration_template_id,
launch_disposition,
licensing,
map_auto_tagging_mpe_id,
parameters_encryption_key,
post_launch_actions,
small_volume_conf,
small_volume_max_size,
tags,
target_instance_type_right_sizing_method
FROM aws.mgn.launch_configuration_templates
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_launch_configuration_template
Manifest

Creates a new Launch Configuration Template.

INSERT INTO aws.mgn.launch_configuration_templates (
postLaunchActions,
enableMapAutoTagging,
mapAutoTaggingMpeID,
tags,
launchDisposition,
targetInstanceTypeRightSizingMethod,
copyPrivateIp,
associatePublicIpAddress,
copyTags,
licensing,
bootMode,
smallVolumeMaxSize,
smallVolumeConf,
largeVolumeConf,
enableParametersEncryption,
parametersEncryptionKey,
region
)
SELECT 
'{{ postLaunchActions }}',
{{ enableMapAutoTagging }},
'{{ mapAutoTaggingMpeID }}',
'{{ tags }}',
'{{ launchDisposition }}',
'{{ targetInstanceTypeRightSizingMethod }}',
{{ copyPrivateIp }},
{{ associatePublicIpAddress }},
{{ copyTags }},
'{{ licensing }}',
'{{ bootMode }}',
{{ smallVolumeMaxSize }},
'{{ smallVolumeConf }}',
'{{ largeVolumeConf }}',
{{ enableParametersEncryption }},
'{{ parametersEncryptionKey }}',
'{{ region }}'
RETURNING
arn,
associate_public_ip_address,
boot_mode,
copy_private_ip,
copy_tags,
ec_2_launch_template_id,
enable_map_auto_tagging,
enable_parameters_encryption,
large_volume_conf,
launch_configuration_template_id,
launch_disposition,
licensing,
map_auto_tagging_mpe_id,
parameters_encryption_key,
post_launch_actions,
small_volume_conf,
small_volume_max_size,
tags,
target_instance_type_right_sizing_method
;

# Description fields are for documentation purposes
- name: launch_configuration_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the launch_configuration_templates resource.
  - name: postLaunchActions
    description: |
      Post Launch Actions to executed on the Test or Cutover instance.
    value:
      deployment: "{{ deployment }}"
      s3LogBucket: "{{ s3LogBucket }}"
      s3OutputKeyPrefix: "{{ s3OutputKeyPrefix }}"
      cloudWatchLogGroupName: "{{ cloudWatchLogGroupName }}"
      ssmDocuments:
        - actionName: "{{ actionName }}"
          ssmDocumentName: "{{ ssmDocumentName }}"
          timeoutSeconds: {{ timeoutSeconds }}
          mustSucceedForCutover: {{ mustSucceedForCutover }}
          parameters: "{{ parameters }}"
          externalParameters: "{{ externalParameters }}"
  - name: enableMapAutoTagging
    value: {{ enableMapAutoTagging }}
  - name: mapAutoTaggingMpeID
    value: "{{ mapAutoTaggingMpeID }}"
  - name: tags
    value: "{{ tags }}"
  - name: launchDisposition
    value: "{{ launchDisposition }}"
    valid_values: ['STOPPED', 'STARTED']
  - name: targetInstanceTypeRightSizingMethod
    value: "{{ targetInstanceTypeRightSizingMethod }}"
    valid_values: ['NONE', 'BASIC']
  - name: copyPrivateIp
    value: {{ copyPrivateIp }}
  - name: associatePublicIpAddress
    value: {{ associatePublicIpAddress }}
  - name: copyTags
    value: {{ copyTags }}
  - name: licensing
    description: |
      Configure Licensing.
    value:
      osByol: {{ osByol }}
  - name: bootMode
    value: "{{ bootMode }}"
    valid_values: ['LEGACY_BIOS', 'UEFI', 'USE_SOURCE']
  - name: smallVolumeMaxSize
    value: {{ smallVolumeMaxSize }}
  - name: smallVolumeConf
    description: |
      Launch template disk configuration.
    value:
      volumeType: "{{ volumeType }}"
      iops: {{ iops }}
      throughput: {{ throughput }}
  - name: largeVolumeConf
    description: |
      Launch template disk configuration.
    value:
      volumeType: "{{ volumeType }}"
      iops: {{ iops }}
      throughput: {{ throughput }}
  - name: enableParametersEncryption
    value: {{ enableParametersEncryption }}
  - name: parametersEncryptionKey
    value: "{{ parametersEncryptionKey }}"

`UPDATE` examples

update_launch_configuration_template

Updates an existing Launch Configuration Template by ID.

UPDATE aws.mgn.launch_configuration_templates
SET 
launchConfigurationTemplateID = '{{ launchConfigurationTemplateID }}',
postLaunchActions = '{{ postLaunchActions }}',
enableMapAutoTagging = {{ enableMapAutoTagging }},
mapAutoTaggingMpeID = '{{ mapAutoTaggingMpeID }}',
launchDisposition = '{{ launchDisposition }}',
targetInstanceTypeRightSizingMethod = '{{ targetInstanceTypeRightSizingMethod }}',
copyPrivateIp = {{ copyPrivateIp }},
associatePublicIpAddress = {{ associatePublicIpAddress }},
copyTags = {{ copyTags }},
licensing = '{{ licensing }}',
bootMode = '{{ bootMode }}',
smallVolumeMaxSize = {{ smallVolumeMaxSize }},
smallVolumeConf = '{{ smallVolumeConf }}',
largeVolumeConf = '{{ largeVolumeConf }}',
enableParametersEncryption = {{ enableParametersEncryption }},
parametersEncryptionKey = '{{ parametersEncryptionKey }}'
WHERE 
region = '{{ region }}' --required
AND launchConfigurationTemplateID = '{{ launchConfigurationTemplateID }}' --required
RETURNING
arn,
associate_public_ip_address,
boot_mode,
copy_private_ip,
copy_tags,
ec_2_launch_template_id,
enable_map_auto_tagging,
enable_parameters_encryption,
large_volume_conf,
launch_configuration_template_id,
launch_disposition,
licensing,
map_auto_tagging_mpe_id,
parameters_encryption_key,
post_launch_actions,
small_volume_conf,
small_volume_max_size,
tags,
target_instance_type_right_sizing_method;

`DELETE` examples

delete_launch_configuration_template

Deletes a single Launch Configuration Template by ID.

DELETE FROM aws.mgn.launch_configuration_templates
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​