launch_configuration_templates
Creates, updates, deletes, gets or lists a launch_configuration_templates resource.
Overview
| Name | launch_configuration_templates |
| Type | Resource |
| Id | aws.drs.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. (pattern: <code>arn:.{16,2044}</code>) |
copy_private_ip | boolean | Copy private IP. |
copy_tags | boolean | Copy tags. |
export_bucket_arn | string | S3 bucket ARN to export Source Network templates. (pattern: <code>arn:.{16,2044}</code>) |
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) |
launch_into_source_instance | boolean | DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance. |
licensing | object | Configuration of a machine's license. |
post_launch_enabled | boolean | Post-launch actions activated. |
recovery_mode | string | Recovery mode to use during launch. FAST skips conversion to reduce recovery time. OPTIMAL runs full conversion for maximum compatibility. (FAST, OPTIMAL) |
tags | object | Tags of the Launch Configuration Template. |
target_instance_type_right_sizing_method | string | Target instance type right-sizing method. (NONE, BASIC, IN_AWS) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional 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,
copy_private_ip,
copy_tags,
export_bucket_arn,
launch_configuration_template_id,
launch_disposition,
launch_into_source_instance,
licensing,
post_launch_enabled,
recovery_mode,
tags,
target_instance_type_right_sizing_method
FROM aws.drs.launch_configuration_templates
WHERE region = '{{ region }}' -- required
;
INSERT examples
- create_launch_configuration_template
- Manifest
Creates a new Launch Configuration Template.
INSERT INTO aws.drs.launch_configuration_templates (
tags,
launchDisposition,
targetInstanceTypeRightSizingMethod,
copyPrivateIp,
copyTags,
licensing,
exportBucketArn,
postLaunchEnabled,
launchIntoSourceInstance,
recoveryMode,
region
)
SELECT
'{{ tags }}',
'{{ launchDisposition }}',
'{{ targetInstanceTypeRightSizingMethod }}',
{{ copyPrivateIp }},
{{ copyTags }},
'{{ licensing }}',
'{{ exportBucketArn }}',
{{ postLaunchEnabled }},
{{ launchIntoSourceInstance }},
'{{ recoveryMode }}',
'{{ region }}'
RETURNING
launch_configuration_template
;
# 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: tags
value: "{{ tags }}"
- name: launchDisposition
value: "{{ launchDisposition }}"
valid_values: ['STOPPED', 'STARTED']
- name: targetInstanceTypeRightSizingMethod
value: "{{ targetInstanceTypeRightSizingMethod }}"
valid_values: ['NONE', 'BASIC', 'IN_AWS']
- name: copyPrivateIp
value: {{ copyPrivateIp }}
- name: copyTags
value: {{ copyTags }}
- name: licensing
description: |
Configuration of a machine's license.
value:
osByol: {{ osByol }}
- name: exportBucketArn
value: "{{ exportBucketArn }}"
- name: postLaunchEnabled
value: {{ postLaunchEnabled }}
- name: launchIntoSourceInstance
value: {{ launchIntoSourceInstance }}
- name: recoveryMode
value: "{{ recoveryMode }}"
description: |
Recovery mode to use during launch. FAST skips conversion to reduce recovery time. OPTIMAL runs full conversion for maximum compatibility.
valid_values: ['FAST', 'OPTIMAL']
UPDATE examples
- update_launch_configuration_template
Updates an existing Launch Configuration Template by ID.
UPDATE aws.drs.launch_configuration_templates
SET
launchConfigurationTemplateID = '{{ launchConfigurationTemplateID }}',
launchDisposition = '{{ launchDisposition }}',
targetInstanceTypeRightSizingMethod = '{{ targetInstanceTypeRightSizingMethod }}',
copyPrivateIp = {{ copyPrivateIp }},
copyTags = {{ copyTags }},
licensing = '{{ licensing }}',
exportBucketArn = '{{ exportBucketArn }}',
postLaunchEnabled = {{ postLaunchEnabled }},
launchIntoSourceInstance = {{ launchIntoSourceInstance }},
recoveryMode = '{{ recoveryMode }}'
WHERE
region = '{{ region }}' --required
AND launchConfigurationTemplateID = '{{ launchConfigurationTemplateID }}' --required
RETURNING
launch_configuration_template;
DELETE examples
- delete_launch_configuration_template
Deletes a single Launch Configuration Template by ID.
DELETE FROM aws.drs.launch_configuration_templates
WHERE region = '{{ region }}' --required
;