Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. transfer
  6. Access
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.transfer.Access

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides a AWS Transfer Access resource.

    NOTE: We suggest using explicit JSON encoding or aws.iam.getPolicyDocument when assigning a value to policy. They seamlessly translate configuration to JSON, enabling you to maintain consistency within your configuration without the need for context switches. Also, you can sidestep potential complications arising from formatting discrepancies, whitespace inconsistencies, and other nuances inherent to JSON.

    Example Usage

    Basic S3

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.transfer.Access("example", {
    externalId: "S-1-1-12-1234567890-123456789-1234567890-1234",
    serverId: exampleAwsTransferServer.id,
    role: exampleAwsIamRole.arn,
    homeDirectory: `/${exampleAwsS3Bucket.id}/`,
});

    import pulumi
import pulumi_aws as aws

example = aws.transfer.Access("example",
    external_id="S-1-1-12-1234567890-123456789-1234567890-1234",
    server_id=example_aws_transfer_server["id"],
    role=example_aws_iam_role["arn"],
    home_directory=f"/{example_aws_s3_bucket['id']}/")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transfer.NewAccess(ctx, "example", &transfer.AccessArgs{
			ExternalId:    pulumi.String("S-1-1-12-1234567890-123456789-1234567890-1234"),
			ServerId:      pulumi.Any(exampleAwsTransferServer.Id),
			Role:          pulumi.Any(exampleAwsIamRole.Arn),
			HomeDirectory: pulumi.Sprintf("/%v/", exampleAwsS3Bucket.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Transfer.Access("example", new()
    {
        ExternalId = "S-1-1-12-1234567890-123456789-1234567890-1234",
        ServerId = exampleAwsTransferServer.Id,
        Role = exampleAwsIamRole.Arn,
        HomeDirectory = $"/{exampleAwsS3Bucket.Id}/",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Access;
import com.pulumi.aws.transfer.AccessArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Access("example", AccessArgs.builder()
            .externalId("S-1-1-12-1234567890-123456789-1234567890-1234")
            .serverId(exampleAwsTransferServer.id())
            .role(exampleAwsIamRole.arn())
            .homeDirectory(String.format("/%s/", exampleAwsS3Bucket.id()))
            .build());

    }
}

    resources:
  example:
    type: aws:transfer:Access
    properties:
      externalId: S-1-1-12-1234567890-123456789-1234567890-1234
      serverId: ${exampleAwsTransferServer.id}
      role: ${exampleAwsIamRole.arn}
      homeDirectory: /${exampleAwsS3Bucket.id}/

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_access" "example" {
  external_id    = "S-1-1-12-1234567890-123456789-1234567890-1234"
  server_id      = exampleAwsTransferServer.id
  role           = exampleAwsIamRole.arn
  home_directory ="/${exampleAwsS3Bucket.id}/"
}

    Basic EFS

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.transfer.Access("test", {
    posixProfile: {
        gid: 1000,
        uid: 1000,
    },
    externalId: "S-1-1-12-1234567890-123456789-1234567890-1234",
    serverId: testAwsTransferServer.id,
    role: testAwsIamRole.arn,
    homeDirectory: `/${testAwsEfsFileSystem.id}/`,
});

    import pulumi
import pulumi_aws as aws

test = aws.transfer.Access("test",
    posix_profile={
        "gid": 1000,
        "uid": 1000,
    },
    external_id="S-1-1-12-1234567890-123456789-1234567890-1234",
    server_id=test_aws_transfer_server["id"],
    role=test_aws_iam_role["arn"],
    home_directory=f"/{test_aws_efs_file_system['id']}/")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transfer.NewAccess(ctx, "test", &transfer.AccessArgs{
			PosixProfile: &transfer.AccessPosixProfileArgs{
				Gid: pulumi.Int(1000),
				Uid: pulumi.Int(1000),
			},
			ExternalId:    pulumi.String("S-1-1-12-1234567890-123456789-1234567890-1234"),
			ServerId:      pulumi.Any(testAwsTransferServer.Id),
			Role:          pulumi.Any(testAwsIamRole.Arn),
			HomeDirectory: pulumi.Sprintf("/%v/", testAwsEfsFileSystem.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Transfer.Access("test", new()
    {
        PosixProfile = new Aws.Transfer.Inputs.AccessPosixProfileArgs
        {
            Gid = 1000,
            Uid = 1000,
        },
        ExternalId = "S-1-1-12-1234567890-123456789-1234567890-1234",
        ServerId = testAwsTransferServer.Id,
        Role = testAwsIamRole.Arn,
        HomeDirectory = $"/{testAwsEfsFileSystem.Id}/",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Access;
import com.pulumi.aws.transfer.AccessArgs;
import com.pulumi.aws.transfer.inputs.AccessPosixProfileArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new Access("test", AccessArgs.builder()
            .posixProfile(AccessPosixProfileArgs.builder()
                .gid(1000)
                .uid(1000)
                .build())
            .externalId("S-1-1-12-1234567890-123456789-1234567890-1234")
            .serverId(testAwsTransferServer.id())
            .role(testAwsIamRole.arn())
            .homeDirectory(String.format("/%s/", testAwsEfsFileSystem.id()))
            .build());

    }
}

    resources:
  test:
    type: aws:transfer:Access
    properties:
      posixProfile:
        gid: 1000
        uid: 1000
      externalId: S-1-1-12-1234567890-123456789-1234567890-1234
      serverId: ${testAwsTransferServer.id}
      role: ${testAwsIamRole.arn}
      homeDirectory: /${testAwsEfsFileSystem.id}/

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_transfer_access" "test" {
  posix_profile = {
    gid = 1000
    uid = 1000
  }
  external_id    = "S-1-1-12-1234567890-123456789-1234567890-1234"
  server_id      = testAwsTransferServer.id
  role           = testAwsIamRole.arn
  home_directory ="/${testAwsEfsFileSystem.id}/"
}

    Create Access Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Access(name: string, args: AccessArgs, opts?: CustomResourceOptions);
    @overload
def Access(resource_name: str,
           args: AccessArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Access(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           external_id: Optional[str] = None,
           server_id: Optional[str] = None,
           home_directory: Optional[str] = None,
           home_directory_mappings: Optional[Sequence[AccessHomeDirectoryMappingArgs]] = None,
           home_directory_type: Optional[str] = None,
           policy: Optional[str] = None,
           posix_profile: Optional[AccessPosixProfileArgs] = None,
           region: Optional[str] = None,
           role: Optional[str] = None)
    func NewAccess(ctx *Context, name string, args AccessArgs, opts ...ResourceOption) (*Access, error)
    public Access(string name, AccessArgs args, CustomResourceOptions? opts = null)
    public Access(String name, AccessArgs args)
public Access(String name, AccessArgs args, CustomResourceOptions options)

    type: aws:transfer:Access
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_transfer_access" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var accessResource = new Aws.Transfer.Access("accessResource", new()
{
    ExternalId = "string",
    ServerId = "string",
    HomeDirectory = "string",
    HomeDirectoryMappings = new[]
    {
        new Aws.Transfer.Inputs.AccessHomeDirectoryMappingArgs
        {
            Entry = "string",
            Target = "string",
        },
    },
    HomeDirectoryType = "string",
    Policy = "string",
    PosixProfile = new Aws.Transfer.Inputs.AccessPosixProfileArgs
    {
        Gid = 0,
        Uid = 0,
        SecondaryGids = new[]
        {
            0,
        },
    },
    Region = "string",
    Role = "string",
});

    example, err := transfer.NewAccess(ctx, "accessResource", &transfer.AccessArgs{
	ExternalId:    pulumi.String("string"),
	ServerId:      pulumi.String("string"),
	HomeDirectory: pulumi.String("string"),
	HomeDirectoryMappings: transfer.AccessHomeDirectoryMappingArray{
		&transfer.AccessHomeDirectoryMappingArgs{
			Entry:  pulumi.String("string"),
			Target: pulumi.String("string"),
		},
	},
	HomeDirectoryType: pulumi.String("string"),
	Policy:            pulumi.String("string"),
	PosixProfile: &transfer.AccessPosixProfileArgs{
		Gid: pulumi.Int(0),
		Uid: pulumi.Int(0),
		SecondaryGids: pulumi.IntArray{
			pulumi.Int(0),
		},
	},
	Region: pulumi.String("string"),
	Role:   pulumi.String("string"),
})

    resource "aws_transfer_access" "accessResource" {
  lifecycle {
    create_before_destroy = true
  }
  external_id    = "string"
  server_id      = "string"
  home_directory = "string"
  home_directory_mappings {
    entry  = "string"
    target = "string"
  }
  home_directory_type = "string"
  policy              = "string"
  posix_profile = {
    gid            = 0
    uid            = 0
    secondary_gids = [0]
  }
  region = "string"
  role   = "string"
}

    var accessResource = new Access("accessResource", AccessArgs.builder()
    .externalId("string")
    .serverId("string")
    .homeDirectory("string")
    .homeDirectoryMappings(AccessHomeDirectoryMappingArgs.builder()
        .entry("string")
        .target("string")
        .build())
    .homeDirectoryType("string")
    .policy("string")
    .posixProfile(AccessPosixProfileArgs.builder()
        .gid(0)
        .uid(0)
        .secondaryGids(0)
        .build())
    .region("string")
    .role("string")
    .build());

    access_resource = aws.transfer.Access("accessResource",
    external_id="string",
    server_id="string",
    home_directory="string",
    home_directory_mappings=[{
        "entry": "string",
        "target": "string",
    }],
    home_directory_type="string",
    policy="string",
    posix_profile={
        "gid": 0,
        "uid": 0,
        "secondary_gids": [0],
    },
    region="string",
    role="string")

    const accessResource = new aws.transfer.Access("accessResource", {
    externalId: "string",
    serverId: "string",
    homeDirectory: "string",
    homeDirectoryMappings: [{
        entry: "string",
        target: "string",
    }],
    homeDirectoryType: "string",
    policy: "string",
    posixProfile: {
        gid: 0,
        uid: 0,
        secondaryGids: [0],
    },
    region: "string",
    role: "string",
});

    type: aws:transfer:Access
properties:
    externalId: string
    homeDirectory: string
    homeDirectoryMappings:
        - entry: string
          target: string
    homeDirectoryType: string
    policy: string
    posixProfile:
        gid: 0
        secondaryGids:
            - 0
        uid: 0
    region: string
    role: string
    serverId: string

    Access Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Access resource accepts the following input properties:

    ExternalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    ServerId string
    Server ID of the Transfer Server (e.g., s-12345678)
    HomeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    HomeDirectoryMappings List<AccessHomeDirectoryMapping>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    HomeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    Policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    PosixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    ExternalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    ServerId string
    Server ID of the Transfer Server (e.g., s-12345678)
    HomeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    HomeDirectoryMappings []AccessHomeDirectoryMappingArgs
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    HomeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    Policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    PosixProfile AccessPosixProfileArgs
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    external_id string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    server_id string
    Server ID of the Transfer Server (e.g., s-12345678)
    home_directory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    home_directory_mappings list(object)
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    home_directory_type string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posix_profile object
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    externalId String
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    serverId String
    Server ID of the Transfer Server (e.g., s-12345678)
    homeDirectory String
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings List<AccessHomeDirectoryMapping>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType String
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy String
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    externalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    serverId string
    Server ID of the Transfer Server (e.g., s-12345678)
    homeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings AccessHomeDirectoryMapping[]
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    external_id str
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    server_id str
    Server ID of the Transfer Server (e.g., s-12345678)
    home_directory str
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    home_directory_mappings Sequence[AccessHomeDirectoryMappingArgs]
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    home_directory_type str
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy str
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posix_profile AccessPosixProfileArgs
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role str
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    externalId String
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    serverId String
    Server ID of the Transfer Server (e.g., s-12345678)
    homeDirectory String
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings List<Property Map>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType String
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy String
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile Property Map
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Access resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Access Resource

    Get an existing Access resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AccessState, opts?: CustomResourceOptions): Access
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_id: Optional[str] = None,
        home_directory: Optional[str] = None,
        home_directory_mappings: Optional[Sequence[AccessHomeDirectoryMappingArgs]] = None,
        home_directory_type: Optional[str] = None,
        policy: Optional[str] = None,
        posix_profile: Optional[AccessPosixProfileArgs] = None,
        region: Optional[str] = None,
        role: Optional[str] = None,
        server_id: Optional[str] = None) -> Access
    func GetAccess(ctx *Context, name string, id IDInput, state *AccessState, opts ...ResourceOption) (*Access, error)
    public static Access Get(string name, Input<string> id, AccessState? state, CustomResourceOptions? opts = null)
    public static Access get(String name, Output<String> id, AccessState state, CustomResourceOptions options)
    resources:  _:    type: aws:transfer:Access    get:      id: ${id}
    import {
  to = aws_transfer_access.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ExternalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    HomeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    HomeDirectoryMappings List<AccessHomeDirectoryMapping>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    HomeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    Policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    PosixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    ServerId string
    Server ID of the Transfer Server (e.g., s-12345678)
    ExternalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    HomeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    HomeDirectoryMappings []AccessHomeDirectoryMappingArgs
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    HomeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    Policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    PosixProfile AccessPosixProfileArgs
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    ServerId string
    Server ID of the Transfer Server (e.g., s-12345678)
    external_id string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    home_directory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    home_directory_mappings list(object)
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    home_directory_type string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posix_profile object
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    server_id string
    Server ID of the Transfer Server (e.g., s-12345678)
    externalId String
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    homeDirectory String
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings List<AccessHomeDirectoryMapping>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType String
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy String
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    serverId String
    Server ID of the Transfer Server (e.g., s-12345678)
    externalId string
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    homeDirectory string
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings AccessHomeDirectoryMapping[]
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType string
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy string
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile AccessPosixProfile
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role string
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    serverId string
    Server ID of the Transfer Server (e.g., s-12345678)
    external_id str
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    home_directory str
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    home_directory_mappings Sequence[AccessHomeDirectoryMappingArgs]
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    home_directory_type str
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy str
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posix_profile AccessPosixProfileArgs
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role str
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    server_id str
    Server ID of the Transfer Server (e.g., s-12345678)
    externalId String
    SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)
    homeDirectory String
    Landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a /. The first item in the path is the name of the home bucket (accessible as ${Transfer:HomeBucket} in the policy) and the rest is the home directory (accessible as ${Transfer:HomeDirectory} in the policy). For example, /example-bucket-1234/username would set the home bucket to example-bucket-1234 and the home directory to username.
    homeDirectoryMappings List<Property Map>
    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. See homeDirectoryMappings Block below.
    homeDirectoryType String
    Type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.
    policy String
    IAM JSON policy document that scopes down user access to portions of their Amazon S3 bucket. IAM variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. These are evaluated on-the-fly when navigating the bucket.
    posixProfile Property Map
    Full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. See posixProfile Block below.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    role String
    ARN of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.
    serverId String
    Server ID of the Transfer Server (e.g., s-12345678)

    Supporting Types

    AccessHomeDirectoryMapping, AccessHomeDirectoryMappingArgs

    Entry string
    Logical directory entry that appears to your user.
    Target string
    Map target that maps the entry to an actual S3 path.
    Entry string
    Logical directory entry that appears to your user.
    Target string
    Map target that maps the entry to an actual S3 path.
    entry string
    Logical directory entry that appears to your user.
    target string
    Map target that maps the entry to an actual S3 path.
    entry String
    Logical directory entry that appears to your user.
    target String
    Map target that maps the entry to an actual S3 path.
    entry string
    Logical directory entry that appears to your user.
    target string
    Map target that maps the entry to an actual S3 path.
    entry str
    Logical directory entry that appears to your user.
    target str
    Map target that maps the entry to an actual S3 path.
    entry String
    Logical directory entry that appears to your user.
    target String
    Map target that maps the entry to an actual S3 path.

    AccessPosixProfile, AccessPosixProfileArgs

    Gid int
    POSIX group ID used for all EFS operations by this user.
    Uid int
    POSIX user ID used for all EFS operations by this user.
    SecondaryGids List<int>
    Secondary POSIX group IDs used for all EFS operations by this user.
    Gid int
    POSIX group ID used for all EFS operations by this user.
    Uid int
    POSIX user ID used for all EFS operations by this user.
    SecondaryGids []int
    Secondary POSIX group IDs used for all EFS operations by this user.
    gid number
    POSIX group ID used for all EFS operations by this user.
    uid number
    POSIX user ID used for all EFS operations by this user.
    secondary_gids list(number)
    Secondary POSIX group IDs used for all EFS operations by this user.
    gid Integer
    POSIX group ID used for all EFS operations by this user.
    uid Integer
    POSIX user ID used for all EFS operations by this user.
    secondaryGids List<Integer>
    Secondary POSIX group IDs used for all EFS operations by this user.
    gid number
    POSIX group ID used for all EFS operations by this user.
    uid number
    POSIX user ID used for all EFS operations by this user.
    secondaryGids number[]
    Secondary POSIX group IDs used for all EFS operations by this user.
    gid int
    POSIX group ID used for all EFS operations by this user.
    uid int
    POSIX user ID used for all EFS operations by this user.
    secondary_gids Sequence[int]
    Secondary POSIX group IDs used for all EFS operations by this user.
    gid Number
    POSIX group ID used for all EFS operations by this user.
    uid Number
    POSIX user ID used for all EFS operations by this user.
    secondaryGids List<Number>
    Secondary POSIX group IDs used for all EFS operations by this user.

    Import

    Using pulumi import, import Transfer Accesses using the serverId and externalId. For example:

    $ pulumi import aws:transfer/access:Access example s-12345678/S-1-1-12-1234567890-123456789-1234567890-1234

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial