Class CreateLocationFsxWindowsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.datasync.model.DataSyncRequest
-
- software.amazon.awssdk.services.datasync.model.CreateLocationFsxWindowsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateLocationFsxWindowsRequest extends DataSyncRequest implements ToCopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateLocationFsxWindowsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateLocationFsxWindowsRequest.Builderbuilder()Stringdomain()Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfsxFilesystemArn()Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSecurityGroupArns()For responses, this returns true if the service returned a value for the SecurityGroupArns property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringpassword()Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.List<SdkField<?>>sdkFields()List<String>securityGroupArns()Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.static Class<? extends CreateLocationFsxWindowsRequest.Builder>serializableBuilderClass()Stringsubdirectory()Specifies a mount path for your file system using forward slashes.List<TagListEntry>tags()Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.CreateLocationFsxWindowsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringuser()Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
subdirectory
public final String subdirectory()
Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
- Returns:
- Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
-
fsxFilesystemArn
public final String fsxFilesystemArn()
Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
- Returns:
- Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
-
hasSecurityGroupArns
public final boolean hasSecurityGroupArns()
For responses, this returns true if the service returned a value for the SecurityGroupArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
securityGroupArns
public final List<String> securityGroupArns()
Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.
If you choose a security group that doesn't allow connections from within itself, do one of the following:
-
Configure the security group to allow it to communicate within itself.
-
Choose a different security group that can communicate with the mount target's security group.
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
hasSecurityGroupArns()method.- Returns:
- Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.
If you choose a security group that doesn't allow connections from within itself, do one of the following:
-
Configure the security group to allow it to communicate within itself.
-
Choose a different security group that can communicate with the mount target's security group.
-
-
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final List<TagListEntry> tags()
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
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
hasTags()method.- Returns:
- Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
-
user
public final String user()
Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
- Returns:
- Specifies the user with the permissions to mount and access the files, folders, and file metadata in your
FSx for Windows File Server file system.
For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
-
domain
public final String domain()
Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
- Returns:
- Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file
system belongs to.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
-
password
public final String password()
Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
- Returns:
- Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
-
toBuilder
public CreateLocationFsxWindowsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>- Specified by:
toBuilderin classDataSyncRequest
-
builder
public static CreateLocationFsxWindowsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateLocationFsxWindowsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-