software.amazon.awssdk.services.transfer.model.DescribedAccess Maven / Gradle / Ivy
Show all versions of transfer Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.transfer.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes the properties of the access that was specified.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribedAccess implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField HOME_DIRECTORY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HomeDirectory").getter(getter(DescribedAccess::homeDirectory)).setter(setter(Builder::homeDirectory))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HomeDirectory").build()).build();
private static final SdkField> HOME_DIRECTORY_MAPPINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("HomeDirectoryMappings")
.getter(getter(DescribedAccess::homeDirectoryMappings))
.setter(setter(Builder::homeDirectoryMappings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HomeDirectoryMappings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HomeDirectoryMapEntry::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField HOME_DIRECTORY_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HomeDirectoryType").getter(getter(DescribedAccess::homeDirectoryTypeAsString))
.setter(setter(Builder::homeDirectoryType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HomeDirectoryType").build()).build();
private static final SdkField POLICY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Policy")
.getter(getter(DescribedAccess::policy)).setter(setter(Builder::policy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Policy").build()).build();
private static final SdkField POSIX_PROFILE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("PosixProfile").getter(getter(DescribedAccess::posixProfile)).setter(setter(Builder::posixProfile))
.constructor(PosixProfile::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PosixProfile").build()).build();
private static final SdkField ROLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Role")
.getter(getter(DescribedAccess::role)).setter(setter(Builder::role))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Role").build()).build();
private static final SdkField EXTERNAL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ExternalId").getter(getter(DescribedAccess::externalId)).setter(setter(Builder::externalId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExternalId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(HOME_DIRECTORY_FIELD,
HOME_DIRECTORY_MAPPINGS_FIELD, HOME_DIRECTORY_TYPE_FIELD, POLICY_FIELD, POSIX_PROFILE_FIELD, ROLE_FIELD,
EXTERNAL_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String homeDirectory;
private final List homeDirectoryMappings;
private final String homeDirectoryType;
private final String policy;
private final PosixProfile posixProfile;
private final String role;
private final String externalId;
private DescribedAccess(BuilderImpl builder) {
this.homeDirectory = builder.homeDirectory;
this.homeDirectoryMappings = builder.homeDirectoryMappings;
this.homeDirectoryType = builder.homeDirectoryType;
this.policy = builder.policy;
this.posixProfile = builder.posixProfile;
this.role = builder.role;
this.externalId = builder.externalId;
}
/**
*
* The landing directory (folder) for a user when they log in to the server using the client.
*
*
* A HomeDirectory example is /bucket_name/home/mydirectory.
*
*
*
* The HomeDirectory parameter is only used if HomeDirectoryType is set to
* PATH.
*
*
*
* @return The landing directory (folder) for a user when they log in to the server using the client.
*
* A HomeDirectory example is /bucket_name/home/mydirectory.
*
*
*
* The HomeDirectory parameter is only used if HomeDirectoryType is set to
* PATH.
*
*/
public final String homeDirectory() {
return homeDirectory;
}
/**
* For responses, this returns true if the service returned a value for the HomeDirectoryMappings property. This
* DOES NOT check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the
* property). This is useful because the SDK will never return a null collection or map, but you may need to
* differentiate between the service returning nothing (or null) and the service returning an empty collection or
* map. For requests, this returns true if a value for the property was specified in the request builder, and false
* if a value was not specified.
*/
public final boolean hasHomeDirectoryMappings() {
return homeDirectoryMappings != null && !(homeDirectoryMappings instanceof SdkAutoConstructList);
}
/**
*
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your
* user 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
* Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and
* Access Management (IAM) role provides access to paths in Target. This value can be set only when
* HomeDirectoryType is set to LOGICAL.
*
*
* In most cases, you can use this value instead of the session 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.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasHomeDirectoryMappings} method.
*
*
* @return Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to
* your user 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 Amazon EFS path. If you only specify a target, it is
* displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access
* to paths in Target. This value can be set only when HomeDirectoryType is set to
* LOGICAL.
*
* In most cases, you can use this value instead of the session 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.
*/
public final List homeDirectoryMappings() {
return homeDirectoryMappings;
}
/**
*
* 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 or Amazon EFS path as
* is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
* in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
* users.
*
*
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
* both HomeDirectory and HomeDirectoryMappings in your template.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType}
* will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #homeDirectoryTypeAsString}.
*
*
* @return 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 or Amazon
* EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need
* to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or
* Amazon EFS paths visible to your users.
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You
* cannot have both HomeDirectory and HomeDirectoryMappings in your template.
*
* @see HomeDirectoryType
*/
public final HomeDirectoryType homeDirectoryType() {
return HomeDirectoryType.fromValue(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 or Amazon EFS path as
* is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
* in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
* users.
*
*
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
* both HomeDirectory and HomeDirectoryMappings in your template.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType}
* will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #homeDirectoryTypeAsString}.
*
*
* @return 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 or Amazon
* EFS path as is in their file transfer protocol clients. If you set it to LOGICAL, you need
* to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or
* Amazon EFS paths visible to your users.
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You
* cannot have both HomeDirectory and HomeDirectoryMappings in your template.
*
* @see HomeDirectoryType
*/
public final String homeDirectoryTypeAsString() {
return homeDirectoryType;
}
/**
*
* A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
* multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you
* can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and
* ${Transfer:HomeBucket}.
*
*
* @return A session policy for your user so that you can use the same Identity and Access Management (IAM) role
* across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket.
* Variables that you can use inside this policy include ${Transfer:UserName},
* ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
*/
public final String policy() {
return policy;
}
/**
* Returns the value of the PosixProfile property for this object.
*
* @return The value of the PosixProfile property for this object.
*/
public final PosixProfile posixProfile() {
return posixProfile;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access
* to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of
* access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or
* Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access
* your resources when servicing your users' transfer requests.
*
*
* @return The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users'
* access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine
* the level of access that you want to provide your users when transferring files into and out of your
* Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that
* allows the server to access your resources when servicing your users' transfer requests.
*/
public final String role() {
return role;
}
/**
*
* A unique identifier that is required to identify specific groups within your directory. The users of the group
* that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using
* Transfer Family. If you know the group name, you can view the SID values by running the following command using
* Windows PowerShell.
*
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression 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: =,.@:/-
*
*
* @return A unique identifier that is required to identify specific groups within your directory. The users of the
* group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols
* using Transfer Family. If you know the group name, you can view the SID values by running the following
* command using Windows PowerShell.
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression 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: =,.@:/-
*/
public final String externalId() {
return externalId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(homeDirectory());
hashCode = 31 * hashCode + Objects.hashCode(hasHomeDirectoryMappings() ? homeDirectoryMappings() : null);
hashCode = 31 * hashCode + Objects.hashCode(homeDirectoryTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(policy());
hashCode = 31 * hashCode + Objects.hashCode(posixProfile());
hashCode = 31 * hashCode + Objects.hashCode(role());
hashCode = 31 * hashCode + Objects.hashCode(externalId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribedAccess)) {
return false;
}
DescribedAccess other = (DescribedAccess) obj;
return Objects.equals(homeDirectory(), other.homeDirectory())
&& hasHomeDirectoryMappings() == other.hasHomeDirectoryMappings()
&& Objects.equals(homeDirectoryMappings(), other.homeDirectoryMappings())
&& Objects.equals(homeDirectoryTypeAsString(), other.homeDirectoryTypeAsString())
&& Objects.equals(policy(), other.policy()) && Objects.equals(posixProfile(), other.posixProfile())
&& Objects.equals(role(), other.role()) && Objects.equals(externalId(), other.externalId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribedAccess").add("HomeDirectory", homeDirectory())
.add("HomeDirectoryMappings", hasHomeDirectoryMappings() ? homeDirectoryMappings() : null)
.add("HomeDirectoryType", homeDirectoryTypeAsString()).add("Policy", policy())
.add("PosixProfile", posixProfile()).add("Role", role()).add("ExternalId", externalId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "HomeDirectory":
return Optional.ofNullable(clazz.cast(homeDirectory()));
case "HomeDirectoryMappings":
return Optional.ofNullable(clazz.cast(homeDirectoryMappings()));
case "HomeDirectoryType":
return Optional.ofNullable(clazz.cast(homeDirectoryTypeAsString()));
case "Policy":
return Optional.ofNullable(clazz.cast(policy()));
case "PosixProfile":
return Optional.ofNullable(clazz.cast(posixProfile()));
case "Role":
return Optional.ofNullable(clazz.cast(role()));
case "ExternalId":
return Optional.ofNullable(clazz.cast(externalId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribedAccess) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The landing directory (folder) for a user when they log in to the server using the client.
*
*
* A HomeDirectory example is /bucket_name/home/mydirectory.
*
*
*
* The HomeDirectory parameter is only used if HomeDirectoryType is set to
* PATH.
*
*
*
* @param homeDirectory
* The landing directory (folder) for a user when they log in to the server using the client.
*
* A HomeDirectory example is /bucket_name/home/mydirectory.
*
*
*
* The HomeDirectory parameter is only used if HomeDirectoryType is set to
* PATH.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder homeDirectory(String homeDirectory);
/**
*
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your
* user 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 Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that
* your Identity and Access Management (IAM) role provides access to paths in Target. This value
* can be set only when HomeDirectoryType is set to LOGICAL.
*
*
* In most cases, you can use this value instead of the session 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.
*
*
* @param homeDirectoryMappings
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible
* to your user 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 Amazon EFS path. If you only specify a target, it is
* displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides
* access to paths in Target. This value can be set only when HomeDirectoryType
* is set to LOGICAL.
*
* In most cases, you can use this value instead of the session 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder homeDirectoryMappings(Collection homeDirectoryMappings);
/**
*
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your
* user 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 Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that
* your Identity and Access Management (IAM) role provides access to paths in Target. This value
* can be set only when HomeDirectoryType is set to LOGICAL.
*
*
* In most cases, you can use this value instead of the session 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.
*
*
* @param homeDirectoryMappings
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible
* to your user 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 Amazon EFS path. If you only specify a target, it is
* displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides
* access to paths in Target. This value can be set only when HomeDirectoryType
* is set to LOGICAL.
*
* In most cases, you can use this value instead of the session 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings);
/**
*
* Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your
* user 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 Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that
* your Identity and Access Management (IAM) role provides access to paths in Target. This value
* can be set only when HomeDirectoryType is set to LOGICAL.
*
*
* In most cases, you can use this value instead of the session 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 method that creates an instance of the
* {@link software.amazon.awssdk.services.transfer.model.HomeDirectoryMapEntry.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.transfer.model.HomeDirectoryMapEntry#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.transfer.model.HomeDirectoryMapEntry.Builder#build()} is called
* immediately and its result is passed to {@link #homeDirectoryMappings(List)}.
*
* @param homeDirectoryMappings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.transfer.model.HomeDirectoryMapEntry.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #homeDirectoryMappings(java.util.Collection)
*/
Builder homeDirectoryMappings(Consumer... homeDirectoryMappings);
/**
*
* 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 or Amazon EFS
* path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to
* provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS
* paths visible to your users.
*
*
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
* have both HomeDirectory and HomeDirectoryMappings in your template.
*
*
*
* @param 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 or
* Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL,
* you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon
* S3 or Amazon EFS paths visible to your users.
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You
* cannot have both HomeDirectory and HomeDirectoryMappings in your template.
*
* @see HomeDirectoryType
* @return Returns a reference to this object so that method calls can be chained together.
* @see HomeDirectoryType
*/
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 or Amazon EFS
* path as is in their file transfer protocol clients. If you set it to LOGICAL, you need to
* provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS
* paths visible to your users.
*
*
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
* have both HomeDirectory and HomeDirectoryMappings in your template.
*
*
*
* @param 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 or
* Amazon EFS path as is in their file transfer protocol clients. If you set it to LOGICAL,
* you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon
* S3 or Amazon EFS paths visible to your users.
*
* If HomeDirectoryType is LOGICAL, you must provide mappings, using the
* HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
* PATH, you provide an absolute path using the HomeDirectory parameter. You
* cannot have both HomeDirectory and HomeDirectoryMappings in your template.
*
* @see HomeDirectoryType
* @return Returns a reference to this object so that method calls can be chained together.
* @see HomeDirectoryType
*/
Builder homeDirectoryType(HomeDirectoryType homeDirectoryType);
/**
*
* A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
* multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that
* you can use inside this policy include ${Transfer:UserName},
* ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
*
*
* @param policy
* A session policy for your user so that you can use the same Identity and Access Management (IAM) role
* across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket.
* Variables that you can use inside this policy include ${Transfer:UserName},
* ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policy(String policy);
/**
* Sets the value of the PosixProfile property for this object.
*
* @param posixProfile
* The new value for the PosixProfile property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder posixProfile(PosixProfile posixProfile);
/**
* Sets the value of the PosixProfile property for this object.
*
* This is a convenience method that creates an instance of the {@link PosixProfile.Builder} avoiding the need
* to create one manually via {@link PosixProfile#builder()}.
*
*
* When the {@link Consumer} completes, {@link PosixProfile.Builder#build()} is called immediately and its
* result is passed to {@link #posixProfile(PosixProfile)}.
*
* @param posixProfile
* a consumer that will call methods on {@link PosixProfile.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #posixProfile(PosixProfile)
*/
default Builder posixProfile(Consumer posixProfile) {
return posixProfile(PosixProfile.builder().applyMutation(posixProfile).build());
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users'
* access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the
* level of access that you want to provide your users when transferring files into and out of your Amazon S3
* bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the
* server to access your resources when servicing your users' transfer requests.
*
*
* @param role
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your
* users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role
* determine the level of access that you want to provide your users when transferring files into and out
* of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust
* relationship that allows the server to access your resources when servicing your users' transfer
* requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder role(String role);
/**
*
* A unique identifier that is required to identify specific groups within your directory. The users of the
* group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols
* using Transfer Family. If you know the group name, you can view the SID values by running the following
* command using Windows PowerShell.
*
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression 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: =,.@:/-
*
*
* @param externalId
* A unique identifier that is required to identify specific groups within your directory. The users of
* the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled
* protocols using Transfer Family. If you know the group name, you can view the SID values by running
* the following command using Windows PowerShell.
*
* Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
*
*
* In that command, replace YourGroupName with the name of your Active Directory group.
*
*
* The regular expression 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: =,.@:/-
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder externalId(String externalId);
}
static final class BuilderImpl implements Builder {
private String homeDirectory;
private List homeDirectoryMappings = DefaultSdkAutoConstructList.getInstance();
private String homeDirectoryType;
private String policy;
private PosixProfile posixProfile;
private String role;
private String externalId;
private BuilderImpl() {
}
private BuilderImpl(DescribedAccess model) {
homeDirectory(model.homeDirectory);
homeDirectoryMappings(model.homeDirectoryMappings);
homeDirectoryType(model.homeDirectoryType);
policy(model.policy);
posixProfile(model.posixProfile);
role(model.role);
externalId(model.externalId);
}
public final String getHomeDirectory() {
return homeDirectory;
}
public final void setHomeDirectory(String homeDirectory) {
this.homeDirectory = homeDirectory;
}
@Override
public final Builder homeDirectory(String homeDirectory) {
this.homeDirectory = homeDirectory;
return this;
}
public final List getHomeDirectoryMappings() {
List result = HomeDirectoryMappingsCopier.copyToBuilder(this.homeDirectoryMappings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHomeDirectoryMappings(Collection homeDirectoryMappings) {
this.homeDirectoryMappings = HomeDirectoryMappingsCopier.copyFromBuilder(homeDirectoryMappings);
}
@Override
public final Builder homeDirectoryMappings(Collection homeDirectoryMappings) {
this.homeDirectoryMappings = HomeDirectoryMappingsCopier.copy(homeDirectoryMappings);
return this;
}
@Override
@SafeVarargs
public final Builder homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings) {
homeDirectoryMappings(Arrays.asList(homeDirectoryMappings));
return this;
}
@Override
@SafeVarargs
public final Builder homeDirectoryMappings(Consumer... homeDirectoryMappings) {
homeDirectoryMappings(Stream.of(homeDirectoryMappings)
.map(c -> HomeDirectoryMapEntry.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getHomeDirectoryType() {
return homeDirectoryType;
}
public final void setHomeDirectoryType(String homeDirectoryType) {
this.homeDirectoryType = homeDirectoryType;
}
@Override
public final Builder homeDirectoryType(String homeDirectoryType) {
this.homeDirectoryType = homeDirectoryType;
return this;
}
@Override
public final Builder homeDirectoryType(HomeDirectoryType homeDirectoryType) {
this.homeDirectoryType(homeDirectoryType == null ? null : homeDirectoryType.toString());
return this;
}
public final String getPolicy() {
return policy;
}
public final void setPolicy(String policy) {
this.policy = policy;
}
@Override
public final Builder policy(String policy) {
this.policy = policy;
return this;
}
public final PosixProfile.Builder getPosixProfile() {
return posixProfile != null ? posixProfile.toBuilder() : null;
}
public final void setPosixProfile(PosixProfile.BuilderImpl posixProfile) {
this.posixProfile = posixProfile != null ? posixProfile.build() : null;
}
@Override
public final Builder posixProfile(PosixProfile posixProfile) {
this.posixProfile = posixProfile;
return this;
}
public final String getRole() {
return role;
}
public final void setRole(String role) {
this.role = role;
}
@Override
public final Builder role(String role) {
this.role = role;
return this;
}
public final String getExternalId() {
return externalId;
}
public final void setExternalId(String externalId) {
this.externalId = externalId;
}
@Override
public final Builder externalId(String externalId) {
this.externalId = externalId;
return this;
}
@Override
public DescribedAccess build() {
return new DescribedAccess(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}