profiles

Creates, updates, deletes or gets a profile resource or lists profiles in a region

Overview

Name	profiles
Type	Resource
Description	Resource Type definition for AWS::Transfer::Profile
Id	aws.transfer.profiles

Fields

Name	Datatype	Description
as2_id	string	AS2 identifier agreed with a trading partner.
profile_type	string	Enum specifying whether the profile is local or associated with a trading partner.
tags	array	An array of key-value pairs to apply to this resource.
certificate_ids	array	List of the certificate IDs associated with this profile to be used for encryption and signing of AS2 messages.
arn	string	Specifies the unique Amazon Resource Name (ARN) for the profile.
profile_id	string	A unique identifier for the profile
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	As2Id, ProfileType, 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 profiles in a region.

SELECT
region,
as2_id,
profile_type,
tags,
certificate_ids,
arn,
profile_id
FROM aws.transfer.profiles
WHERE region = 'us-east-1';

Gets all properties from an individual profile.

SELECT
region,
as2_id,
profile_type,
tags,
certificate_ids,
arn,
profile_id
FROM aws.transfer.profiles
WHERE region = 'us-east-1' AND data__Identifier = '<ProfileId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.transfer.profiles (
 As2Id,
 ProfileType,
 region
)
SELECT 
'{{ As2Id }}',
 '{{ ProfileType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.transfer.profiles (
 As2Id,
 ProfileType,
 Tags,
 CertificateIds,
 region
)
SELECT 
 '{{ As2Id }}',
 '{{ ProfileType }}',
 '{{ Tags }}',
 '{{ CertificateIds }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: profile
    props:
      - name: As2Id
        value: '{{ As2Id }}'
      - name: ProfileType
        value: '{{ ProfileType }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: CertificateIds
        value:
          - '{{ CertificateIds[0] }}'

DELETE example

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

Permissions

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

Create

transfer:CreateProfile,
transfer:TagResource

Read

transfer:DescribeProfile

Update

transfer:UpdateProfile,
transfer:UnTagResource,
transfer:TagResource

Delete

transfer:DeleteProfile

List

transfer:ListProfiles