connectors

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

Overview

Name	connectors
Type	Resource
Id	aws.mgn.connectors

Fields

The following fields are returned by SELECT queries:

list_connectors

Name	Datatype	Description
name	string	Connector name. (pattern: <code>[A-Za-z0-9_-]+</code>)
arn	string	Connector arn.
connector_id	string	Connector ID. (pattern: <code>connector-[0-9a-zA-Z]{17}</code>)
ssm_command_config	object	Connector SSM command config.
ssm_instance_id	string	Connector SSM instance ID. (pattern: <code>.(^i-[0-9a-zA-Z]{17}$)|(^mi-[0-9a-zA-Z]{17}$).</code>)
tags	object	Connector tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_connectors	select	region		List Connectors.
create_connector	insert	region, name, ssmInstanceID		Create Connector.
update_connector	update	region, connectorID		Update Connector.
delete_connector	delete	region		Delete Connector.

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

list_connectors

List Connectors.

SELECT
name,
arn,
connector_id,
ssm_command_config,
ssm_instance_id,
tags
FROM aws.mgn.connectors
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_connector

Create Connector.

INSERT INTO aws.mgn.connectors (
name,
ssmInstanceID,
tags,
ssmCommandConfig,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ ssmInstanceID }}' /* required */,
'{{ tags }}',
'{{ ssmCommandConfig }}',
'{{ region }}'
RETURNING
name,
arn,
connector_id,
ssm_command_config,
ssm_instance_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connectors resource.
  - name: name
    value: "{{ name }}"
  - name: ssmInstanceID
    value: "{{ ssmInstanceID }}"
  - name: tags
    value: "{{ tags }}"
  - name: ssmCommandConfig
    description: |
      Connector SSM command config.
    value:
      s3OutputEnabled: {{ s3OutputEnabled }}
      outputS3BucketName: "{{ outputS3BucketName }}"
      cloudWatchOutputEnabled: {{ cloudWatchOutputEnabled }}
      cloudWatchLogGroupName: "{{ cloudWatchLogGroupName }}"

UPDATE examples

update_connector

Update Connector.

UPDATE aws.mgn.connectors
SET 
connectorID = '{{ connectorID }}',
name = '{{ name }}',
ssmCommandConfig = '{{ ssmCommandConfig }}'
WHERE 
region = '{{ region }}' --required
AND connectorID = '{{ connectorID }}' --required
RETURNING
name,
arn,
connector_id,
ssm_command_config,
ssm_instance_id,
tags;

DELETE examples

delete_connector

Delete Connector.

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