CreateSMBFileShareRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.storagegateway.model.CreateSMBFileShareRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateSMBFileShareRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

CreateSMBFileShareInput

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateSMBFileShareRequest()

Constructors
Constructor and Description
`CreateSMBFileShareRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateSMBFileShareRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getAdminUserList()` A list of users in the Active Directory that will be granted administrator privileges on the file share.
`String`	`getAuthentication()` The authentication method that users use to access the file share.
`String`	`getClientToken()` A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
`String`	`getDefaultStorageClass()` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`String`	`getGatewayARN()` The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
`Boolean`	`getGuessMIMETypeEnabled()` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`List<String>`	`getInvalidUserList()` A list of users or groups in the Active Directory that are not allowed to access the file share.
`Boolean`	`getKMSEncrypted()` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`String`	`getKMSKey()` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`String`	`getLocationARN()` The ARN of the backed storage used for storing file data.
`String`	`getObjectACL()` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`Boolean`	`getReadOnly()` A value that sets the write status of a file share.
`Boolean`	`getRequesterPays()` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`String`	`getRole()` The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
`Boolean`	`getSMBACLEnabled()` Set this value to "true to enable ACL (access control list) on the SMB file share.
`List<Tag>`	`getTags()` A list of up to 50 tags that can be assigned to the NFS file share.
`List<String>`	`getValidUserList()` A list of users or groups in the Active Directory that are allowed to access the file share.
`int`	`hashCode()`
`Boolean`	`isGuessMIMETypeEnabled()` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`Boolean`	`isKMSEncrypted()` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`Boolean`	`isReadOnly()` A value that sets the write status of a file share.
`Boolean`	`isRequesterPays()` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`Boolean`	`isSMBACLEnabled()` Set this value to "true to enable ACL (access control list) on the SMB file share.
`void`	`setAdminUserList(Collection<String> adminUserList)` A list of users in the Active Directory that will be granted administrator privileges on the file share.
`void`	`setAuthentication(String authentication)` The authentication method that users use to access the file share.
`void`	`setClientToken(String clientToken)` A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
`void`	`setDefaultStorageClass(String defaultStorageClass)` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`void`	`setGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
`void`	`setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`void`	`setInvalidUserList(Collection<String> invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`void`	`setKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`void`	`setKMSKey(String kMSKey)` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`void`	`setLocationARN(String locationARN)` The ARN of the backed storage used for storing file data.
`void`	`setObjectACL(String objectACL)` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`void`	`setReadOnly(Boolean readOnly)` A value that sets the write status of a file share.
`void`	`setRequesterPays(Boolean requesterPays)` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`void`	`setRole(String role)` The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
`void`	`setSMBACLEnabled(Boolean sMBACLEnabled)` Set this value to "true to enable ACL (access control list) on the SMB file share.
`void`	`setTags(Collection<Tag> tags)` A list of up to 50 tags that can be assigned to the NFS file share.
`void`	`setValidUserList(Collection<String> validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.
`String`	`toString()` Returns a string representation of this object.
`CreateSMBFileShareRequest`	`withAdminUserList(Collection<String> adminUserList)` A list of users in the Active Directory that will be granted administrator privileges on the file share.
`CreateSMBFileShareRequest`	`withAdminUserList(String... adminUserList)` A list of users in the Active Directory that will be granted administrator privileges on the file share.
`CreateSMBFileShareRequest`	`withAuthentication(String authentication)` The authentication method that users use to access the file share.
`CreateSMBFileShareRequest`	`withClientToken(String clientToken)` A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
`CreateSMBFileShareRequest`	`withDefaultStorageClass(String defaultStorageClass)` The default storage class for objects put into an Amazon S3 bucket by the file gateway.
`CreateSMBFileShareRequest`	`withGatewayARN(String gatewayARN)` The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
`CreateSMBFileShareRequest`	`withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)` A value that enables guessing of the MIME type for uploaded objects based on file extensions.
`CreateSMBFileShareRequest`	`withInvalidUserList(Collection<String> invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`CreateSMBFileShareRequest`	`withInvalidUserList(String... invalidUserList)` A list of users or groups in the Active Directory that are not allowed to access the file share.
`CreateSMBFileShareRequest`	`withKMSEncrypted(Boolean kMSEncrypted)` True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3.
`CreateSMBFileShareRequest`	`withKMSKey(String kMSKey)` The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption.
`CreateSMBFileShareRequest`	`withLocationARN(String locationARN)` The ARN of the backed storage used for storing file data.
`CreateSMBFileShareRequest`	`withObjectACL(ObjectACL objectACL)` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`CreateSMBFileShareRequest`	`withObjectACL(String objectACL)` A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into.
`CreateSMBFileShareRequest`	`withReadOnly(Boolean readOnly)` A value that sets the write status of a file share.
`CreateSMBFileShareRequest`	`withRequesterPays(Boolean requesterPays)` A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket.
`CreateSMBFileShareRequest`	`withRole(String role)` The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
`CreateSMBFileShareRequest`	`withSMBACLEnabled(Boolean sMBACLEnabled)` Set this value to "true to enable ACL (access control list) on the SMB file share.
`CreateSMBFileShareRequest`	`withTags(Collection<Tag> tags)` A list of up to 50 tags that can be assigned to the NFS file share.
`CreateSMBFileShareRequest`	`withTags(Tag... tags)` A list of up to 50 tags that can be assigned to the NFS file share.
`CreateSMBFileShareRequest`	`withValidUserList(Collection<String> validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.
`CreateSMBFileShareRequest`	`withValidUserList(String... validUserList)` A list of users or groups in the Active Directory that are allowed to access the file share.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateSMBFileShareRequest
```
public CreateSMBFileShareRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
    
    Parameters:
    
    clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
  - getClientToken
```
public String getClientToken()
```
    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
    
    Returns:
    
    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
  - withClientToken
```
public CreateSMBFileShareRequest withClientToken(String clientToken)
```
    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
    
    Parameters:
    
    clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGatewayARN
```
public void setGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
    
    Parameters:
    
    gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
  - getGatewayARN
```
public String getGatewayARN()
```
    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
  - withGatewayARN
```
public CreateSMBFileShareRequest withGatewayARN(String gatewayARN)
```
    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
    
    Parameters:
    
    gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKMSEncrypted
```
public void setKMSEncrypted(Boolean kMSEncrypted)
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Parameters:
    
    kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - getKMSEncrypted
```
public Boolean getKMSEncrypted()
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - withKMSEncrypted
```
public CreateSMBFileShareRequest withKMSEncrypted(Boolean kMSEncrypted)
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Parameters:
    
    kMSEncrypted - True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isKMSEncrypted
```
public Boolean isKMSEncrypted()
```
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
    
    Returns:
    
    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.
  - setKMSKey
```
public void setKMSKey(String kMSKey)
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Parameters:
    
    kMSKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
  - getKMSKey
```
public String getKMSKey()
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
  - withKMSKey
```
public CreateSMBFileShareRequest withKMSKey(String kMSKey)
```
    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Parameters:
    
    kMSKey - The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String role)
