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	awscc.transfer.connectors

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
connector_id	string	A unique identifier for the connector.
region	string	AWS region.

For more information, see AWS::Transfer::Connector.

Methods

Name	Resource	Accessible by	Required Params
create_resource	connectors	INSERT	AccessRole, Url, region
delete_resource	connectors	DELETE	Identifier, region
update_resource	connectors	UPDATE	Identifier, PatchDocument, region
list_resources	connectors_list_only	SELECT	region
get_resource	connectors	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.transfer.connectors
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ connector_id }}';

list (identifiers only)

Lists all connectors in a region.

SELECT
  region,
  connector_id
FROM awscc.transfer.connectors_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.transfer.connectors (
  AccessRole,
  As2Config,
  SftpConfig,
  LoggingRole,
  Tags,
  Url,
  SecurityPolicyName,
  region
)
SELECT
  '{{ access_role }}',
  '{{ as2_config }}',
  '{{ sftp_config }}',
  '{{ logging_role }}',
  '{{ tags }}',
  '{{ url }}',
  '{{ security_policy_name }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector
    props:
      - name: access_role
        value: '{{ access_role }}'
      - name: as2_config
        value:
          local_profile_id: '{{ local_profile_id }}'
          partner_profile_id: '{{ partner_profile_id }}'
          message_subject: '{{ message_subject }}'
          compression: '{{ compression }}'
          encryption_algorithm: '{{ encryption_algorithm }}'
          signing_algorithm: '{{ signing_algorithm }}'
          mdn_signing_algorithm: '{{ mdn_signing_algorithm }}'
          mdn_response: '{{ mdn_response }}'
          basic_auth_secret_id: '{{ basic_auth_secret_id }}'
          preserve_content_type: '{{ preserve_content_type }}'
      - name: sftp_config
        value:
          user_secret_id: '{{ user_secret_id }}'
          trusted_host_keys:
            - '{{ trusted_host_keys[0] }}'
          max_concurrent_connections: '{{ max_concurrent_connections }}'
      - name: logging_role
        value: '{{ logging_role }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: url
        value: '{{ url }}'
      - name: security_policy_name
        value: '{{ security_policy_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.transfer.connectors
SET PatchDocument = string('{{ {
    "AccessRole": access_role,
    "As2Config": as2_config,
    "SftpConfig": sftp_config,
    "LoggingRole": logging_role,
    "Tags": tags,
    "Url": url,
    "SecurityPolicyName": security_policy_name
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.transfer.connectors
WHERE
  Identifier = '{{ connector_id }}' 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