@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateSMBFileShareRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateSMBFileShareInput
NOOP| Constructor and Description |
|---|
CreateSMBFileShareRequest() |
| 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) |
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 file gateway.
|
String |
getGatewayARN()
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
|
Boolean |
getGuessMIMETypeEnabled()
Enables guessing of the MIME type for uploaded objects based on file extensions.
|
List<String> |
getInvalidUserList()
A list of users 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) KMS key used for Amazon S3 server side encryption.
|
String |
getLocationARN()
The ARN of the backed storage used for storing file data.
|
String |
getObjectACL()
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects
into.
|
Boolean |
getReadOnly()
Sets the write status of a file share.
|
Boolean |
getRequesterPays()
Sets who pays the cost of the request and the data download from the Amazon 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.
|
List<String> |
getValidUserList()
A list of users in the Active Directory that are allowed to access the file share.
|
int |
hashCode() |
Boolean |
isGuessMIMETypeEnabled()
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()
Sets the write status of a file share.
|
Boolean |
isRequesterPays()
Sets who pays the cost of the request and the data download from the Amazon S3 bucket.
|
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 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)
Enables guessing of the MIME type for uploaded objects based on file extensions.
|
void |
setInvalidUserList(Collection<String> invalidUserList)
A list of users 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) 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)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects
into.
|
void |
setReadOnly(Boolean readOnly)
Sets the write status of a file share.
|
void |
setRequesterPays(Boolean requesterPays)
Sets who pays the cost of the request and the data download from the Amazon 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 |
setValidUserList(Collection<String> validUserList)
A list of users in the Active Directory that are allowed to access the file share.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
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 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)
Enables guessing of the MIME type for uploaded objects based on file extensions.
|
CreateSMBFileShareRequest |
withInvalidUserList(Collection<String> invalidUserList)
A list of users in the Active Directory that are not allowed to access the file share.
|
CreateSMBFileShareRequest |
withInvalidUserList(String... invalidUserList)
A list of users 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) 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)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects
into.
|
CreateSMBFileShareRequest |
withObjectACL(String objectACL)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects
into.
|
CreateSMBFileShareRequest |
withReadOnly(Boolean readOnly)
Sets the write status of a file share.
|
CreateSMBFileShareRequest |
withRequesterPays(Boolean requesterPays)
Sets who pays the cost of the request and the data download from the Amazon 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 |
withValidUserList(Collection<String> validUserList)
A list of users in the Active Directory that are allowed to access the file share.
|
CreateSMBFileShareRequest |
withValidUserList(String... validUserList)
A list of users in the Active Directory that are allowed to access the file share.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setClientToken(String clientToken)
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share
creation.public String getClientToken()
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
public CreateSMBFileShareRequest withClientToken(String clientToken)
A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.
clientToken - A unique string value that you supply that is used by file gateway to ensure idempotent file share
creation.public void setGatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.public String getGatewayARN()
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
public CreateSMBFileShareRequest withGatewayARN(String gatewayARN)
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.
gatewayARN - The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.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.
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.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.
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.
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.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.
public void setKMSKey(String kMSKey)
The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
kMSKey - The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be
set when KMSEncrypted is true. Optional.public String getKMSKey()
The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
public CreateSMBFileShareRequest withKMSKey(String kMSKey)
The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.
kMSKey - The Amazon Resource Name (ARN) KMS key used for Amazon S3 server side encryption. This value can only be
set when KMSEncrypted is true. Optional.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.
role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses
the underlying storage.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.
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.
role - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses
the underlying storage.public void setLocationARN(String locationARN)
The ARN of the backed storage used for storing file data.
locationARN - The ARN of the backed storage used for storing file data.public String getLocationARN()
The ARN of the backed storage used for storing file data.
public CreateSMBFileShareRequest withLocationARN(String locationARN)
The ARN of the backed storage used for storing file data.
locationARN - The ARN of the backed storage used for storing file data.public void setDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by 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.
defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by 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.public String getDefaultStorageClass()
The default storage class for objects put into an Amazon S3 bucket by 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.
public CreateSMBFileShareRequest withDefaultStorageClass(String defaultStorageClass)
The default storage class for objects put into an Amazon S3 bucket by 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.
defaultStorageClass - The default storage class for objects put into an Amazon S3 bucket by 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.public void setObjectACL(String objectACL)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is "private".
objectACL - Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts
objects into. The default value is "private".ObjectACLpublic String getObjectACL()
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is "private".
ObjectACLpublic CreateSMBFileShareRequest withObjectACL(String objectACL)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is "private".
objectACL - Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts
objects into. The default value is "private".ObjectACLpublic CreateSMBFileShareRequest withObjectACL(ObjectACL objectACL)
Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts objects into. The default value is "private".
objectACL - Sets the access control list permission for objects in the Amazon S3 bucket that a file gateway puts
objects into. The default value is "private".ObjectACLpublic void setReadOnly(Boolean readOnly)
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
readOnly - Sets the write status of a file share. This value is true if the write status is read-only, and otherwise
false.public Boolean getReadOnly()
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
public CreateSMBFileShareRequest withReadOnly(Boolean readOnly)
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
readOnly - Sets the write status of a file share. This value is true if the write status is read-only, and otherwise
false.public Boolean isReadOnly()
Sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.
public void setGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
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.
guessMIMETypeEnabled - 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.public Boolean getGuessMIMETypeEnabled()
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.
public CreateSMBFileShareRequest withGuessMIMETypeEnabled(Boolean guessMIMETypeEnabled)
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.
guessMIMETypeEnabled - 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.public Boolean isGuessMIMETypeEnabled()
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.
public void setRequesterPays(Boolean requesterPays)
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
requesterPays - Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to
true if you want the requester to pay instead of the bucket owner, and otherwise to false.public Boolean getRequesterPays()
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
public CreateSMBFileShareRequest withRequesterPays(Boolean requesterPays)
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
requesterPays - Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to
true if you want the requester to pay instead of the bucket owner, and otherwise to false.public Boolean isRequesterPays()
Sets who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner, and otherwise to false.
public List<String> getValidUserList()
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
public void setValidUserList(Collection<String> validUserList)
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
validUserList - A list of users in the Active Directory that are allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public CreateSMBFileShareRequest withValidUserList(String... validUserList)
A list of users in the Active Directory that are allowed to access the file share. 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.
validUserList - A list of users in the Active Directory that are allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public CreateSMBFileShareRequest withValidUserList(Collection<String> validUserList)
A list of users in the Active Directory that are allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
validUserList - A list of users in the Active Directory that are allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public List<String> getInvalidUserList()
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
public void setInvalidUserList(Collection<String> invalidUserList)
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
invalidUserList - A list of users in the Active Directory that are not allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public CreateSMBFileShareRequest withInvalidUserList(String... invalidUserList)
A list of users in the Active Directory that are not allowed to access the file share. 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.
invalidUserList - A list of users in the Active Directory that are not allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public CreateSMBFileShareRequest withInvalidUserList(Collection<String> invalidUserList)
A list of users in the Active Directory that are not allowed to access the file share. Can only be set if Authentication is set to "ActiveDirectory".
invalidUserList - A list of users in the Active Directory that are not allowed to access the file share. Can only be set if
Authentication is set to "ActiveDirectory".public void setAuthentication(String authentication)
The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
authentication - The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
public String getAuthentication()
The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
public CreateSMBFileShareRequest withAuthentication(String authentication)
The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
authentication - The authentication method that users use to access the file share.
Valid values: "ActiveDirectory" or "GuestAccess". The default is "ActiveDirectory".
public String toString()
toString in class ObjectObject.toString()public CreateSMBFileShareRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.