AWS::Transfer::Profile - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Transfer::Profile

Creates the local or partner profile to use for AS2 transfers.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Transfer::Profile",
  "Properties" : {
      "As2Id" : String,
      "CertificateIds" : [ String, ... ],
      "ProfileType" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Transfer::Profile
Properties:
  As2Id: String
  CertificateIds: 
    - String
  ProfileType: String
  Tags: 
    - Tag

Properties

As2Id

The As2Id is the AS2-name, as defined in the RFC 4130. For inbound transfers, this is the AS2-From header for the AS2 messages sent from the partner. For outbound connectors, this is the AS2-To header for the AS2 messages sent to the partner using the StartFileTransfer API operation. This ID cannot include spaces.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

CertificateIds

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Required: No

Type: Array of String

Update requires: No interruption

ProfileType

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Required: Yes

Type: String

Allowed values: LOCAL | PARTNER

Update requires: Replacement

Tags

Key-value pairs that can be used to group and search for profiles.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name associated with the profile, in the form arn:aws:transfer:region:account-id:profile/profile-id/.

ProfileId

The unique identifier for the AS2 profile, returned after the API call succeeds.