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

Interface DescribeSmbSettingsResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeSmbSettingsResponse.Builder,DescribeSmbSettingsResponse>, SdkBuilder<DescribeSmbSettingsResponse.Builder,DescribeSmbSettingsResponse>, SdkPojo, SdkResponse.Builder, StorageGatewayResponse.Builder
Enclosing class:
DescribeSmbSettingsResponse
public static interface DescribeSmbSettingsResponse.Builder extends StorageGatewayResponse.Builder, SdkPojo, CopyableBuilder<DescribeSmbSettingsResponse.Builder,DescribeSmbSettingsResponse>

  • Method Details

    • gatewayARN

      DescribeSmbSettingsResponse.Builder gatewayARN(String gatewayARN)
      Sets the value of the GatewayARN property for this object.
      Parameters:
      gatewayARN - The new value for the GatewayARN property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainName

      DescribeSmbSettingsResponse.Builder domainName(String domainName)

      The name of the domain that the gateway is joined to.

      Parameters:
      domainName - The name of the domain that the gateway is joined to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeDirectoryStatus

      DescribeSmbSettingsResponse.Builder activeDirectoryStatus(String activeDirectoryStatus)

      Indicates the status of a gateway that is a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

      Parameters:
      activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

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

    • activeDirectoryStatus

      DescribeSmbSettingsResponse.Builder activeDirectoryStatus(ActiveDirectoryStatus activeDirectoryStatus)

      Indicates the status of a gateway that is a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

      Parameters:
      activeDirectoryStatus - Indicates the status of a gateway that is a member of the Active Directory domain.

      • ACCESS_DENIED: Indicates that the JoinDomain operation failed due to an authentication error.

      • DETACHED: Indicates that gateway is not joined to a domain.

      • JOINED: Indicates that the gateway has successfully joined a domain.

      • JOINING: Indicates that a JoinDomain operation is in progress.

      • NETWORK_ERROR: Indicates that JoinDomain operation failed due to a network or connectivity error.

      • TIMEOUT: Indicates that the JoinDomain operation failed because the operation didn't complete within the allotted time.

      • UNKNOWN_ERROR: Indicates that the JoinDomain operation failed due to another type of error.

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

    • smbGuestPasswordSet

      DescribeSmbSettingsResponse.Builder smbGuestPasswordSet(Boolean smbGuestPasswordSet)

      This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

      Valid Values: true | false

      Parameters:
      smbGuestPasswordSet - This value is true if a password for the guest user smbguest is set, otherwise false. Only supported for S3 File Gateways.

      Valid Values: true | false

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

    • smbSecurityStrategy

      DescribeSmbSettingsResponse.Builder smbSecurityStrategy(String smbSecurityStrategy)

      The type of security strategy that was specified for file gateway.

      • ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

      • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

      • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

      Parameters:
      smbSecurityStrategy - The type of security strategy that was specified for file gateway.

      • ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

      • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

      • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

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

    • smbSecurityStrategy

      DescribeSmbSettingsResponse.Builder smbSecurityStrategy(SMBSecurityStrategy smbSecurityStrategy)

      The type of security strategy that was specified for file gateway.

      • ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

      • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

      • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

      Parameters:
      smbSecurityStrategy - The type of security strategy that was specified for file gateway.

      • ClientSpecified: If you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.

      • MandatorySigning: If you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

      • MandatoryEncryption: If you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

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

    • fileSharesVisible

      DescribeSmbSettingsResponse.Builder fileSharesVisible(Boolean fileSharesVisible)

      The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.

      Parameters:
      fileSharesVisible - The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • smbLocalGroups

      DescribeSmbSettingsResponse.Builder smbLocalGroups(SMBLocalGroups smbLocalGroups)

      A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

      Parameters:
      smbLocalGroups - A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • smbLocalGroups

      default DescribeSmbSettingsResponse.Builder smbLocalGroups(Consumer<SMBLocalGroups.Builder> smbLocalGroups)

      A list of Active Directory users and groups that have special permissions for SMB file shares on the gateway.

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

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

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