```
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    
    Parameters:
    
    role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
  - getRole
```
public String getRole()
```
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    
    Returns:
    
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
  - withRole
```
public CreateSMBFileShareRequest withRole(String role)
```
    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    
    Parameters:
    
    role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocationARN
```
public void setLocationARN(String locationARN)
```
    The ARN of the backed storage used for storing file data.
    
    Parameters:
    
    locationARN - The ARN of the backed storage used for storing file data.
  - getLocationARN
```
public String getLocationARN()
```
    The ARN of the backed storage used for storing file data.
    
    Returns:
    
    The ARN of the backed storage used for storing file data.
  - withLocationARN
```
public CreateSMBFileShareRequest withLocationARN(String locationARN)
```
    The ARN of the backed storage used for storing file data.
    
    Parameters:
    
    locationARN - The ARN of the backed storage used for storing file data.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultStorageClass
```
public void setDefaultStorageClass(String defaultStorageClass)
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Parameters:
    
    defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
  - getDefaultStorageClass
```
public String getDefaultStorageClass()
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Returns:
    
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
  - withDefaultStorageClass
```
public CreateSMBFileShareRequest withDefaultStorageClass(String defaultStorageClass)
```
    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Parameters:
    
    defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectACL
```
public void setObjectACL(String objectACL)
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Parameters:
    
    objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    See Also:
    
    ObjectACL
  - getObjectACL
```
public String getObjectACL()
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Returns:
    
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    See Also:
    
    ObjectACL
  - withObjectACL
```
public CreateSMBFileShareRequest withObjectACL(String objectACL)
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Parameters:
    
    objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL
  - withObjectACL
```
public CreateSMBFileShareRequest withObjectACL(ObjectACL objectACL)
```
    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Parameters:
    
    objectACL - A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is "private".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ObjectACL
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Parameters:
    
    readOnly - A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - getReadOnly
```
public Boolean getReadOnly()
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - withReadOnly
```
public CreateSMBFileShareRequest withReadOnly(Boolean readOnly)
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Parameters:
    
    readOnly - A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadOnly
```
public Boolean isReadOnly()
```
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
    
    Returns:
    
    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
  - setGuessMIMETypeEnabled
```
public void setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
```
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
    
    Parameters:
    
    guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
  - getGuessMIMETypeEnabled
```
public Boolean getGuessMIMETypeEnabled()
```
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
    
    Returns:
    
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
  - withGuessMIMETypeEnabled
```
public CreateSMBFileShareRequest withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
```
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
    
    Parameters:
    
    guessMIMETypeEnabled - A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isGuessMIMETypeEnabled
```
public Boolean isGuessMIMETypeEnabled()
```
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
    
    Returns:
    
    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.
  - setRequesterPays
