Package software.amazon.awssdk.services.datasync.model

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>

  • Method Details

    • 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 the 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.

    • 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 the 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.

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>
      Specified by:
      toBuilder in class DataSyncRequest
      Returns:
      a builder for type T

    • builder

      public static CreateLocationFsxWindowsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.