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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
profile_id	string	A unique identifier for the profile
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	profiles	INSERT	As2Id, ProfileType, region
delete_resource	profiles	DELETE	Identifier, region
update_resource	profiles	UPDATE	Identifier, PatchDocument, region
list_resources	profiles_list_only	SELECT	region
get_resource	profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual profile.

SELECT
  region,
  as2_id,
  profile_type,
  tags,
  certificate_ids,
  arn,
  profile_id
FROM awscc.transfer.profiles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ profile_id }}';

list (identifiers only)

Lists all profiles in a region.

SELECT
  region,
  profile_id
FROM awscc.transfer.profiles_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.transfer.profiles (
  As2Id,
  ProfileType,
  Tags,
  CertificateIds,
  region
)
SELECT
  '{{ as2_id }}',
  '{{ profile_type }}',
  '{{ tags }}',
  '{{ certificate_ids }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: profile
    props:
      - name: as2_id
        value: '{{ as2_id }}'
      - name: profile_type
        value: '{{ profile_type }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: certificate_ids
        value:
          - '{{ certificate_ids[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.transfer.profiles
SET PatchDocument = string('{{ {
    "As2Id": as2_id,
    "Tags": tags,
    "CertificateIds": certificate_ids
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ profile_id }}';

DELETE example

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