AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::StorageGateway::Types::DescribeSMBSettingsOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active_directory_statusString

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:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

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

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#file_shares_visibleBoolean

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

Returns:

  • (Boolean)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arnString

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Returns:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#smb_guest_password_setBoolean

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:

  • (Boolean)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#smb_local_groupsTypes::SMBLocalGroups

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



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#smb_security_strategyString

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:

  • (String)


3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3636

class DescribeSMBSettingsOutput < Struct.new(
  :gateway_arn,
  :domain_name,
  :active_directory_status,
  :smb_guest_password_set,
  :smb_security_strategy,
  :file_shares_visible,
  :smb_local_groups)
  SENSITIVE = []
  include Aws::Structure
end