```
public void setRequesterPays(Boolean requesterPays)
```
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Parameters:
    
    requesterPays - A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
  - getRequesterPays
```
public Boolean getRequesterPays()
```
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Returns:
    
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
  - withRequesterPays
```
public CreateSMBFileShareRequest withRequesterPays(Boolean requesterPays)
```
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Parameters:
    
    requesterPays - A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequesterPays
```
public Boolean isRequesterPays()
```
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
    
    Returns:
    
    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.
    
    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.
  - setSMBACLEnabled
```
public void setSMBACLEnabled(Boolean sMBACLEnabled)
```
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Parameters:
    
    sMBACLEnabled - Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - getSMBACLEnabled
```
public Boolean getSMBACLEnabled()
```
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - withSMBACLEnabled
```
public CreateSMBFileShareRequest withSMBACLEnabled(Boolean sMBACLEnabled)
```
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Parameters:
    
    sMBACLEnabled - Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSMBACLEnabled
```
public Boolean isSMBACLEnabled()
```
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
    
    Returns:
    
    Set this value to "true to enable ACL (access control list) on the SMB file share. Set it to "false" to map file and directory permissions to the POSIX permissions.
    
    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
  - getAdminUserList
```
public List<String> getAdminUserList()
```
    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    Returns:
    
    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
  - setAdminUserList
```
public void setAdminUserList(Collection<String> adminUserList)
```
    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    Parameters:
    
    adminUserList - A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
  - withAdminUserList
```
public CreateSMBFileShareRequest withAdminUserList(String... adminUserList)
```
    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdminUserList(java.util.Collection) or withAdminUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    adminUserList - A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdminUserList
```
public CreateSMBFileShareRequest withAdminUserList(Collection<String> adminUserList)
```
    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    Parameters:
    
    adminUserList - A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.
    
    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getValidUserList
```
public List<String> getValidUserList()
```
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - setValidUserList
```
public void setValidUserList(Collection<String> validUserList)
```
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - withValidUserList
```
public CreateSMBFileShareRequest withValidUserList(String... validUserList)
```
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    NOTE: This method appends the values to the existing list (if any). Use setValidUserList(java.util.Collection) or withValidUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withValidUserList
```
public CreateSMBFileShareRequest withValidUserList(Collection<String> validUserList)
```
    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    validUserList - A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInvalidUserList
```
public List<String> getInvalidUserList()
```
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - setInvalidUserList
```
public void setInvalidUserList(Collection<String> invalidUserList)
```
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
  - withInvalidUserList
```
public CreateSMBFileShareRequest withInvalidUserList(String... invalidUserList)
```
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    NOTE: This method appends the values to the existing list (if any). Use setInvalidUserList(java.util.Collection) or withInvalidUserList(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInvalidUserList
```
public CreateSMBFileShareRequest withInvalidUserList(Collection<String> invalidUserList)
```
    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Parameters:
    
    invalidUserList - A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAuthentication
```
public void setAuthentication(String authentication)
```
    The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
    
    Parameters:
    
    authentication - The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
  - getAuthentication
```
public String getAuthentication()
```
    The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
    
    Returns:
    
    The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
  - withAuthentication
```
public CreateSMBFileShareRequest withAuthentication(String authentication)
```
    The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
    
    Parameters:
    
    authentication - The authentication method that users use to access the file share.
    
    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
  - withTags
```
public CreateSMBFileShareRequest withTags(Tag... tags)
```
    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateSMBFileShareRequest withTags(Collection<Tag> tags)
```
    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Parameters:
    
    tags - A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.
    
    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateSMBFileShareRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateSMBFileShareRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateSMBFileShareRequest

Method Detail

setClientToken

getClientToken

withClientToken

setGatewayARN

getGatewayARN

withGatewayARN

setKMSEncrypted

getKMSEncrypted

withKMSEncrypted

isKMSEncrypted

setKMSKey

getKMSKey

withKMSKey

setRole

getRole

withRole

setLocationARN

getLocationARN

withLocationARN

setDefaultStorageClass

getDefaultStorageClass

withDefaultStorageClass

setObjectACL

getObjectACL

withObjectACL

withObjectACL

setReadOnly

getReadOnly

withReadOnly

isReadOnly

setGuessMIMETypeEnabled

getGuessMIMETypeEnabled

withGuessMIMETypeEnabled

isGuessMIMETypeEnabled

setRequesterPays

getRequesterPays

withRequesterPays

isRequesterPays

setSMBACLEnabled

getSMBACLEnabled

withSMBACLEnabled

isSMBACLEnabled

getAdminUserList

setAdminUserList

withAdminUserList

withAdminUserList

getValidUserList

setValidUserList

withValidUserList

withValidUserList

getInvalidUserList

setInvalidUserList

withInvalidUserList

withInvalidUserList

setAuthentication

getAuthentication

withAuthentication

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone