software.amazon.awssdk.services.transfer.model

Class ListedAccess

java.lang.Object

software.amazon.awssdk.services.transfer.model.ListedAccess

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ListedAccess.Builder,ListedAccess>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListedAccess
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ListedAccess.Builder,ListedAccess>

Lists the properties for one or more specified associated accesses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListedAccess.Builder

Method Summary

Modifier and Type	Method and Description
static ListedAccess.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() A unique identifier that might be required when you assume a role in another account.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
HomeDirectoryType	homeDirectoryType() The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
String	homeDirectoryTypeAsString() The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
String	role() The AWS Identity and Access Management (IAM) role that controls access to your Amazon S3 bucket from the specified associated access.
List<SdkField<?>>	sdkFields()
static Class<? extends ListedAccess.Builder>	serializableBuilderClass()
ListedAccess.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

homeDirectory

public final 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.

Returns:

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.

homeDirectoryType

public final 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.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

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.

See Also:

HomeDirectoryType

homeDirectoryTypeAsString

public final String homeDirectoryTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

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.

See Also:

HomeDirectoryType

role

public final String role()

The AWS Identity and Access Management (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:

The AWS Identity and Access Management (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.

externalId

public final 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: =,.@:/-

Returns:

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: =,.@:/-

toBuilder

public ListedAccess.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListedAccess.Builder,ListedAccess>

builder

public static ListedAccess.Builder builder()

serializableBuilderClass

public static Class<? extends ListedAccess.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo