Interface CreateLocationFsxWindowsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>, DataSyncRequest.Builder, SdkBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateLocationFsxWindowsRequest
@Mutable @NotThreadSafe public static interface CreateLocationFsxWindowsRequest.Builder extends DataSyncRequest.Builder, SdkPojo, CopyableBuilder<CreateLocationFsxWindowsRequest.Builder,CreateLocationFsxWindowsRequest>

  • Method Details

    • subdirectory

      CreateLocationFsxWindowsRequest.Builder subdirectory(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • fsxFilesystemArn

      CreateLocationFsxWindowsRequest.Builder fsxFilesystemArn(String fsxFilesystemArn)

      Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

      Parameters:
      fsxFilesystemArn - Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityGroupArns

      CreateLocationFsxWindowsRequest.Builder securityGroupArns(Collection<String> securityGroupArns)

      Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

      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.

      Parameters:
      securityGroupArns - Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

      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.

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

    • securityGroupArns

      CreateLocationFsxWindowsRequest.Builder securityGroupArns(String... securityGroupArns)

      Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

      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.

      Parameters:
      securityGroupArns - Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

      The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .

      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.

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

    • tags

      CreateLocationFsxWindowsRequest.Builder tags(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationFsxWindowsRequest.Builder tags(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateLocationFsxWindowsRequest.Builder tags(Consumer<TagListEntry.Builder>... 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.

      This is a convenience method that creates an instance of the TagListEntry.Builder avoiding the need to create one manually via TagListEntry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<TagListEntry>).

      Parameters:
      tags - a consumer that will call methods on TagListEntry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • user

      CreateLocationFsxWindowsRequest.Builder user(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • domain

      CreateLocationFsxWindowsRequest.Builder domain(String domain)

      Specifies the name of the Windows 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.

      Parameters:
      domain - Specifies the name of the Windows 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:
      Returns a reference to this object so that method calls can be chained together.

    • password

      CreateLocationFsxWindowsRequest.Builder password(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cmkSecretConfig

      CreateLocationFsxWindowsRequest.Builder cmkSecretConfig(CmkSecretConfig cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx Windows storage location, with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxWindows request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

      Parameters:
      cmkSecretConfig - Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx Windows storage location, with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxWindows request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

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

    • cmkSecretConfig

      default CreateLocationFsxWindowsRequest.Builder cmkSecretConfig(Consumer<CmkSecretConfig.Builder> cmkSecretConfig)

      Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx Windows storage location, with a customer-managed KMS key.

      When you include this parameter as part of a CreateLocationFsxWindows request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

      Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CmkSecretConfig.Builder avoiding the need to create one manually via CmkSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cmkSecretConfig(CmkSecretConfig).

      Parameters:
      cmkSecretConfig - a consumer that will call methods on CmkSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • customSecretConfig

      CreateLocationFsxWindowsRequest.Builder customSecretConfig(CustomSecretConfig customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for Windows File Server storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

      Parameters:
      customSecretConfig - Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for Windows File Server storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

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

    • customSecretConfig

      default CreateLocationFsxWindowsRequest.Builder customSecretConfig(Consumer<CustomSecretConfig.Builder> customSecretConfig)

      Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for Windows File Server storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

      You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.

      This is a convenience method that creates an instance of the CustomSecretConfig.Builder avoiding the need to create one manually via CustomSecretConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customSecretConfig(CustomSecretConfig).

      Parameters:
      customSecretConfig - a consumer that will call methods on CustomSecretConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateLocationFsxWindowsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateLocationFsxWindowsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.