Package software.amazon.awssdk.services.storagegateway.model

Class CreateSmbFileShareRequest

    • Method Detail

      • clientToken

        public final String clientToken()

        A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.

        Returns:
        A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.

      • gatewayARN

        public final String gatewayARN()

        The ARN of the S3 File Gateway on which you want to create a file share.

        Returns:
        The ARN of the S3 File Gateway on which you want to create a file share.

      • kmsEncrypted

        public final Boolean kmsEncrypted()

        Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

        Valid Values: true | false

        Returns:
        Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

        Valid Values: true | false

      • kmsKey

        public final String kmsKey()

        The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

        Returns:
        The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

      • role

        public final String role()

        The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

        Returns:
        The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.

      • locationARN

        public final String locationARN()

        A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

        You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

        Bucket ARN:

        arn:aws:s3:::my-bucket/prefix/

        Access point ARN:

        arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

        If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

        Access point alias:

        test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

        Returns:
        A custom ARN for the backend storage used for storing data for file shares. It includes a resource ARN with an optional prefix concatenation. The prefix must end with a forward slash (/).

        You can specify LocationARN as a bucket ARN, access point ARN or access point alias, as shown in the following examples.

        Bucket ARN:

        arn:aws:s3:::my-bucket/prefix/

        Access point ARN:

        arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/

        If you specify an access point, the bucket policy must be configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.

        Access point alias:

        test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias

      • defaultStorageClass

        public final String defaultStorageClass()

        The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

        Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

        Returns:
        The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway. The default value is S3_STANDARD. Optional.

        Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING | S3_STANDARD_IA | S3_ONEZONE_IA

      • objectACL

        public final ObjectACL objectACL()

        A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

        If the service returns an enum value that is not available in the current SDK version, objectACL will return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

        Returns:
        A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
        See Also:
        ObjectACL

      • objectACLAsString

        public final String objectACLAsString()

        A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.

        If the service returns an enum value that is not available in the current SDK version, objectACL will return ObjectACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectACLAsString().

        Returns:
        A value that sets the access control list (ACL) permission for objects in the S3 bucket that a S3 File Gateway puts objects into. The default value is private.
        See Also:
        ObjectACL

      • readOnly

        public final Boolean readOnly()

        A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

        Valid Values: true | false

        Returns:
        A value that sets the write status of a file share. Set this value to true to set the write status to read-only, otherwise set to false.

        Valid Values: true | false

      • guessMIMETypeEnabled

        public final 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, otherwise set to false. The default value is true.

        Valid Values: true | false

        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, otherwise set to false. The default value is true.

        Valid Values: true | false

      • requesterPays

        public final 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.

        Valid Values: true | false

        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.

        Valid Values: true | false

      • accessBasedEnumeration

        public final Boolean accessBasedEnumeration()

        The files and folders on this share will only be visible to users with read access.

        Returns:
        The files and folders on this share will only be visible to users with read access.

      • hasAdminUserList

        public final boolean hasAdminUserList()
        For responses, this returns true if the service returned a value for the AdminUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • adminUserList

        public final List<String> adminUserList()

        A list of users or groups 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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

        Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

        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 hasAdminUserList() method.

        Returns:
        A list of users or groups 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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1.

        Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

      • hasValidUserList

        public final boolean hasValidUserList()
        For responses, this returns true if the service returned a value for the ValidUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • hasInvalidUserList

        public final boolean hasInvalidUserList()
        For responses, this returns true if the service returned a value for the InvalidUserList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • invalidUserList

        public final List<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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

        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 hasInvalidUserList() method.

        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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\group1. Can only be set if Authentication is set to ActiveDirectory.

      • auditDestinationARN

        public final String auditDestinationARN()

        The Amazon Resource Name (ARN) of the storage used for audit logs.

        Returns:
        The Amazon Resource Name (ARN) of the storage used for audit logs.

      • authentication

        public final String authentication()

        The authentication method that users use to access the file share. The default is ActiveDirectory.

        Valid Values: ActiveDirectory | GuestAccess

        Returns:
        The authentication method that users use to access the file share. The default is ActiveDirectory.

        Valid Values: ActiveDirectory | GuestAccess

      • caseSensitivity

        public final CaseSensitivity caseSensitivity()

        The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

        If the service returns an enum value that is not available in the current SDK version, caseSensitivity will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseSensitivityAsString().

        Returns:
        The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
        See Also:
        CaseSensitivity

      • caseSensitivityAsString

        public final String caseSensitivityAsString()

        The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

        If the service returns an enum value that is not available in the current SDK version, caseSensitivity will return CaseSensitivity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from caseSensitivityAsString().

        Returns:
        The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.
        See Also:
        CaseSensitivity

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

      • tags

        public final List<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.

        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 hasTags() method.

        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.

      • fileShareName

        public final String fileShareName()

        The name of the file share. Optional.

        FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

        Returns:
        The name of the file share. Optional.

        FileShareName must be set if an S3 prefix name is set in LocationARN, or if an access point or access point alias is used.

      • cacheAttributes

        public final CacheAttributes cacheAttributes()

        Specifies refresh cache information for the file share.

        Returns:
        Specifies refresh cache information for the file share.

      • notificationPolicy

        public final String notificationPolicy()

        The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

        SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

        The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

        {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

        The following example sets NotificationPolicy off.

        {}

        Returns:
        The notification policy of the file share. SettlingTimeInSeconds controls the number of seconds to wait after the last point in time a client wrote to a file before generating an ObjectUploaded notification. Because clients can make many small writes to files, it's best to set this parameter for as long as possible to avoid generating multiple notifications for the same file in a small time period.

        SettlingTimeInSeconds has no effect on the timing of the object uploading to Amazon S3, only the timing of the notification.

        The following example sets NotificationPolicy on with SettlingTimeInSeconds set to 60.

        {\"Upload\": {\"SettlingTimeInSeconds\": 60}}

        The following example sets NotificationPolicy off.

        {}

      • vpcEndpointDNSName

        public final String vpcEndpointDNSName()

        Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

        This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

        Returns:
        Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.

        This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

      • bucketRegion

        public final String bucketRegion()

        Specifies the Region of the S3 bucket where the SMB file share stores files.

        This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

        Returns:
        Specifies the Region of the S3 bucket where the SMB file share stores files.

        This parameter is required for SMB file shares that connect to Amazon S3 through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.

      • oplocksEnabled

        public final Boolean oplocksEnabled()

        Specifies whether opportunistic locking is enabled for the SMB file share.

        Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

        Valid Values: true | false

        Returns:
        Specifies whether opportunistic locking is enabled for the SMB file share.

        Enabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve access to files with the same name in different case.

        Valid Values: true | false

      • toString

        public final 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