Class UpdateLocationSmbRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateLocationSmbRequest.Builder,
UpdateLocationSmbRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionSpecifies the DataSync agent (or agents) that can connect to your SMB file server.final SmbAuthenticationType
Specifies the authentication protocol that DataSync uses to connect to your SMB file server.final String
Specifies the authentication protocol that DataSync uses to connect to your SMB file server.builder()
Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to.final String
domain()
Specifies the Windows domain name that your SMB file server belongs to.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AgentArns property.final boolean
For responses, this returns true if the service returned a value for the DnsIpAddresses property.final int
hashCode()
final SdkBytes
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.final SdkBytes
Specifies a Kerberos configuration file (krb5.conf
) that defines your Kerberos realm configuration.final String
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.final String
Specifies the ARN of the SMB location that you want to update.final SmbMountOptions
Returns the value of the MountOptions property for this object.final String
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.static Class
<? extends UpdateLocationSmbRequest.Builder> final String
Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.final String
Specifies the name of the share exported by your SMB file server where DataSync will read or write data.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
locationArn
Specifies the ARN of the SMB location that you want to update.
- Returns:
- Specifies the ARN of the SMB location that you want to update.
-
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 Providing DataSync access to SMB file servers.
- Returns:
- 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 Providing DataSync access to SMB file servers.
-
serverHostname
Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.
If you're using Kerberos authentication, you must specify a domain name.
- Returns:
- Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent
connects to.
If you're using Kerberos authentication, you must specify a domain name.
-
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. This parameter applies only if
AuthenticationType
is set toNTLM
.For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
- Returns:
- Specifies the user name that can mount your SMB file server and has permission to access the files and
folders involved in your transfer. This parameter applies only if
AuthenticationType
is set toNTLM
.For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.
-
domain
Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if
AuthenticationType
is set toNTLM
.If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
- Returns:
- Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if
AuthenticationType
is set toNTLM
.If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
-
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. This parameter applies only if
AuthenticationType
is set toNTLM
.- Returns:
- 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. This parameter applies only if
AuthenticationType
is set toNTLM
.
-
hasAgentArns
public final boolean hasAgentArns()For responses, this returns true if the service returned a value for the AgentArns 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. -
agentArns
Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
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
hasAgentArns()
method.- Returns:
- Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
-
mountOptions
Returns the value of the MountOptions property for this object.- Returns:
- The value of the MountOptions property for this object.
-
authenticationType
Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports
NTLM
(default) andKERBEROS
authentication.For more information, see Providing DataSync access to SMB file servers.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnSmbAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync
supports
NTLM
(default) andKERBEROS
authentication.For more information, see Providing DataSync access to SMB file servers.
- See Also:
-
authenticationTypeAsString
Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports
NTLM
(default) andKERBEROS
authentication.For more information, see Providing DataSync access to SMB file servers.
If the service returns an enum value that is not available in the current SDK version,
authenticationType
will returnSmbAuthenticationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthenticationTypeAsString()
.- Returns:
- Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync
supports
NTLM
(default) andKERBEROS
authentication.For more information, see Providing DataSync access to SMB file servers.
- See Also:
-
hasDnsIpAddresses
public final boolean hasDnsIpAddresses()For responses, this returns true if the service returned a value for the DnsIpAddresses 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. -
dnsIpAddresses
Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to. This parameter applies only if
AuthenticationType
is set toKERBEROS
.If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
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
hasDnsIpAddresses()
method.- Returns:
- Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to. This
parameter applies only if
AuthenticationType
is set toKERBEROS
.If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
-
kerberosPrincipal
Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.
A Kerberos principal might look like
HOST/kerberosuser@MYDOMAIN.ORG
.Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
- Returns:
- Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access
the files, folders, and file metadata in your SMB file server.
A Kerberos principal might look like
HOST/kerberosuser@MYDOMAIN.ORG
.Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.
-
kerberosKeytab
Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for
KerberosPrincipal
.- Returns:
- Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal
and encryption keys.
To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for
KerberosPrincipal
.
-
kerberosKrb5Conf
Specifies a Kerberos configuration file (
krb5.conf
) that defines your Kerberos realm configuration.The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
- Returns:
- Specifies a Kerberos configuration file (
krb5.conf
) that defines your Kerberos realm configuration.The file must be base64 encoded. If you're using the CLI, the encoding is done for you.
-
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 interfaceToCopyableBuilder<UpdateLocationSmbRequest.Builder,
UpdateLocationSmbRequest> - Specified by:
toBuilder
in classDataSyncRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-