Interface UpdateLocationSmbRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateLocationSmbRequest.Builder,
,UpdateLocationSmbRequest> DataSyncRequest.Builder
,SdkBuilder<UpdateLocationSmbRequest.Builder,
,UpdateLocationSmbRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateLocationSmbRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the DataSync agent (or agents) which you want to connect to your SMB file server.agentArns
(Collection<String> agentArns) Specifies the DataSync agent (or agents) which you want to connect to your SMB file server.Specifies the Windows domain name that your SMB file server belongs to.locationArn
(String locationArn) Specifies the ARN of the SMB location that you want to update.default UpdateLocationSmbRequest.Builder
mountOptions
(Consumer<SmbMountOptions.Builder> mountOptions) Sets the value of the MountOptions property for this object.mountOptions
(SmbMountOptions mountOptions) Sets the value of the MountOptions property for this object.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.subdirectory
(String subdirectory) Specifies the name of the share exported by your SMB file server where DataSync will read or write data.Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
locationArn
Specifies the ARN of the SMB location that you want to update.
- Parameters:
locationArn
- Specifies the ARN of the SMB location that you want to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subdirectory
Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example,
/path/to/subdirectory
). Make sure that other SMB clients in your network can also mount this path.To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.
- Parameters:
subdirectory
- Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example,/path/to/subdirectory
). Make sure that other SMB clients in your network can also mount this path.To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
user
Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.
For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.
- Parameters:
user
- Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domain
Specifies the Windows domain name that your SMB file server belongs to.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
For more information, see required permissions for SMB locations.
- Parameters:
domain
- Specifies the Windows domain name that your SMB file server belongs to.If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
For more information, see required permissions for SMB locations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
For more information, see required permissions for SMB locations.
- Parameters:
password
- Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.For more information, see required permissions for SMB locations.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentArns
Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
- Parameters:
agentArns
- Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
agentArns
Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
- Parameters:
agentArns
- Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mountOptions
Sets the value of the MountOptions property for this object.- Parameters:
mountOptions
- The new value for the MountOptions property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mountOptions
default UpdateLocationSmbRequest.Builder mountOptions(Consumer<SmbMountOptions.Builder> mountOptions) Sets the value of the MountOptions property for this object. This is a convenience method that creates an instance of theSmbMountOptions.Builder
avoiding the need to create one manually viaSmbMountOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomountOptions(SmbMountOptions)
.- Parameters:
mountOptions
- a consumer that will call methods onSmbMountOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
UpdateLocationSmbRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateLocationSmbRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-