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

Interface CreateSmbFileShareRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>, SdkBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>, SdkPojo, SdkRequest.Builder, StorageGatewayRequest.Builder
Enclosing class:
CreateSmbFileShareRequest
public static interface CreateSmbFileShareRequest.Builder extends StorageGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateSmbFileShareRequest.Builder,CreateSmbFileShareRequest>

  • Method Details

    • clientToken

      CreateSmbFileShareRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A unique string value that you supply that is used by S3 File Gateway to ensure idempotent file share creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayARN

      CreateSmbFileShareRequest.Builder gatewayARN(String gatewayARN)

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

      Parameters:
      gatewayARN - The ARN of the S3 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.

    • kmsEncrypted

      CreateSmbFileShareRequest.Builder kmsEncrypted(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKey

      CreateSmbFileShareRequest.Builder kmsKey(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • role

      CreateSmbFileShareRequest.Builder role(String role)

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

      Parameters:
      role - The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it accesses the underlying storage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locationARN

      CreateSmbFileShareRequest.Builder locationARN(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • defaultStorageClass

      CreateSmbFileShareRequest.Builder defaultStorageClass(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • objectACL

      CreateSmbFileShareRequest.Builder objectACL(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • objectACL

      CreateSmbFileShareRequest.Builder objectACL(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • readOnly

      CreateSmbFileShareRequest.Builder readOnly(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • guessMIMETypeEnabled

      CreateSmbFileShareRequest.Builder guessMIMETypeEnabled(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

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

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requesterPays

      CreateSmbFileShareRequest.Builder requesterPays(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

      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.

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • smbaclEnabled

      CreateSmbFileShareRequest.Builder smbaclEnabled(Boolean smbaclEnabled)

      Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

      For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

      Valid Values: true | false

      Parameters:
      smbaclEnabled - Set this value to true to enable access control list (ACL) on the SMB file share. Set it to false to map file and directory permissions to the POSIX permissions.

      For more information, see Using Microsoft Windows ACLs to control access to an SMB file share in the Storage Gateway User Guide.

      Valid Values: true | false

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessBasedEnumeration

      CreateSmbFileShareRequest.Builder accessBasedEnumeration(Boolean accessBasedEnumeration)

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

      Parameters:
      accessBasedEnumeration - The files and folders on this share will only be visible to users with read access.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminUserList

      CreateSmbFileShareRequest.Builder adminUserList(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adminUserList

      CreateSmbFileShareRequest.Builder adminUserList(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validUserList

      CreateSmbFileShareRequest.Builder validUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.

    • validUserList

      CreateSmbFileShareRequest.Builder validUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.

    • invalidUserList

      CreateSmbFileShareRequest.Builder invalidUserList(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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.

    • invalidUserList

      CreateSmbFileShareRequest.Builder invalidUserList(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.

      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. Acceptable formats include: DOMAIN\User1, user1, @group1, and @DOMAIN\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.

    • auditDestinationARN

      CreateSmbFileShareRequest.Builder auditDestinationARN(String auditDestinationARN)

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

      Parameters:
      auditDestinationARN - The Amazon Resource Name (ARN) of the storage used for audit logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authentication

      CreateSmbFileShareRequest.Builder authentication(String authentication)

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

      Valid Values: ActiveDirectory | GuestAccess

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

      Valid Values: ActiveDirectory | GuestAccess

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • caseSensitivity

      CreateSmbFileShareRequest.Builder caseSensitivity(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • caseSensitivity

      CreateSmbFileShareRequest.Builder caseSensitivity(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateSmbFileShareRequest.Builder tags(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.

    • tags

      CreateSmbFileShareRequest.Builder tags(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.

    • tags

      CreateSmbFileShareRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fileShareName

      CreateSmbFileShareRequest.Builder fileShareName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • cacheAttributes

      CreateSmbFileShareRequest.Builder cacheAttributes(CacheAttributes cacheAttributes)

      Specifies refresh cache information for the file share.

      Parameters:
      cacheAttributes - Specifies refresh cache information for the file share.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheAttributes

      default CreateSmbFileShareRequest.Builder cacheAttributes(Consumer<CacheAttributes.Builder> cacheAttributes)

      Specifies refresh cache information for the file share.

      This is a convenience method that creates an instance of the CacheAttributes.Builder avoiding the need to create one manually via CacheAttributes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cacheAttributes(CacheAttributes).

      Parameters:
      cacheAttributes - a consumer that will call methods on CacheAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notificationPolicy

      CreateSmbFileShareRequest.Builder notificationPolicy(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.

      {}

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcEndpointDNSName

      CreateSmbFileShareRequest.Builder vpcEndpointDNSName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • bucketRegion

      CreateSmbFileShareRequest.Builder bucketRegion(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • oplocksEnabled

      CreateSmbFileShareRequest.Builder oplocksEnabled(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateSmbFileShareRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateSmbFileShareRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.