AWS Fundamentals Logo
AWS Fundamentals
AWS::Transfer::Agreement

Transfer Agreement

Resource Type definition for AWS::Transfer::Agreement

Properties

11 configurable properties. 4 required. Click a row to see details.

Filter:
PropertyTypeFlags
AccessRole
string
Required
LocalProfileId
string
Required
PartnerProfileId
string
Required
ServerId
string
RequiredCreate-only
BaseDirectory
string
CustomDirectories
object
Description
string
EnforceMessageSigning
string
PreserveFilename
string
Status
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AgreementIdstringA unique identifier for the agreement.
ArnstringSpecifies the unique Amazon Resource Name (ARN) for the agreement.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Transfer::Agreement

Resources:
  MyResource:
    Type: AWS::Transfer::Agreement
    Properties:
      ServerId: "my-serverid"
      LocalProfileId: "my-localprofileid"
      PartnerProfileId: "my-partnerprofileid"
      AccessRole: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

transfer:CreateAgreementtransfer:TagResourceiam:PassRole

read

transfer:DescribeAgreement

update

transfer:UpdateAgreementtransfer:UnTagResourcetransfer:TagResourceiam:PassRole

delete

transfer:DeleteAgreement

list

transfer:ListAgreements

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceTransfer
Properties13
Required4
TaggingSupported
Primary IDAgreementId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ServerId

Related Resources

External Links