connector_definitions

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

Overview

Name	connector_definitions
Type	Resource
Id	aws.greengrass.connector_definitions

Fields

The following fields are returned by SELECT queries:

get_connector_definition

Name	Datatype	Description
arn	string	The ARN of the definition.
creation_timestamp	string	The time, in milliseconds since the epoch, when the definition was created.
id	string	The ID of the definition.
last_updated_timestamp	string	The time, in milliseconds since the epoch, when the definition was last updated.
latest_version	string	The ID of the latest version associated with the definition.
latest_version_arn	string	The ARN of the latest version associated with the definition.
name	string	The name of the definition.
tags	object	Tag(s) attached to the resource arn.

list_connector_definitions

Name	Datatype	Description
arn	string	The ARN of the definition.
creation_timestamp	string	The time, in milliseconds since the epoch, when the definition was created.
id	string	The ID of the definition.
last_updated_timestamp	string	The time, in milliseconds since the epoch, when the definition was last updated.
latest_version	string	The ID of the latest version associated with the definition.
latest_version_arn	string	The ARN of the latest version associated with the definition.
name	string	The name of the definition.
tags	object	Tag(s) attached to the resource arn.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connector_definition	select	connector_definition_id, region		Retrieves information about a connector definition.
list_connector_definitions	select	region	MaxResults, NextToken	Retrieves a list of connector definitions.
create_connector_definition	insert	region	X-Amzn-Client-Token	Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.
update_connector_definition	update	connector_definition_id, region		Updates a connector definition.
delete_connector_definition	delete	connector_definition_id, region		Deletes a connector definition.

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
connector_definition_id	string	The ID of the connector definition.
region	string	AWS region (default: us-east-1)
MaxResults	string	The maximum number of results to be returned per request.
NextToken	string	The token for the next set of results, or ''null'' if there are no additional results.
X-Amzn-Client-Token	string	A client token used to correlate requests and responses.

SELECT examples

get_connector_definition

Retrieves information about a connector definition.

SELECT
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name,
tags
FROM aws.greengrass.connector_definitions
WHERE connector_definition_id = '{{ connector_definition_id }}' -- required
AND region = '{{ region }}' -- required
;

list_connector_definitions

Retrieves a list of connector definitions.

SELECT
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name,
tags
FROM aws.greengrass.connector_definitions
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_connector_definition

Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time.

INSERT INTO aws.greengrass.connector_definitions (
InitialVersion,
Name,
tags,
region,
`X-Amzn-Client-Token`
)
SELECT 
'{{ InitialVersion }}',
'{{ Name }}',
'{{ tags }}',
'{{ region }}',
'{{ X-Amzn-Client-Token }}'
RETURNING
arn,
creation_timestamp,
id,
last_updated_timestamp,
latest_version,
latest_version_arn,
name
;

Manifest

# Description fields are for documentation purposes
- name: connector_definitions
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connector_definitions resource.
  - name: InitialVersion
    description: |
      Information about the connector definition version, which is a container for connectors.
    value:
      Connectors:
        - ConnectorArn: "{{ ConnectorArn }}"
          Id: "{{ Id }}"
          Parameters: "{{ Parameters }}"
  - name: Name
    value: "{{ Name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The key-value pair for the resource tag.
  - name: X-Amzn-Client-Token
    value: "{{ X-Amzn-Client-Token }}"
    description: A client token used to correlate requests and responses.
    description: A client token used to correlate requests and responses.

UPDATE examples

update_connector_definition

Updates a connector definition.

UPDATE aws.greengrass.connector_definitions
SET 
Name = '{{ Name }}'
WHERE 
connector_definition_id = '{{ connector_definition_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_connector_definition

Deletes a connector definition.

DELETE FROM aws.greengrass.connector_definitions
WHERE connector_definition_id = '{{ connector_definition_id }}' --required
AND region = '{{ region }}' --required
;