How AWS Transfer Family works with IAM

Before you use AWS Identity and Access Management (IAM) to manage access to AWS Transfer Family, you should understand what IAM features are available to use with AWS Transfer Family. To get a high-level view of how AWS Transfer Family and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide.

AWS Transfer Family identity-based policies

With IAM identity-based policies, you can specify allowed or denied actions and resources as well as the conditions under which actions are allowed or denied. AWS Transfer Family supports specific actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON policy elements reference in the AWS Identity and Access Management User Guide.

Actions

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Include actions in a policy to grant permissions to perform the associated operation.

Policy actions in AWS Transfer Family use the following prefix before the action: transfer:. For example, to grant someone permission to create a server, with the Transfer Family CreateServer API operation, you include the transfer:CreateServer action in their policy. Policy statements must include either an Action or NotAction element. AWS Transfer Family defines its own set of actions that describe tasks that you can perform with this service.

To specify multiple actions in a single statement, separate them with commas as follows.

"Action": [
      "transfer:action1",
      "transfer:action2"

You can specify multiple actions using wildcards (*). For example, to specify all actions that begin with the word Describe, include the following action.

"Action": "transfer:Describe*"

To see a list of AWS Transfer Family actions, see Actions defined by AWS Transfer Family in the Service Authorization Reference.

Resources

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Resource JSON policy element specifies the object or objects to which the action applies. As a best practice, specify a resource using its Amazon Resource Name (ARN). For actions that don't support resource-level permissions, use a wildcard (*) to indicate that the statement applies to all resources.

"Resource": "*"

The Transfer Family server resource has the following ARN.

arn:aws:transfer:${Region}:${Account}:server/${ServerId}

For example, to specify the s-01234567890abcdef Transfer Family server in your statement, use the following ARN.

"Resource": "arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef"

For more information about the format of ARNs, see Amazon Resource Names (ARNs) in the Service Authorization Reference, or IAM ARNs in the IAM User Guide.

To specify all instances that belong to a specific account, use the wildcard (*).

"Resource": "arn:aws:transfer:us-east-1:123456789012:server/*"

Some AWS Transfer Family actions are performed on multiple resources, such as those used in IAM policies. In those cases, you must use the wildcard (*).

"Resource": "arn:aws:transfer:*:123456789012:server/*"

In some cases you need to specify more than one type of resource, for example, if you create a policy that allows access to Transfer Family servers and users. To specify multiple resources in a single statement, separate the ARNs with commas.

"Resource": [
      "resource1",
      "resource2"
            ]

To see a list of AWS Transfer Family resources, see Resource types defined by AWS Transfer Family in the Service Authorization Reference.

Condition keys

Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions.

The Condition element specifies when statements execute based on defined criteria. You can create conditional expressions that use condition operators, such as equals or less than, to match the condition in the policy with values in the request. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide.

AWS Transfer Family defines its own set of condition keys and also supports using some global condition keys. To see a list of AWS Transfer Family condition keys, see Condition keys for AWS Transfer Family in the Service Authorization Reference.

Examples

To view examples of AWS Transfer Family identity-based policies, see AWS Transfer Family identity-based policy examples. For VPC endpoint-specific IAM policies, see Limiting VPC endpoint access for Transfer Family servers.

AWS Transfer Family resource-based policies

Resource-based policies are JSON policy documents that specify what actions a specified principal can perform on the AWS Transfer Family resource and under what conditions. Amazon S3 supports resource-based permissions policies for Amazon S3 buckets. Resource-based policies let you grant usage permission to other accounts on a per-resource basis. You can also use a resource-based policy to allow an AWS service to access your Amazon S3 buckets.

To enable cross-account access, you can specify an entire account or IAM entities in another account as the principal in a resource-based policy. Adding a cross-account principal to a resource-based policy is only half of establishing the trust relationship. When the principal and the resource are in different AWS accounts, you must also grant the principal entity permission to access the resource. Grant permission by attaching an identity-based policy to the entity. However, if a resource-based policy grants access to a principal in the same account, no additional identity-based policy is required. For more information, see How IAM roles differ from resource-based policies in the AWS Identity and Access Management User Guide.

The Amazon S3 service supports only one type of resource-based policy called a bucket policy, which is attached to a bucket. This policy defines which principal entities (accounts, users, roles, and federated users) can perform actions on the object.

Examples

To view examples of AWS Transfer Family resource-based policies, see AWS Transfer Family tag-based policy examples.

Authorization based on AWS Transfer Family tags

You can attach tags to AWS Transfer Family resources or pass tags in a request to AWS Transfer Family. To control access based on tags, you provide tag information in the condition element of a policy using the transfer:ResourceTag/key-name, aws:RequestTag/key-name, or aws:TagKeys condition keys. For information about how to use tags to control access to AWS Transfer Family resources, see AWS Transfer Family tag-based policy examples.

AWS Transfer Family IAM roles

An IAM role is an entity within your AWS account that has specific permissions.

Using temporary credentials with AWS Transfer Family

You can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken.

AWS Transfer Family supports using temporary credentials.