software.amazon.awssdk.services.transfer.model

Interface DescribedAccess.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DescribedAccess.Builder,DescribedAccess>, SdkBuilder<DescribedAccess.Builder,DescribedAccess>, SdkPojo

Enclosing class:

DescribedAccess

public static interface DescribedAccess.Builder
extends SdkPojo, CopyableBuilder<DescribedAccess.Builder,DescribedAccess>

Method Summary

Modifier and Type	Method and Description
DescribedAccess.Builder	externalId(String externalId) A unique identifier that might be required when you assume a role in another account.
DescribedAccess.Builder	homeDirectory(String homeDirectory) Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.
DescribedAccess.Builder	homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible.
DescribedAccess.Builder	homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible.
DescribedAccess.Builder	homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible.
DescribedAccess.Builder	homeDirectoryType(HomeDirectoryType homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
DescribedAccess.Builder	homeDirectoryType(String homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
DescribedAccess.Builder	policy(String policy) A scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users.
default DescribedAccess.Builder	posixProfile(Consumer<PosixProfile.Builder> posixProfile) Sets the value of the PosixProfile property for this object.
DescribedAccess.Builder	posixProfile(PosixProfile posixProfile) Sets the value of the PosixProfile property for this object.
DescribedAccess.Builder	role(String role) The IAM role that controls access to your Amazon S3 bucket from the specified associated access.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

homeDirectory

DescribedAccess.Builder homeDirectory(String homeDirectory)

Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.

Parameters:

homeDirectory - Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.

Returns:

Returns a reference to this object so that method calls can be chained together.

homeDirectoryMappings

DescribedAccess.Builder homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

Returns a reference to this object so that method calls can be chained together.

homeDirectoryMappings

DescribedAccess.Builder homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the "Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

Returns a reference to this object so that method calls can be chained together.

homeDirectoryMappings

DescribedAccess.Builder homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to the associated access and how you want to make them visible. You must specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You also must ensure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock down the associated access to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #homeDirectoryMappings(List).

Parameters:

homeDirectoryMappings - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#homeDirectoryMappings(List)

homeDirectoryType

DescribedAccess.Builder homeDirectoryType(String homeDirectoryType)

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it to LOGICAL, you must provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Parameters:

homeDirectoryType - The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it to LOGICAL, you must provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HomeDirectoryType, HomeDirectoryType

homeDirectoryType

DescribedAccess.Builder homeDirectoryType(HomeDirectoryType homeDirectoryType)

The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it to LOGICAL, you must provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Parameters:

homeDirectoryType - The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it to LOGICAL, you must provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HomeDirectoryType, HomeDirectoryType

policy

DescribedAccess.Builder policy(String policy)

A scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Parameters:

policy - A scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Returns:

Returns a reference to this object so that method calls can be chained together.

posixProfile

DescribedAccess.Builder posixProfile(PosixProfile posixProfile)

Sets the value of the PosixProfile property for this object.

Parameters:

posixProfile - The new value for the PosixProfile property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

posixProfile

default DescribedAccess.Builder posixProfile(Consumer<PosixProfile.Builder> posixProfile)

Sets the value of the PosixProfile property for this object. This is a convenience that creates an instance of the PosixProfile.Builder avoiding the need to create one manually via PosixProfile.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to posixProfile(PosixProfile).

Parameters:

posixProfile - a consumer that will call methods on PosixProfile.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

posixProfile(PosixProfile)

role

DescribedAccess.Builder role(String role)

The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The policies attached to this role will determine the level of access that you want to provide the associated access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing transfer requests for the associated access.

Parameters:

role - The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The policies attached to this role will determine the level of access that you want to provide the associated access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing transfer requests for the associated access.

Returns:

Returns a reference to this object so that method calls can be chained together.

externalId

DescribedAccess.Builder externalId(String externalId)

A unique identifier that might be required when you assume a role in another account. Think of the ExternalID as a group membership mechanism that uses a unique identifier (often a SID, but could be a group name or something else) as a basis. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Parameters:

externalId - A unique identifier that might be required when you assume a role in another account. Think of the ExternalID as a group membership mechanism that uses a unique identifier (often a SID, but could be a group name or something else) as a basis. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account.

The regex used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Returns:

Returns a reference to this object so that method calls can be chained together.