AccessArgs

data class AccessArgs(val externalId: Output<String>? = null, val homeDirectory: Output<String>? = null, val homeDirectoryMappings: Output<List<AccessHomeDirectoryMappingArgs>>? = null, val homeDirectoryType: Output<String>? = null, val policy: Output<String>? = null, val posixProfile: Output<AccessPosixProfileArgs>? = null, val role: Output<String>? = null, val serverId: Output<String>? = null) : ConvertibleToJava<AccessArgs>

Provides a AWS Transfer Access resource.

Example Usage

Basic S3

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.List;
import java.util.ArrayList;
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(aws_transfer_server.example().id())
.role(aws_iam_role.example().arn())
.homeDirectory(String.format("/%s/", aws_s3_bucket.example().id()))
.build());
}
}

Basic EFS

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.List;
import java.util.ArrayList;
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()
.externalId("S-1-1-12-1234567890-123456789-1234567890-1234")
.serverId(aws_transfer_server.test().id())
.role(aws_iam_role.test().arn())
.homeDirectory(String.format("/%s/", aws_efs_file_system.test().id()))
.posixProfile(AccessPosixProfileArgs.builder()
.gid(1000)
.uid(1000)
.build())
.build());
}
}

Import

Transfer Accesses can be imported using the server_id and external_id, e.g.,

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

Constructors

Link copied to clipboard
constructor(externalId: Output<String>? = null, homeDirectory: Output<String>? = null, homeDirectoryMappings: Output<List<AccessHomeDirectoryMappingArgs>>? = null, homeDirectoryType: Output<String>? = null, policy: Output<String>? = null, posixProfile: Output<AccessPosixProfileArgs>? = null, role: Output<String>? = null, serverId: Output<String>? = null)

Properties

Link copied to clipboard
val externalId: Output<String>? = null

The SID of a group in the directory connected to the Transfer Server (e.g., S-1-1-12-1234567890-123456789-1234567890-1234)

Link copied to clipboard
val homeDirectory: Output<String>? = null

The 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.

Link copied to clipboard

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 Home Directory Mappings below.

Link copied to clipboard
val homeDirectoryType: Output<String>? = null

The type of landing directory (folder) you mapped for your users' home directory. Valid values are PATH and LOGICAL.

Link copied to clipboard
val policy: Output<String>? = null

An 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.

Link copied to clipboard

Specifies the 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 Posix Profile below.

Link copied to clipboard
val role: Output<String>? = null

Amazon Resource Name (ARN) of an IAM role that allows the service to controls your user’s access to your Amazon S3 bucket.

Link copied to clipboard
val serverId: Output<String>? = null

The Server ID of the Transfer Server (e.g., s-12345678)

Functions

Link copied to clipboard
open override fun toJava(): AccessArgs