connectors

Creates, updates, deletes or gets a connector resource or lists connectors in a region

Overview

Name	connectors
Type	Resource
Description	Resource Type definition for AWS::Transfer::Connector
Id	aws.transfer.connectors

Fields

Name	Datatype	Description
access_role	string	Specifies the access role for the connector.
as2_config	object	Configuration for an AS2 connector.
sftp_config	object	Configuration for an SFTP connector.
arn	string	Specifies the unique Amazon Resource Name (ARN) for the connector.
connector_id	string	A unique identifier for the connector.
logging_role	string	Specifies the logging role for the connector.
service_managed_egress_ip_addresses	array	The list of egress IP addresses of this connector. These IP addresses are assigned automatically when you create the connector.
tags	array	Key-value pairs that can be used to group and search for connectors. Tags are metadata attached to connectors for any purpose.
url	string	URL for Connector
security_policy_name	string	Security policy for SFTP Connector
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AccessRole, Url, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all connectors in a region.

SELECT
region,
access_role,
as2_config,
sftp_config,
arn,
connector_id,
logging_role,
service_managed_egress_ip_addresses,
tags,
url,
security_policy_name
FROM aws.transfer.connectors
WHERE region = 'us-east-1';

Gets all properties from an individual connector.

SELECT
region,
access_role,
as2_config,
sftp_config,
arn,
connector_id,
logging_role,
service_managed_egress_ip_addresses,
tags,
url,
security_policy_name
FROM aws.transfer.connectors
WHERE region = 'us-east-1' AND data__Identifier = '<ConnectorId>';

INSERT example

Use the following StackQL query and manifest file to create a new connector resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.transfer.connectors (
 AccessRole,
 Url,
 region
)
SELECT 
'{{ AccessRole }}',
 '{{ Url }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.transfer.connectors (
 AccessRole,
 As2Config,
 SftpConfig,
 LoggingRole,
 Tags,
 Url,
 SecurityPolicyName,
 region
)
SELECT 
 '{{ AccessRole }}',
 '{{ As2Config }}',
 '{{ SftpConfig }}',
 '{{ LoggingRole }}',
 '{{ Tags }}',
 '{{ Url }}',
 '{{ SecurityPolicyName }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector
    props:
      - name: AccessRole
        value: '{{ AccessRole }}'
      - name: As2Config
        value:
          LocalProfileId: '{{ LocalProfileId }}'
          PartnerProfileId: '{{ PartnerProfileId }}'
          MessageSubject: '{{ MessageSubject }}'
          Compression: '{{ Compression }}'
          EncryptionAlgorithm: '{{ EncryptionAlgorithm }}'
          SigningAlgorithm: '{{ SigningAlgorithm }}'
          MdnSigningAlgorithm: '{{ MdnSigningAlgorithm }}'
          MdnResponse: '{{ MdnResponse }}'
          BasicAuthSecretId: '{{ BasicAuthSecretId }}'
      - name: SftpConfig
        value:
          UserSecretId: '{{ UserSecretId }}'
          TrustedHostKeys:
            - '{{ TrustedHostKeys[0] }}'
      - name: LoggingRole
        value: '{{ LoggingRole }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Url
        value: '{{ Url }}'
      - name: SecurityPolicyName
        value: '{{ SecurityPolicyName }}'

DELETE example

/*+ delete */
DELETE FROM aws.transfer.connectors
WHERE data__Identifier = '<ConnectorId>'
AND region = 'us-east-1';

Permissions

To operate on the connectors resource, the following permissions are required:

Create

transfer:CreateConnector,
transfer:TagResource,
iam:PassRole

Read

transfer:DescribeConnector

Update

transfer:UpdateConnector,
transfer:UnTagResource,
transfer:TagResource,
iam:PassRole

Delete

transfer:DeleteConnector

List

transfer:ListConnectors